VideoPlayer

Inherits: Control < CanvasItem < Node < Object

Category: Core

Brief Description

Control for playing video streams.

Methods

String get_stream_name ( ) const
Texture get_video_texture ( )
bool is_playing ( ) const
void play ( )
void stop ( )

Signals

  • finished ( )

Emitted when playback is finished.

Description

Control node for playing video streams. Supported formats are WebM and Ogg Theora.

Property Descriptions

  • int audio_track
Default 0
Setter set_audio_track(value)
Getter get_audio_track()

The embedded audio track to play.

Default false
Setter set_autoplay(value)
Getter has_autoplay()

If true, playback starts when the scene loads.

  • int buffering_msec
Default 500
Setter set_buffering_msec(value)
Getter get_buffering_msec()

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

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

Audio bus to use for sound playback.

Default true
Setter set_expand(value)
Getter has_expand()

If true, the video scales to the control size.

Default false
Setter set_paused(value)
Getter is_paused()

If true, the video is paused.

Setter set_stream(value)
Getter get_stream()

The assigned video stream. See description for supported formats.

Setter set_stream_position(value)
Getter get_stream_position()

The current position of the stream, in seconds.

Setter set_volume(value)
Getter get_volume()

Audio volume as a linear value.

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.

Returns the current frame as a Texture.

  • bool is_playing ( ) const

Returns true if the video is playing.

  • void play ( )

Starts the video playback.

  • void stop ( )

Stops the video playback.