A control used for video playback.
A control used for playback of [VideoStream] resources. Supported video formats are [url=https://www.theora.org/]Ogg Theora[/url] ([code].ogv[/code], [VideoStreamTheora]) and any format exposed via a GDExtension plugin. [b]Note:[/b] Due to a bug, VideoStreamPlayer does not support localization remapping yet. [b]Warning:[/b] On Web, video playback [i]will[/i] perform poorly due to missing architecture-specific assembly optimizations.
$DOCS_URL/tutorials/animation/playing_videos.html
The length of the current stream, in seconds. [b]Note:[/b] 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.
Returns the video stream's name, or [code]"<No Stream>"[/code] if no video stream is assigned.
Returns the current frame as a [Texture2D].
Returns [code]true[/code] if the video is playing. [b]Note:[/b] The video is still considered playing if paused during playback.
Starts the video playback from the beginning. If the video is paused, this will not unpause the video.
Stops the video playback and sets the stream position to 0. [b]Note:[/b] Although the stream position will be set to 0, the first frame of the video stream won't become the current frame.
- The embedded audio track to play.
- If [code]true[/code], playback starts when the scene loads.
- Amount of time in milliseconds to store in buffer while playing.
- Audio bus to use for sound playback.
- If [code]true[/code], the video scales to the control size. Otherwise, the control minimum size will be automatically adjusted to match the video stream's dimensions.
- If [code]true[/code], the video restarts when it reaches its end.
- If [code]true[/code], the video is paused.
- The assigned video stream. See description for supported formats.
- The current position of the stream, in seconds. [b]Note:[/b] Changing this value won't have any effect as seeking is not implemented yet, except in video formats implemented by a GDExtension add-on.
- Audio volume as a linear value.
- Audio volume in dB.
Emitted when playback is finished.