You are reading the latest (unstable) version of this documentation, which may document features not available or compatible with Godot 3.x.

Work in progress

Godot documentation is being updated to reflect the latest changes in version 4.0. Some documentation pages may still state outdated information. This banner will tell you if you're reading one of such pages.

The contents of this page are up to date. If you can still find outdated information, please open an issue.


Inherits: Resource < RefCounted < Object

Inherited By: VideoStreamTheora

Base resource for video streams.


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.







_instantiate_playback ( ) virtual

Property Descriptions

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