Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

VideoStream

Inherits: Resource < RefCounted < Object

Inherited By: VideoStreamTheora

Base resource for video streams.

Description

Base resource type for all video streams. Classes that derive from VideoStream can all be used as resource types to play back videos in VideoStreamPlayer.

Tutorials

Properties

String

file

""

Methods

VideoStreamPlayback

_instantiate_playback() virtual

Property Descriptions

String file = "" 🔗

void set_file(value: String)
String get_file()

The video file path or URI that this VideoStream resource handles.

For VideoStreamTheora, this filename should be an Ogg Theora video file with the .ogv extension.

Method Descriptions

VideoStreamPlayback _instantiate_playback() virtual 🔗

Called when the video starts playing, to initialize and return a subclass of VideoStreamPlayback.

User-contributed notes

Please read the User-contributed notes policy before submitting a comment.