Inheritance #
- AudioServer
- CameraServer
- ClassDB
- DisplayServer
- EditorFileSystemDirectory
- EditorInterface
- EditorPaths
- EditorSelection
- EditorUndoRedoManager
- EditorVCSInterface
- Engine
- EngineDebugger
- FramebufferCacheRD
- GDExtensionManager
- Geometry2D
- Geometry3D
- IP
- Input
- InputMap
- JNISingleton
- JSONRPC
- JavaClassWrapper
- JavaScriptBridge
- MainLoop (1)
- Marshalls
- MovieWriter
- NativeMenu
- NavigationMeshGenerator
- NavigationServer2D
- NavigationServer3D
- Node (21)
- OS
- OpenXRExtensionWrapperExtension
- OpenXRInteractionProfileMetadata
- Performance
- PhysicsDirectBodyState2D (1)
- PhysicsDirectBodyState3D (1)
- PhysicsDirectSpaceState2D (1)
- PhysicsDirectSpaceState3D (1)
- PhysicsServer2D (1)
- PhysicsServer2DManager
- PhysicsServer3D (1)
- PhysicsServer3DManager
- PhysicsServer3DRendering
ServerHandler
- ProjectSettings
- RefCounted (121)
- RenderData (2)
- RenderSceneData (2)
- RenderingDevice
- RenderingServer
- ResourceLoader
- ResourceSaver
- ResourceUID
- ScriptLanguage (1)
- ShaderIncludeDB
- TextServerManager
- ThemeDB
- TileData
- Time
- TranslationServer
- TreeItem
- UndoRedo
- UniformSetCacheRD
- WorkerThreadPool
- XRServer
- XRVRS
- AnimationMixer (2)
- AudioStreamPlayer
- CanvasItem (2)
- CanvasLayer (1)
- EditorFileSystem
- EditorPlugin (1)
- EditorResourcePreview
- HTTPRequest
- InstancePlaceholder
- MissingNode
- MultiplayerSpawner
- MultiplayerSynchronizer
- NavigationAgent2D
- NavigationAgent3D
- Node3D (31)
- ResourcePreloader
- ShaderGlobalsOverride
- StatusIndicator
- Timer
- Viewport (2)
- WorldEnvironment
- BaseButton (3)
- ColorRect
- Container (13)
- GraphEdit
- ItemList
- Label
- LineEdit
- MenuBar
- NinePatchRect
- Panel
- Range (6)
- ReferenceRect
- RichTextLabel
- Separator (2)
- TabBar
- TextEdit (1)
- TextureRect
- Tree
- VideoStreamPlayer
Table of contents
-
var audio_track: int = 0 -
var autoplay: bool = false -
var buffering_msec: int = 500 -
var bus: StringName = &"Master" -
var expand: bool = false -
var loop: bool = false -
var paused: bool = false -
var stream: VideoStream -
var stream_position: float -
var volume: float -
var volume_db: float = 0.0 -
const func get_stream_length() -> float -
const func get_stream_name() -> String -
const func get_video_texture() -> Texture2D -
const func is_playing() -> bool -
func play() -> void -
func stop() -> void -
signal finished()
VideoStreamPlayer #
is_instantiable, Node, core, not_builtin_classes
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.
Members #
var audio_track: int = 0#
The embedded audio track to play.
var autoplay: bool = false#
If true, playback starts when the scene loads.
var buffering_msec: int = 500#
Amount of time in milliseconds to store in buffer while playing.
var bus: StringName = &"Master"#
Audio bus to use for sound playback.
var expand: bool = false#
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.
var loop: bool = false#
If true, the video restarts when it reaches its end.
var paused: bool = false#
If true, the video is paused.
var stream: VideoStream#
The assigned video stream. See description for supported formats.
var 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.
var volume: float#
Audio volume as a linear value.
var volume_db: float = 0.0#
Audio volume in dB.
Methods #
const func 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.
const func get_stream_name() -> String#
Returns the video stream's name, or " if no video stream is assigned.
const func is_playing() -> bool#
Returns true if the video is playing.
Note: The video is still considered playing if paused during playback.
func play() -> void#
Starts the video playback from the beginning. If the video is paused, this will not unpause the video.
func 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.
Annotations #
Constants #
Constructors #
Enums #
Operators #
Signals #
signal finished()#
Emitted when playback is finished.