.. highlightlang:: us

.. index:: VideoActivate

.. _videoactivate:

VideoActivate
=============

.. us.tag VideoActivate NOTREADYENGLISH Video-set New5503

:ref:`VideoActivate` activates or deactivates a video object. 

.. function:: bool = VideoActivate(hVideo, bActivate)

.. us.return

**Return Value**

Is TRUE (1), if the function was successful and otherwise FALSE (0).

.. us.params

**Parameters**

.. uparam:: hVideo

   Identifies the Video.

.. uparam:: bActivate

   If *bActivate* is TRUE (1), the video is activated. If *bActivate* is 
   FALSE (0), the video is deactivated. See Comment.

.. us.comment

**Comment**

Active: The play bar is enabled, the video will be loaded and the start position
will be displayed. See also :ref:`VideoShowPlaybar`, :ref:`VideoSetStartPos`.

Deactivate: The video will be closed and the snap shot picture will be displayed.
See :ref:`VideoSnapshot`.

.. us.history

**History**

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

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

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

:sub:`id-1796621`