Meta class for playing back audio.
Can play, loop, pause a scroll through audio. See [AudioStream] and [AudioStreamOggVorbis] for usage.
https://godotengine.org/asset-library/asset/2759
Overridable method. Should return how many times this audio stream has looped. Most built-in playbacks always return [code]0[/code].
Return the current value of a playback parameter by name (see [method AudioStream._get_parameter_list]).
Overridable method. Should return the current progress along the audio stream, in seconds.
Overridable method. Should return [code]true[/code] if this playback is active and playing its audio stream.
Override this method to customize how the audio stream is mixed. This method is called even if the playback is not active.
[b]Note:[/b] It is not useful to override this method in GDScript or C#. Only GDExtension can take advantage of it.
Override this method to customize what happens when seeking this audio stream at the given [param position], such as by calling [method AudioStreamPlayer.seek].
Set the current value of a playback parameter by name (see [method AudioStream._get_parameter_list]).
Override this method to customize what happens when the playback starts at the given position, such as by calling [method AudioStreamPlayer.play].
Override this method to customize what happens when the playback is stopped, such as by calling [method AudioStreamPlayer.stop].
Overridable method. Called whenever the audio stream is mixed if the playback is active and [method AudioServer.set_enable_tagging_used_audio_streams] has been set to [code]true[/code]. Editor plugins may use this method to "tag" the current position along the audio stream and display it in a preview.
Returns the number of times the stream has looped.
Returns the current position in the stream, in seconds.
Returns the [AudioSamplePlayback] associated with this [AudioStreamPlayback] for playing back the audio sample of this stream.
Returns [code]true[/code] if the stream is playing.
Mixes up to [param frames] of audio from the stream from the current position, at a rate of [param rate_scale], advancing the stream.
Returns a [PackedVector2Array] where each element holds the left and right channel volume levels of each frame.
[b]Note:[/b] Can return fewer frames than requested, make sure to use the size of the return value.
Seeks the stream at the given [param time], in seconds.
Associates [AudioSamplePlayback] to this [AudioStreamPlayback] for playing back the audio sample of this stream.
Starts the stream from the given [param from_pos], in seconds.
Stops the stream.