Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

VideoStreamPlayback¶

Inherits: Resource < RefCounted < Object

Internal class used by VideoStream to manage playback state when played from a VideoStreamPlayer.

Description¶

This class is intended to be overridden by video decoder extensions with custom implementations of VideoStream.

Methods¶

int	_get_channels ( ) virtual const
float	_get_length ( ) virtual const
int	_get_mix_rate ( ) virtual const
float	_get_playback_position ( ) virtual const
Texture2D	_get_texture ( ) virtual const
bool	_is_paused ( ) virtual const
bool	_is_playing ( ) virtual const
void	_play ( ) virtual
void	_seek ( float time ) virtual
void	_set_audio_track ( int idx ) virtual
void	_set_paused ( bool paused ) virtual
void	_stop ( ) virtual
void	_update ( float delta ) virtual
int	mix_audio ( int num_frames, PackedFloat32Array buffer=PackedFloat32Array(), int offset=0 )

Method Descriptions¶

int _get_channels ( ) virtual const

Returns the number of audio channels.

float _get_length ( ) virtual const

Returns the video duration in seconds, if known, or 0 if unknown.

int _get_mix_rate ( ) virtual const

Returns the audio sample rate used for mixing.

float _get_playback_position ( ) virtual const

Return the current playback timestamp. Called in response to the VideoStreamPlayer.stream_position getter.

Texture2D _get_texture ( )