W3cubDocs

/Godot 3.1

VideoPlayer

Inherits: Control < CanvasItem < Node < Object

Category: Core

Brief Description

Control for playing video streams.

Properties

int audio_track
bool autoplay
int buffering_msec
String bus
bool expand
bool paused
VideoStream stream
float stream_position
float volume
float volume_db

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 OGV Theora.

Property Descriptions

int audio_track

Setter set_audio_track(value)
Getter get_audio_track()

The embedded audio track to play.

bool autoplay

Setter set_autoplay(value)
Getter has_autoplay()

If true, playback starts when the scene loads. Default value: false.

int buffering_msec

Setter set_buffering_msec(value)
Getter get_buffering_msec()

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

String bus

Setter set_bus(value)
Getter get_bus()

Audio bus to use for sound playback.

bool expand

Setter set_expand(value)
Getter has_expand()

If true, the video scales to the control size. Default value: true.

bool paused

Setter set_paused(value)
Getter is_paused()

If true, the video is paused.

VideoStream stream

Setter set_stream(value)
Getter get_stream()

float 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()

Audio volume as a linear value.

float volume_db

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.

Texture get_video_texture ( )

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.

© 2014–2019 Juan Linietsky, Ariel Manzur, Godot Engine contributors
Licensed under the MIT License.
http://docs.godotengine.org/en/3.1/classes/class_videoplayer.html