.. highlightlang:: us

.. index:: VideoSnapshot

.. _videosnapshot:

VideoSnapshot
=============

.. us.tag VideoSnapshot NOTREADYENGLISH video-commands New5503

:ref:`VideoSnapshot` creates a bitmap snapshot for the specified 
position of the given video file. The snapshot is displayed instead
of the video. 

.. function:: ret = VideoSnapshot(hVideo)
              ret = VideoSnapshot(hVideo, ssBitmapFile)
              ret = VideoSnapshot(hVideo, ssBitmapFile, pos)
              ret = VideoSnapshot(hVideo, ssBitmapFile, pos, ssVideoFile)

.. us.return

**Return Value**

*ret*

.. us.params

**Parameters**

.. uparam:: hVideo

   *hVideo* is the handle of the video object.

.. uparam:: ssBitmapFile

   *ssBitmapFile* is the complete bitmap file.

.. uparam:: pos

   *pos* is the position in milliseconds or -1 for the current position.

.. uparam:: ssVideoFile

   *ssVideoFile* is the name of the video file.

.. us.comment

**Comment**

If ``FFmpeg.exe`` is installed and the path name is set in the environment 
variable ``path``, the program is used to create the snapshot.
(see http://www.ffmpeg.org und https://de.wikipedia.org/wiki/FFmpeg).

If ``FFmpeg.exe`` is not found, DirectX (DirectShow) is used to create the 
snapshot. Sometimes the DirectX function fails to create the bitmap. Therefore
``FFmpeg.exe`` is preferable.

.. us.history

**History**

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

   * - Version
     - Description
   * - R2013.3
     - New.

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

:sub:`id-515123`