:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VideoStreamPlayback.xml. .. _class_VideoStreamPlayback: VideoStreamPlayback =================== **Inherits:** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` Internal class used by :ref:`VideoStream` to manage playback state when played from a :ref:`VideoStreamPlayer`. .. rst-class:: classref-introduction-group Description ----------- This class is intended to be overridden by video decoder extensions with custom implementations of :ref:`VideoStream`. .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`_get_channels`\ (\ ) |virtual| |const| | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`_get_length`\ (\ ) |virtual| |const| | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`_get_mix_rate`\ (\ ) |virtual| |const| | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`_get_playback_position`\ (\ ) |virtual| |const| | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Texture2D` | :ref:`_get_texture`\ (\ ) |virtual| |const| | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`_is_paused`\ (\ ) |virtual| |const| | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`_is_playing`\ (\ ) |virtual| |const| | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`_play`\ (\ ) |virtual| | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`_seek`\ (\ time\: :ref:`float`\ ) |virtual| | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`_set_audio_track`\ (\ idx\: :ref:`int`\ ) |virtual| | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`_set_paused`\ (\ paused\: :ref:`bool`\ ) |virtual| | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`_stop`\ (\ ) |virtual| | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`_update`\ (\ delta\: :ref:`float`\ ) |virtual| |required| | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`mix_audio`\ (\ num_frames\: :ref:`int`, buffer\: :ref:`PackedFloat32Array` = PackedFloat32Array(), offset\: :ref:`int` = 0\ ) | +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_VideoStreamPlayback_private_method__get_channels: .. rst-class:: classref-method :ref:`int` **_get_channels**\ (\ ) |virtual| |const| :ref:`🔗` Returns the number of audio channels. .. rst-class:: classref-item-separator ---- .. _class_VideoStreamPlayback_private_method__get_length: .. rst-class:: classref-method :ref:`float` **_get_length**\ (\ ) |virtual| |const| :ref:`🔗` Returns the video duration in seconds, if known, or 0 if unknown. .. rst-class:: classref-item-separator ---- .. _class_VideoStreamPlayback_private_method__get_mix_rate: .. rst-class:: classref-method :ref:`int` **_get_mix_rate**\ (\ ) |virtual| |const| :ref:`🔗` Returns the audio sample rate used for mixing. .. rst-class:: classref-item-separator ---- .. _class_VideoStreamPlayback_private_method__get_playback_position: .. rst-class:: classref-method :ref:`float` **_get_playback_position**\ (\ ) |virtual| |const| :ref:`🔗` Return the current playback timestamp. Called in response to the :ref:`VideoStreamPlayer.stream_position` getter. .. rst-class:: classref-item-separator ---- .. _class_VideoStreamPlayback_private_method__get_texture: .. rst-class:: classref-method :ref:`Texture2D` **_get_texture**\ (\ ) |virtual| |const| :ref:`🔗` Allocates a :ref:`Texture2D` in which decoded video frames will be drawn. .. rst-class:: classref-item-separator ---- .. _class_VideoStreamPlayback_private_method__is_paused: .. rst-class:: classref-method :ref:`bool` **_is_paused**\ (\ ) |virtual| |const| :ref:`🔗` Returns the paused status, as set by :ref:`_set_paused()`. .. rst-class:: classref-item-separator ---- .. _class_VideoStreamPlayback_private_method__is_playing: .. rst-class:: classref-method :ref:`bool` **_is_playing**\ (\ ) |virtual| |const| :ref:`🔗` Returns the playback state, as determined by calls to :ref:`_play()` and :ref:`_stop()`. .. rst-class:: classref-item-separator ---- .. _class_VideoStreamPlayback_private_method__play: .. rst-class:: classref-method |void| **_play**\ (\ ) |virtual| :ref:`🔗` Called in response to :ref:`VideoStreamPlayer.autoplay` or :ref:`VideoStreamPlayer.play()`. Note that manual playback may also invoke :ref:`_stop()` multiple times before this method is called. :ref:`_is_playing()` should return ``true`` once playing. .. rst-class:: classref-item-separator ---- .. _class_VideoStreamPlayback_private_method__seek: .. rst-class:: classref-method |void| **_seek**\ (\ time\: :ref:`float`\ ) |virtual| :ref:`🔗` Seeks to ``time`` seconds. Called in response to the :ref:`VideoStreamPlayer.stream_position` setter. .. rst-class:: classref-item-separator ---- .. _class_VideoStreamPlayback_private_method__set_audio_track: .. rst-class:: classref-method |void| **_set_audio_track**\ (\ idx\: :ref:`int`\ ) |virtual| :ref:`🔗` Select the audio track ``idx``. Called when playback starts, and in response to the :ref:`VideoStreamPlayer.audio_track` setter. .. rst-class:: classref-item-separator ---- .. _class_VideoStreamPlayback_private_method__set_paused: .. rst-class:: classref-method |void| **_set_paused**\ (\ paused\: :ref:`bool`\ ) |virtual| :ref:`🔗` Set the paused status of video playback. :ref:`_is_paused()` must return ``paused``. Called in response to the :ref:`VideoStreamPlayer.paused` setter. .. rst-class:: classref-item-separator ---- .. _class_VideoStreamPlayback_private_method__stop: .. rst-class:: classref-method |void| **_stop**\ (\ ) |virtual| :ref:`🔗` Stops playback. May be called multiple times before :ref:`_play()`, or in response to :ref:`VideoStreamPlayer.stop()`. :ref:`_is_playing()` should return ``false`` once stopped. .. rst-class:: classref-item-separator ---- .. _class_VideoStreamPlayback_private_method__update: .. rst-class:: classref-method |void| **_update**\ (\ delta\: :ref:`float`\ ) |virtual| |required| :ref:`🔗` Ticks video playback for ``delta`` seconds. Called every frame as long as both :ref:`_is_paused()` and :ref:`_is_playing()` return ``true``. .. rst-class:: classref-item-separator ---- .. _class_VideoStreamPlayback_method_mix_audio: .. rst-class:: classref-method :ref:`int` **mix_audio**\ (\ num_frames\: :ref:`int`, buffer\: :ref:`PackedFloat32Array` = PackedFloat32Array(), offset\: :ref:`int` = 0\ ) :ref:`🔗` Render ``num_frames`` audio frames (of :ref:`_get_channels()` floats each) from ``buffer``, starting from index ``offset`` in the array. Returns the number of audio frames rendered, or -1 on error. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` .. |void| replace:: :abbr:`void (No return value.)`