VideoPlayer

Inherits: Control < CanvasItem < Node < Object

Category: Core

Brief Description

Control for playing video streams.

Member Functions

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

Signals

  • finished ( )

Emitted when playback is finished.

Member Variables

  • int audio_track - The embedded audio track to play.
  • bool autoplay - If true playback starts when the scene loads. Default value: false.
  • int buffering_msec - Amount of time in milliseconds to store in buffer while playing.
  • String bus - Audio bus to use for sound playback.
  • bool expand - If true the video scales to the control size. Default value: true.
  • bool paused - If true the video is paused.
  • VideoStream stream
  • float stream_position - The current position of the stream, in seconds.
  • float volume - Audio volume as a linear value.
  • float volume_db - Audio volume in dB.

Description

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

Member Function Description

  • 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.