VideoPlayer

Control for playing video streams.

Control node for playing video streams using VideoStream resources. Supported video formats are url=https://www.webmproject.org/WebM/url (.webm, VideoStreamWebm), url=https://www.theora.org/Ogg Theora/url (.ogv, VideoStreamTheora), and any format exposed via a GDNative plugin using VideoStreamGDNative. Note: Due to a bug, VideoPlayer does not support localization remapping yet. Warning: On HTML5, video playback will perform poorly due to missing architecture-specific assembly optimizations, especially for VP8/VP9.

@GodotBaseClass

struct VideoPlayer {

enum string _GODOT_internal_name;

union __anonymous;

alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses);

package @nogc nothrow __gshared

bool _classBindingInitialized;

struct GDNativeClassBinding;

bool opEquals(VideoPlayer other);

typeof(null) opAssign(typeof(null) n);

bool opEquals(typeof(null) n);

size_t toHash();

mixin baseCasts ;

static VideoPlayer _new();

long getAudioTrack();

long getBufferingMsec();

String getBus();

Ref!VideoStream getStream();

String getStreamName();

double getStreamPosition();

Ref!Texture getVideoTexture();

double getVolume();

double getVolumeDb();

bool hasAutoplay();

bool hasExpand();

bool isPaused();

bool isPlaying();

void setAudioTrack(long track);

void setAutoplay(bool enabled);

void setBufferingMsec(long msec);

void setBus(String bus);

void setExpand(bool enable);

void setPaused(bool paused);

void setStream(VideoStream stream);

void setStreamPosition(double position);

void setVolume(double volume);

void setVolumeDb(double db);

long audioTrack [@property getter];

long audioTrack [@property setter];

bool autoplay [@property getter];

bool autoplay [@property setter];

long bufferingMsec [@property getter];

long bufferingMsec [@property setter];

String bus [@property getter];

String bus [@property setter];

bool expand [@property getter];

bool expand [@property setter];

bool paused [@property getter];

bool paused [@property setter];

VideoStream stream [@property getter];

VideoStream stream [@property setter];

double streamPosition [@property getter];

double streamPosition [@property setter];

double volume [@property getter];

double volume [@property setter];

double volumeDb [@property getter];

double volumeDb [@property setter];

}

Members

Aliases

BaseClasses alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses): Undocumented in source.

Functions

getAudioTrack long getAudioTrack()
getBufferingMsec long getBufferingMsec()
getBus String getBus()
getStream Ref!VideoStream getStream()
getStreamName String getStreamName(): Returns the video stream's name, or "<No Stream>" if no video stream is assigned.
getStreamPosition double getStreamPosition()
getVideoTexture Ref!Texture getVideoTexture(): Returns the current frame as a Texture.
getVolume double getVolume()
getVolumeDb double getVolumeDb()
hasAutoplay bool hasAutoplay()
hasExpand bool hasExpand()
isPaused bool isPaused()
isPlaying bool isPlaying(): Returns true if the video is playing. Note: The video is still considered playing if paused during playback.
opAssign typeof(null) opAssign(typeof(null) n)
opEquals bool opEquals(VideoPlayer other)
opEquals bool opEquals(typeof(null) n)
play void play(): Starts the video playback from the beginning. If the video is paused, this will not unpause the video.
setAudioTrack void setAudioTrack(long track)
setAutoplay void setAutoplay(bool enabled)
setBufferingMsec void setBufferingMsec(long msec)
setBus void setBus(String bus)
setExpand void setExpand(bool enable)
setPaused void setPaused(bool paused)
setStream void setStream(VideoStream stream)
setStreamPosition void setStreamPosition(double position)
setVolume void setVolume(double volume)
setVolumeDb void setVolumeDb(double db)
stop void stop(): 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.
toHash size_t toHash()

Mixins

__anonymous mixin baseCasts: Undocumented in source.

Properties

audioTrack long audioTrack [@property getter]
long audioTrack [@property setter]: The embedded audio track to play.
autoplay bool autoplay [@property getter]
bool autoplay [@property setter]: If true, playback starts when the scene loads.
bufferingMsec long bufferingMsec [@property getter]
long bufferingMsec [@property setter]: Amount of time in milliseconds to store in buffer while playing.
bus String bus [@property getter]
String bus [@property setter]: Audio bus to use for sound playback.
expand bool expand [@property getter]
bool expand [@property setter]: 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.
paused bool paused [@property getter]
bool paused [@property setter]: If true, the video is paused.
stream VideoStream stream [@property getter]
VideoStream stream [@property setter]: The assigned video stream. See description for supported formats.
streamPosition double streamPosition [@property getter]
double streamPosition [@property setter]: 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 GDNative add-on.
volume double volume [@property getter]
double volume [@property setter]: Audio volume as a linear value.
volumeDb double volumeDb [@property getter]
double volumeDb [@property setter]: Audio volume in dB.

Static functions

_new VideoPlayer _new(): Construct a new instance of VideoPlayer. Note: use memnew!VideoPlayer instead.

Static variables

_classBindingInitialized bool _classBindingInitialized;: Undocumented in source.

Structs

GDNativeClassBinding struct GDNativeClassBinding: Undocumented in source.

Unions

__anonymous union __anonymous: Undocumented in source.

Variables

_GODOT_internal_name enum string _GODOT_internal_name;: Undocumented in source.

Mixed In Members

From `mixin baseCasts`

as inout(To) as(): Undocumented in source. Be warned that the author may not have intended to support it.
as inout(To) as(): Undocumented in source. Be warned that the author may not have intended to support it.
as inout(ToRef) as(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast template opCast(To): Undocumented in source.
opCast template opCast(To): Undocumented in source.
opCast template opCast(ToRef): Undocumented in source.
opCast void* opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast godot_object opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast bool opCast(): Undocumented in source. Be warned that the author may not have intended to support it.

Meta

Source

See Implementation

godot videoplayer structs

VideoPlayer