VideoStreamPlayer

public VideoStreamPlayer();

Creates a UI video player. Play requires tree membership and a valid Stream providing a decoder.

public int AudioTrack { get; set; }

Audio-track index, normally zero-based. Passed to the shared Stream and current playback; switching support depends on the decoder. Does not create a track or choose an audio bus.

public bool Autoplay { get; set; }

Starts on tree entry when Stream is already assigned and this is not the editor. Enabling it after entry does not itself call Play; assigning Stream later is not another tree entry.

public int BufferingMsec { get; set; }

Audio-buffering duration in milliseconds for playback setup. The setter stores the value without rebuilding an existing buffer: configure before Stream or reassign the stream. Neither movie duration nor a network video buffer.

public StringName Bus { get; set; }

Existing audio-bus name. The getter falls back to Master when the named bus is missing. Assignment neither creates a bus nor chooses a video track.

public bool Expand { get; set; }

true stretches frames to current Size and removes the video-resolution minimum size. false draws at natural frame size. Stretching does not automatically preserve aspect ratio.

public bool Loop { get; set; }

Calls Play again on natural completion instead of Finished. The playback implementation supplies restart behavior. Does not turn manual Stop into a completion event.

public bool Paused { get; set; }

User pause state; false resumes processing when the tree allows it. Not equivalent to IsPlaying. Tree pause/suspension may temporarily pause decoding without changing this user flag.

public float SpeedScale { get; set; }

Nonnegative video/audio progression multiplier; one is normal speed, negative values are rejected. Zero does not set Paused; use Paused for explicit pause state. Applies together with engine time scaling.

public VideoStream Stream { get; set; }

Video resource. Assignment stops the old stream, creates a new playback and updates the texture/audio buffer. null removes it. Players may share a resource while using separate playback objects; the resource itself remains shared.

public double StreamPosition { get; set; }

Position in seconds. The setter flushes queued audio and delegates seeking to the decoder; does not validate bounds or guarantee an exact frame. With known duration use zero <= position < length; Theora ignores positions at or beyond duration. The getter returns zero without playback.

public float Volume { get; set; }

Linear audio multiplier: zero is silence, one is the original level, values above one amplify. Use nonnegative values. Does not affect frame brightness or replace bus volume.

public float VolumeDb { get; set; }

The same volume in decibels: zero dB corresponds to Volume one. Below -79 dB sets silence; the getter returns -80 for silence. Not an independent second volume control.

public int GetAudioTrack();

Audio-track index, normally zero-based. Passed to the shared Stream and current playback; switching support depends on the decoder. Does not create a track or choose an audio bus.

public int GetBufferingMsec();

Audio-buffering duration in milliseconds for playback setup. The setter stores the value without rebuilding an existing buffer: configure before Stream or reassign the stream. Neither movie duration nor a network video buffer.

public StringName GetBus();

Existing audio-bus name. The getter falls back to Master when the named bus is missing. Assignment neither creates a bus nor chooses a video track.

public float GetSpeedScale();

Nonnegative video/audio progression multiplier; one is normal speed, negative values are rejected. Zero does not set Paused; use Paused for explicit pause state. Applies together with engine time scaling.

public VideoStream GetStream();

Video resource. Assignment stops the old stream, creates a new playback and updates the texture/audio buffer. null removes it. Players may share a resource while using separate playback objects; the resource itself remains shared.

public double GetStreamLength();

Duration in seconds from the decoder, zero without playback or when the implementation has no duration information. Zero does not prove an empty file.

public string GetStreamName();

Stream resource name, not necessarily its filename. Returns the service string <No Stream> without a resource. Use the resource File property for its path.

public double GetStreamPosition();

Position in seconds. The setter flushes queued audio and delegates seeking to the decoder; does not validate bounds or guarantee an exact frame. With known duration use zero <= position < length; Theora ignores positions at or beyond duration. The getter returns zero without playback.

public Texture2D GetVideoTexture();

Returns the decoder’s shared current texture, or null without playback. May change as decoding proceeds rather than being a frame snapshot. Do not free it as an owned server resource.

public float GetVolume();

Linear audio multiplier: zero is silence, one is the original level, values above one amplify. Use nonnegative values. Does not affect frame brightness or replace bus volume.

public float GetVolumeDb();

The same volume in decibels: zero dB corresponds to Volume one. Below -79 dB sets silence; the getter returns -80 for silence. Not an independent second volume control.

public bool HasAutoplay();

Starts on tree entry when Stream is already assigned and this is not the editor. Enabling it after entry does not itself call Play; assigning Stream later is not another tree entry.

public bool HasExpand();

true stretches frames to current Size and removes the video-resolution minimum size. false draws at natural frame size. Stretching does not automatically preserve aspect ratio.

public bool HasLoop();

Calls Play again on natural completion instead of Finished. The playback implementation supplies restart behavior. Does not turn manual Stop into a completion event.

public bool IsPaused();

User pause state; false resumes processing when the tree allows it. Not equivalent to IsPlaying. Tree pause/suspension may temporarily pause decoding without changing this user flag.

public bool IsPlaying();

Returns playback state or false without one. Does not test audible sound or a newly drawn frame; a paused decoder may still report playing.

public void Play();

Starts the current decoder; requires the control in the tree and a prepared Stream. Repeated Play does not guarantee restarting from the beginning for every implementation. Resume a pause with Paused false.

public void SetAudioTrack(int track);

Audio-track index, normally zero-based. Passed to the shared Stream and current playback; switching support depends on the decoder. Does not create a track or choose an audio bus.

public void SetAutoplay(bool enabled);

Starts on tree entry when Stream is already assigned and this is not the editor. Enabling it after entry does not itself call Play; assigning Stream later is not another tree entry.

public void SetBufferingMsec(int msec);

Audio-buffering duration in milliseconds for playback setup. The setter stores the value without rebuilding an existing buffer: configure before Stream or reassign the stream. Neither movie duration nor a network video buffer.

public void SetBus(StringName bus);

Existing audio-bus name. The getter falls back to Master when the named bus is missing. Assignment neither creates a bus nor chooses a video track.

public void SetExpand(bool enable);

true stretches frames to current Size and removes the video-resolution minimum size. false draws at natural frame size. Stretching does not automatically preserve aspect ratio.

public void SetLoop(bool loop);

Calls Play again on natural completion instead of Finished. The playback implementation supplies restart behavior. Does not turn manual Stop into a completion event.

public void SetPaused(bool paused);

User pause state; false resumes processing when the tree allows it. Not equivalent to IsPlaying. Tree pause/suspension may temporarily pause decoding without changing this user flag.

public void SetSpeedScale(float speedScale);

Nonnegative video/audio progression multiplier; one is normal speed, negative values are rejected. Zero does not set Paused; use Paused for explicit pause state. Applies together with engine time scaling.

public void SetStream(VideoStream stream);

Video resource. Assignment stops the old stream, creates a new playback and updates the texture/audio buffer. null removes it. Players may share a resource while using separate playback objects; the resource itself remains shared.

public void SetStreamPosition(double position);

Position in seconds. The setter flushes queued audio and delegates seeking to the decoder; does not validate bounds or guarantee an exact frame. With known duration use zero <= position < length; Theora ignores positions at or beyond duration. The getter returns zero without playback.

public void SetVolume(float volume);

Linear audio multiplier: zero is silence, one is the original level, values above one amplify. Use nonnegative values. Does not affect frame brightness or replace bus volume.

public void SetVolumeDb(float db);

The same volume in decibels: zero dB corresponds to Volume one. Below -79 dB sets silence; the getter returns -80 for silence. Not an independent second volume control.

public void Stop();

Stops playback and flushes queued audio. Does not emit Finished; position reset depends on the decoder, with Theora seeking to the start. Does nothing outside the tree.

public event Action Finished;

Natural completion of the current playback with Loop disabled. Not emitted by manual Stop; does not mean the player/resource was deleted.