VideoPlayer

Inherits: Control < CanvasItem < Node < Object

Category: Core

Brief Description

Control to play video files.

Member Functions

int get_buffering_msec ( ) const
String get_stream_name ( ) const
float get_stream_position ( ) const
Texture get_video_texture ( )
float get_volume ( ) const
bool is_playing ( ) const
void play ( )
void set_buffering_msec ( int msec )
void set_stream_position ( float position )
void set_volume ( float volume )
void stop ( )

Member Variables

Description

This control has the ability to play video streams. The only format accepted is the OGV Theora, so any other format must be converted before using in a project.

Member Function Description

  • int get_buffering_msec ( ) const

Get the amount of milliseconds to store in buffer while playing.

  • String get_stream_name ( ) const

Get the name of the video stream.

  • float get_stream_position ( ) const

Get the current position of the stream, in seconds.

Get the current frame of the video as a Texture.

  • float get_volume ( ) const

Get the volume of the audio track as a linear value.

  • bool is_playing ( ) const

Get whether or not the video is playing.

  • void play ( )

Start the video playback.

  • void set_buffering_msec ( int msec )

Set the amount of milliseconds to buffer during playback.

  • void set_stream_position ( float position )

Set the current position of the stream, in seconds.

  • void set_volume ( float volume )

Set the audio volume as a linear value.

  • void stop ( )

Stop the video playback.