.. highlightlang:: us

.. index:: VideoCommand

.. _videocommand:

VideoCommand
============

.. us.tag  VideoCommand NOTREADYGERMAN New5503 video-commands

:ref:`VideoCommand` steuert das Abspielen von Videodateien.

.. function::  ret = VideoCommand(hVideo, ssCommand)
               ret = VideoCommand(hVideo, ssCommand, arg)

.. us.return

**Returnwert**

Der Returnwert ist abhängig von *ssCommand*. Die meisten Funktionen liefern 0
wenn kein Fehler aufgetreten ist und eine Zahl größer 0, wenn ein Fehler
aufgetreten ist. Mit

::

   ssErrorMessage = VideoCommand(hVideo, "geterror");

kann dann eine Fehlerbeschreibung erfragt werden.

.. us.params

**Parameter**

.. uparam:: hVideo

   *hVideo* ist die Zugriffsnummer (Handle) des mit :ref:`VideoCreate` geöffneten
   Videos.

.. uparam:: ssCommand

   *ssCommand* ist eines der folgenden Kommandos:

   .. list-table::
      :header-rows: 1

      * - Kommando
        - Beschreibung
      * - ``"play"``
        - Spielt das Video ab.
      * - ``"stop"``
        - Stoppt das Video.
      * - ``"pause"``
        - Stoppt das Video.
      * - ``"resume"``
        - Weiter abspielen.
      * - ``"getmode"``
        - Liefert den Mode, z. B. ``"stopped"``, ``"paused"``, ``"playing"``.
      * - ``"getlen"``
        - Liefert die Länge des Videos in Millisekunden oder Frames.
      * - ``"getpos"``
        - Liefert die aktuelle Position in Millisekunden oder Frames.
      * - ``"seek"``
        - Springt an eine angegebene Position im Video. Die Position muss in
          *arg* angegeben werden, als Zeit in Millisekunden oder Frames.
      * - ``"setspeed"``
        - Setzt die Abspielgeschwindigkeit. *arg* gleich 1000 ist die normale
          Geschwindigkeit. Das Setzen der Geschwindigkeit ist nicht bei allen
          Videoformaten möglich, das Video muss möglicherweise zunächst
          konvertiert werden, siehe Kommentar.
      * - ``"getspeed"``
        - Erfragt die Geschwindigkeit. 1000 ist die normale Geschwindigkeit.
      * - ``"geterror"``
        - Falls ein Fehler aufgetreten ist, liefert diese Funktion eine
          Fehlerbeschreibung.
      * - ``"width"``
        - Liefert die Breite in Pixeln des skalierten Videos.
      * - ``"height"``
        - Liefert die Höhe in Pixeln des skalierten Videos.
      * - ``"widthsource"``
        - Liefert die Bildbreite in Pixeln des unskalierten Videos.
      * - ``"heightsource"``
        - Liefert die Bildhöhe in Pixeln des unskalierten Videos.
      * - ``"getvolume"``
        - Erfragt die Lautstärke.
      * - ``"setvolume"``
        - Setzt die Lautstärke. *arg* muss eine ganze Zahl im Bereich 0 bis
          1000 enthalten.
      * - ``"useframes"``
        - Für die Funktionen ``"seek"``, ``"getpos"``, ``"getlen"`` Frames
          anstatt Millisekunden verwenden.
      * - ``"usetime"``
        - Für die Funktionen ``"seek"``, ``"getpos"``, ``"getlen"`` Millisekunden
          anstatt  Frames verwenden.
      * - ``"gettimeformat"``
        - Liefert ``"milliseconds"`` oder ``"frames"``.

   Intern verwendet:

   .. list-table::
      :header-rows: 1

      * - Kommando
        - Beschreibung
      * - ``"open"``
        - Öffnet ein Video. *arg* muss den kompletten Dateinamen der Video-Datei
          enthalten. Falls das Format nicht unterstützt wird, wird die Zahl 296
          zurückliefert, kann das Format nicht gelesen werden.
      * - ``"getfilename"``
        - Liefert den kompletten Dateinamen der Video-Datei.
      * - ``"poscallback"``
        - Bei Positionsänderungen wird die Funktion ``VideoPosCallback(hVideo, pos)``
          aufgerufen. Siehe :ref:`VideoSetCallback`.
      * - ``"noposcallback"``
        - Schaltet das Aufrufen der Callback-Funktion aus. Siehe :ref:`VideoSetCallback`.
      * - ``"isposcallback"``
        - Ermittelt ob die Callback-Funktion ``VideoPosCallback(hVideo, pos)``
          aufgerufen wird.
      * - ``"modecallback"``
        - Bei Modeänderungen wird die Funktion ``VideoModeCallback(hVideo, mode)``
          aufgerufen. Siehe :ref:`VideoSetCallback`.
      * - ``"nomodecallback"``
        - Schaltet das Aufrufen der Callback-Funktion aus. Siehe :ref:`VideoSetCallback`.
      * - ``"ismodecallback"``
        - Ermittelt ob die Callback-Funktion ``VideoModeCallback(hVideo, mode)``
          aufgerufen wird.
      * - ``"showplaybar"``
        - Zeigt unterhalb des Videos ein Control an, mit dem das Video gestarted,
          gestoppt sowie die Position verändert werden kann.
      * - ``"hideplaybar"``
        - Versteckt den playbar. Siehe ``"showplaybar"``. Default.
      * - ``"isplaybar"``
        - Erfragt, ob der playbar angezeigt wird.

.. us.comment

**Kommentar**

Das Video muss aktiv sein, siehe :ref:`VideoActivate`.

.. us.example

**Beispiel**

::

   hDoc = DocCreate();
   hPage = PageCreate();
   DocAddPage(hDoc, hPage);
   hLayer = PageGetAllLayers(hPage);
   hVideo = VideoCreate();
   LayerAddObjects(hLayer, hVideo);
   VideoSetFileName(hVideo, GetRootDirectory() + "samples/Impact_movie.mpg");
   VideoActivate(hVideo, TRUE);
   VideoCommand(hVideo, "play") 

.. us.history

**History**

.. list-table::
   :header-rows: 1

   * - Version
     - Beschreibung
   * - R2013.3
     - Neu.

.. seealso::
   :ref:`overview-videos`,
   :ref:`VideoCreate`,
   :ref:`VideoActivate`,
   :ref:`VideoDestroy`

:sub:`id-892879`