VideoStreamPlayer¶

Inherits: Control < CanvasItem < Node < Object

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.

Note: Due to a bug, VideoStreamPlayer does not support localization remapping yet.

Warning: On Web, video playback will perform poorly due to missing architecture-specific assembly optimizations.

Tutorials¶

Playing videos

Properties¶

int	audio_track	`0`
bool	autoplay	`false`
int	buffering_msec	`500`
StringName	bus	`&"Master"`
bool	expand	`false`
bool	loop	`false`
bool	paused	`false`
VideoStream	stream
float	stream_position
float	volume
float	volume_db	`0.0`

Methods¶

float	get_stream_length ( ) const
String	get_stream_name ( ) const
Texture2D	get_video_texture ( ) const
bool	is_playing ( ) const
void	play ( )
void	stop ( )

Signals¶

finished ( )

Emitted when playback is finished.

Property Descriptions¶

int audio_track = 0

void set_audio_track ( int value )
int get_audio_track ( )

The embedded audio track to play.

bool autoplay = false

void set_autoplay ( bool value )
bool has_autoplay ( )

If true, playback starts when the scene loads.

int buffering_msec = 500

void set_buffering_msec ( int value )
int get_buffering_msec ( )

Amount of time in milliseconds to store in buffer while playing.

StringName bus = &"Master"

void set_bus ( StringName value )
StringName get_bus ( )

Audio bus to use for sound playback.

bool expand = false

void set_expand ( bool value )
bool has_expand ( )

If 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

void set_loop ( bool value )
bool has_loop ( )

If true, the video restarts when it reaches its end.

bool paused = false

void set_paused ( bool value )
bool is_paused ( )

If true, the video is paused.

VideoStream stream

void set_stream ( VideoStream value )
VideoStream get_stream ( )

The assigned video stream. See description for supported formats.

float