Class reference
VideoStreamPlayer
Inherits Control
A control used for video playback.
Description
A control used for playback of VideoStream resources. Supported video formats are Ogg Theora (.ogv, VideoStreamTheora) and any format exposed via a GDExtension plugin. Warning: On Web, video playback will perform poorly due to missing architecture-specific assembly optimizations.
Properties
int audio_track = 0
int audio_track = 0The embedded audio track to play.
bool autoplay = false
bool autoplay = falseIf true, playback starts when the scene loads.
int buffering_msec = 500
int buffering_msec = 500Amount of time in milliseconds to store in buffer while playing.
StringName bus = &"Master"
StringName bus = &"Master"Audio bus to use for sound playback.
bool expand = false
bool expand = falseIf true, the video scales to the control size. Otherwise, the control minimum size will be automatically adjusted to match the video stream's dimensions.
bool loop = false
bool loop = falseIf true, the video restarts when it reaches its end.
bool paused = false
bool paused = falseIf true, the video is paused.
float speed_scale = 1.0
float speed_scale = 1.0The stream's current speed scale. 1.0 is the normal speed, while 2.0 is double speed and 0.5 is half speed. A speed scale of 0.0 pauses the video, similar to setting paused to true.
VideoStream stream
VideoStream streamThe assigned video stream. See description for supported formats.
float stream_position
float stream_positionThe current position of the stream, in seconds.
float volume
float volumeAudio volume as a linear value.
float volume_db = 0.0
float volume_db = 0.0Audio volume in dB.
Methods
float get_stream_length() const
float get_stream_length() constThe length of the current stream, in seconds.
String get_stream_name() const
String get_stream_name() constReturns the video stream's name, or "<No Stream>" if no video stream is assigned.
Texture2D get_video_texture() const
Texture2D get_video_texture() constReturns the current frame as a Texture2D.
bool is_playing() const
bool is_playing() constReturns true if the video is playing. Note: The video is still considered playing if paused during playback.
void play()
Starts the video playback from the beginning. If the video is paused, this will not unpause the video.
void stop()
Stops the video playback and sets the stream position to 0. Note: Although the stream position will be set to 0, the first frame of the video stream won't become the current frame.
Signals
finished()
Emitted when playback is finished.