VideoPlayer

Control for playing video streams.

Control node for playing video streams. Supported formats are WebM and OGV Theora.

@GodotBaseClass

struct VideoPlayer {

enum string _GODOT_internal_name;

union __anonymous;

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

bool opEquals(VideoPlayer other);

VideoPlayer opAssign(T n);

bool opEquals(typeof(null) n);

mixin baseCasts ;

static VideoPlayer _new();

void setStream(VideoStream stream);

Ref!VideoStream getStream();

bool isPlaying();

void setPaused(bool paused);

bool isPaused();

void setVolume(double volume);

double getVolume();

void setVolumeDb(double db);

double getVolumeDb();

void setAudioTrack(long track);

long getAudioTrack();

String getStreamName();

void setStreamPosition(double position);

double getStreamPosition();

void setAutoplay(bool enabled);

bool hasAutoplay();

void setExpand(bool enable);

bool hasExpand();

void setBufferingMsec(long msec);

long getBufferingMsec();

void setBus(StringArg0 bus);

String getBus();

Ref!Texture getVideoTexture();

long audioTrack [@property getter];

long audioTrack [@property setter];

VideoStream stream [@property getter];

VideoStream stream [@property setter];

double volumeDb [@property getter];

double volumeDb [@property setter];

double volume [@property getter];

double volume [@property setter];

bool autoplay [@property getter];

bool autoplay [@property setter];

bool paused [@property getter];

bool paused [@property setter];

bool expand [@property getter];

bool expand [@property setter];

long bufferingMsec [@property getter];

long bufferingMsec [@property setter];

double streamPosition [@property getter];

double streamPosition [@property setter];

String bus [@property getter];

String bus [@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.
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.
opAssign VideoPlayer opAssign(T n): Undocumented in source. Be warned that the author may not have intended to support it.
opEquals bool opEquals(VideoPlayer other): Undocumented in source. Be warned that the author may not have intended to support it.
opEquals bool opEquals(typeof(null) n): Undocumented in source. Be warned that the author may not have intended to support it.
play void play(): Starts the video playback.
setAudioTrack void setAudioTrack(long track)
setAutoplay void setAutoplay(bool enabled)
setBufferingMsec void setBufferingMsec(long msec)
setBus void setBus(StringArg0 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.

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. Default value: false.
bufferingMsec long bufferingMsec [@property getter]
long bufferingMsec [@property setter]: Amount of time in milliseconds to store in buffer while playing.
bus String bus [@property setter]: Audio bus to use for sound playback.
bus String bus [@property getter]: 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. Default value: true.
paused bool paused [@property getter]
bool paused [@property setter]: If true the video is paused.
stream VideoStream stream [@property getter]
VideoStream stream [@property setter]
streamPosition double streamPosition [@property getter]
double streamPosition [@property setter]: The current position of the stream, in seconds.
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(): Undocumented in source. Be warned that the author may not have intended to support it.

Static variables

_classBindingInitialized bool _classBindingInitialized;: Undocumented in source.

Structs

_classBinding struct _classBinding: 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 To as(): Undocumented in source. Be warned that the author may not have intended to support it.
as To as(): Undocumented in source. Be warned that the author may not have intended to support it.
as 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