godot-docs/classes/class_videoplayer.rst

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the VideoPlayer.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_VideoPlayer:

VideoPlayer
===========

**Inherits:** :ref:`Control<class_control>` **<** :ref:`CanvasItem<class_canvasitem>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`

**Category:** Core

Brief Description
-----------------

Control to play video files.

Member Functions
----------------

+--------------------------------+-----------------------------------------------------------------------------+
| :ref:`String<class_string>`    | :ref:`get_stream_name<class_VideoPlayer_get_stream_name>` **(** **)** const |
+--------------------------------+-----------------------------------------------------------------------------+
| :ref:`Texture<class_texture>`  | :ref:`get_video_texture<class_VideoPlayer_get_video_texture>` **(** **)**   |
+--------------------------------+-----------------------------------------------------------------------------+
| :ref:`bool<class_bool>`        | :ref:`is_playing<class_VideoPlayer_is_playing>` **(** **)** const           |
+--------------------------------+-----------------------------------------------------------------------------+
| void                           | :ref:`play<class_VideoPlayer_play>` **(** **)**                             |
+--------------------------------+-----------------------------------------------------------------------------+
| void                           | :ref:`stop<class_VideoPlayer_stop>` **(** **)**                             |
+--------------------------------+-----------------------------------------------------------------------------+

Member Variables
----------------

  .. _class_VideoPlayer_audio_track:

- :ref:`int<class_int>` **audio_track**

  .. _class_VideoPlayer_autoplay:

- :ref:`bool<class_bool>` **autoplay**

  .. _class_VideoPlayer_buffering_msec:

- :ref:`int<class_int>` **buffering_msec** - The amount of milliseconds to store in buffer while playing.

  .. _class_VideoPlayer_bus:

- :ref:`String<class_string>` **bus**

  .. _class_VideoPlayer_expand:

- :ref:`bool<class_bool>` **expand**

  .. _class_VideoPlayer_paused:

- :ref:`bool<class_bool>` **paused**

  .. _class_VideoPlayer_stream:

- :ref:`VideoStream<class_videostream>` **stream**

  .. _class_VideoPlayer_stream_position:

- :ref:`float<class_float>` **stream_position** - The current position of the stream, in seconds.

  .. _class_VideoPlayer_volume:

- :ref:`float<class_float>` **volume** - The volume of the audio track as a linear value.

  .. _class_VideoPlayer_volume_db:

- :ref:`float<class_float>` **volume_db**


Description
-----------

This control has the ability to play video streams. The only format accepted is the OGV Theora, so any other format must be converted before using in a project.

Member Function Description
---------------------------

.. _class_VideoPlayer_get_stream_name:

- :ref:`String<class_string>` **get_stream_name** **(** **)** const

Get the name of the video stream.

.. _class_VideoPlayer_get_video_texture:

- :ref:`Texture<class_texture>` **get_video_texture** **(** **)**

Get the current frame of the video as a :ref:`Texture<class_texture>`.

.. _class_VideoPlayer_is_playing:

- :ref:`bool<class_bool>` **is_playing** **(** **)** const

Get whether or not the video is playing.

.. _class_VideoPlayer_play:

- void **play** **(** **)**

Start the video playback.

.. _class_VideoPlayer_stop:

- void **stop** **(** **)**

Stop the video playback.