AudioStreamPlayback

public int GetLoopCount();

Overridable method. Should return how many times this audio stream has looped. Most built-in playbacks always return 0.

public double GetPlaybackPosition();

Overridable method. Should return the current progress along the audio stream, in seconds.

public AudioSamplePlayback GetSamplePlayback();

Returns the AudioSamplePlayback associated with this AudioStreamPlayback for playing back the audio sample of this stream.

public bool IsPlaying();

Overridable method. Should return true if this playback is active and playing its audio stream.

public Vector2[] MixAudio(float rateScale, int frames);

Mixes up to frames of audio from the stream from the current position, at a rate of rate_scale, advancing the stream. Returns a Vector2[] where each element holds the left and right channel volume levels of each frame. Note: Can return fewer frames than requested, make sure to use the size of the return value.

public void Seek(double time = 0d);

Override this method to customize what happens when seeking this audio stream at the given position, such as by calling AudioStreamPlayer.Seek.

public void SetSamplePlayback(AudioSamplePlayback playbackSample);

Associates AudioSamplePlayback to this AudioStreamPlayback for playing back the audio sample of this stream.

public void Start(double fromPos = 0d);

Override this method to customize what happens when the playback starts at the given position, such as by calling AudioStreamPlayer.Play.

public void Stop();

Override this method to customize what happens when the playback is stopped, such as by calling AudioStreamPlayer.Stop.

public virtual int _GetLoopCount();

Overridable method. Should return how many times this audio stream has looped. Most built-in playbacks always return 0.

public virtual Variant _GetParameter(StringName name);

Return the current value of a playback parameter by name (see AudioStream._GetParameterList).

public virtual double _GetPlaybackPosition();

Overridable method. Should return the current progress along the audio stream, in seconds.

public virtual bool _IsPlaying();

Overridable method. Should return true if this playback is active and playing its audio stream.

public virtual void _Seek(double position);

Override this method to customize what happens when seeking this audio stream at the given position, such as by calling AudioStreamPlayer.Seek.

public virtual void _SetParameter(StringName name, Variant value);

Set the current value of a playback parameter by name (see AudioStream._GetParameterList).

public virtual void _Start(double fromPos);

Override this method to customize what happens when the playback starts at the given position, such as by calling AudioStreamPlayer.Play.

public virtual void _Stop();

Override this method to customize what happens when the playback is stopped, such as by calling AudioStreamPlayer.Stop.

public virtual void _TagUsedStreams();

Overridable method. Called whenever the audio stream is mixed if the playback is active and AudioServer.SetEnableTaggingUsedAudioStreams has been set to true. Editor plugins may use this method to "tag" the current position along the audio stream and display it in a preview.