Table of Contents

Class VideoStream

Namespace
Godot
Assembly
GodotSharp.dll

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.

public class VideoStream : Resource, IDisposable
Inheritance
VideoStream
Implements
Derived
Inherited Members

Constructors

VideoStream() 

public VideoStream()

Properties

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.

public string File { get; set; }

Property Value

string

Methods

HasGodotClassMethod(in godot_string_name)

Check if the type contains a method with the given name. This method is used by Godot to check if a method exists before invoking it. Do not call or override this method.

protected override bool HasGodotClassMethod(in godot_string_name method)

Parameters

method godot_string_name

Name of the method to check for.

Returns

bool

HasGodotClassSignal(in godot_string_name)

Check if the type contains a signal with the given name. This method is used by Godot to check if a signal exists before raising it. Do not call or override this method.

protected override bool HasGodotClassSignal(in godot_string_name signal)

Parameters

signal godot_string_name

Name of the signal to check for.

Returns

bool

InvokeGodotClassMethod(in godot_string_name, NativeVariantPtrArgs, out godot_variant)

Invokes the method with the given name, using the given arguments. This method is used by Godot to invoke methods from the engine side. Do not call or override this method.

protected override bool InvokeGodotClassMethod(in godot_string_name method, NativeVariantPtrArgs args, out godot_variant ret)

Parameters

method godot_string_name

Name of the method to invoke.

args NativeVariantPtrArgs

Arguments to use with the invoked method.

ret godot_variant

Value returned by the invoked method.

Returns

bool

_InstantiatePlayback()

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

public virtual VideoStreamPlayback _InstantiatePlayback()

Returns

VideoStreamPlayback
Edit this page