Class VideoStreamPlayer

A control used for video playback.

Inheritance

Control

CanvasItem

Node

Object

VideoStreamPlayer

Remarks

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.

See Also

Playing videos

Properties

audio_track

The embedded audio track to play.

var audio_track : int = 0

Property Value

int

Remarks

• void set_audio_track(int value)
• int get_audio_track

autoplay

If true, playback starts when the scene loads.

var autoplay : bool = false

Property Value

bool

Remarks

• void set_autoplay(bool value)
• bool has_autoplay

buffering_msec

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

var buffering_msec : int = 500

Property Value

int

Remarks

• void set_buffering_msec(int value)
• int get_buffering_msec

bus

Audio bus to use for sound playback.

var bus : StringName = &"Master"

Property Value

StringName

Remarks

• void set_bus(StringName value)
• StringName get_bus

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.

var expand : bool = false

Property Value

bool

Remarks

• void set_expand(bool value)
• bool has_expand

loop

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

var loop : bool = false

Property Value

bool

Remarks

• void set_loop(bool value)
• bool has_loop

paused

If true, the video is paused.

var paused : bool = false

Property Value

bool

Remarks

• void set_paused(bool value)
• bool is_paused

stream

The assigned video stream. See description for supported formats.

var stream : VideoStream

Property Value

VideoStream

Remarks

• void set_stream(VideoStream value)
• VideoStream get_stream

stream_position

The current position of the stream, in seconds.

Note: Changing this value won't have any effect as seeking is not implemented yet, except in video formats implemented by a GDExtension add-on.

var stream_position : float

Property Value

float

Remarks

• void set_stream_position(float value)
• float get_stream_position

volume

Audio volume as a linear value.

var volume : float

Property Value

float

Remarks

• void set_volume(float value)
• float get_volume

volume_db

Audio volume in dB.

var volume_db : float = 0.0

Property Value

float

Remarks

• void set_volume_db(float value)
• float get_volume_db

Methods

get_stream_length

Qualifiers: const

The length of the current stream, in seconds.

Note: For VideoStreamTheora streams (the built-in format supported by Godot), this value will always be zero, as getting the stream length is not implemented yet. The feature may be supported by video formats implemented by a GDExtension add-on.

float get_stream_length

get_stream_name

Qualifiers: const

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

String get_stream_name

get_video_texture

Qualifiers: const

Returns the current frame as a Texture2D.

Texture2D get_video_texture

is_playing

Qualifiers: const

Returns true if the video is playing.

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

bool is_playing

play

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

void play

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.

void stop

Events

finished

Emitted when playback is finished.

signal finished