VideoPlayer

Control for playing video streams.

Control node for playing video streams using resources.

Supported video formats are WebM (, ), Ogg Theora (.ogv, ), and any format exposed via a GDNative plugin using VideoStreamGDNative.

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

Properties

	get_stream_name ( ) const
	get_video_texture ( ) const
	is_playing ( ) const
void	( )
void	stop ( )

Signals

Emitted when playback is finished.

audio_track

Default	`0`
Setter	set_audio_track(value)
Getter	get_audio_track()

The embedded audio track to play.

bool autoplay

Default	`false`
Setter	set_autoplay(value)
Getter	has_autoplay()

buffering_msec

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

String bus

Default	`“Master”`
Setter	set_bus(value)
Getter	get_bus()

Audio bus to use for sound playback.

expand

Default
Setter	set_expand(value)
Getter	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 paused

Default	`false`
Setter	set_paused(value)
Getter	is_paused()

If true, the video is paused.

The assigned video stream. See description for supported formats.

stream_position

Setter	set_stream_position(value)
Getter	get_stream_position()

The current position of the stream, in seconds.

float volume

Setter	set_volume(value)
Getter	get_volume()

volume_db

Default	`0.0`
Setter	set_volume_db(value)
Getter	get_volume_db()

Audio volume in dB.

Method Descriptions

String get_stream_name ( ) const

Returns the video stream’s name, or "<No Stream>" if no video stream is assigned.

get_video_texture ( ) const

Returns the current frame as a Texture.

is_playing ( ) const

Returns true if the video is playing.

Note: The video is still considered playing if paused during playback.

Starts the video playback from the beginning. If the video is paused, this will not unpause the video.

void stop ( )

Note: Although the stream position will be set to 0, the first frame of the video stream won’t become the current frame.