class-description NEWS COMMUNITY STORE TUTORIALS SIGN UP LOGIN LOGOUT ROKOJORI NEWSLETTER SIGN UP LOGIN LOGOUT NEWS COMMUNITY STORE TUTORIALS TOGGLE FULLSCREEN VOLLBILD AN/AUS ObjectNodeCanvasItemControl VideoStreamPlayer
A control used for video playback.

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.

 finished finished<>():finished

Emitted when playback is finished.

 int audio_track<>():int

The embedded audio track to play.

 bool autoplay<>():bool

If true, playback starts when the scene loads.

 int buffering_msec<>():int

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

 StringName bus<>():StringName

Audio bus to use for sound playback.

 bool expand<>():bool

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.

 bool loop<>():bool

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

 bool paused<>():bool

If true, the video is paused.

 VideoStream stream<>():VideoStream

The assigned video stream. See description for supported formats.

 float stream_position<>():float

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.

 float volume<>():float

Audio volume as a linear value.

 float volume_db<>():float

Audio volume in dB.

 float get_stream_length<>():float

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.

 String get_stream_name<>():String

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

 Texture2D get_video_texture<>():Texture2D

Returns the current frame as a Texture2D.

 bool is_playing<>():bool

Returns true if the video is playing.

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

 void play<>():void

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

 void stop<>():void

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.


All social media brands are registrated trademarks and belong to their respective owners.





CONTACT IMPRINT TERMS OF USE PRIVACY © ROKOROJI ® 2021 rokojori.com CONTACT IMPRINT TERMS OF USE PRIVACY © ROKOROJI ® 2021 rokojori.com We are using cookies on this site. Read more... Wir benutzen Cookies auf dieser Seite. Mehr lesen...