Meta class for playing back audio.
Can play, loop, pause a scroll through audio. See AudioStream and AudioStreamOggVorbis for usage.
Overridable method. Should return how many times this audio stream has looped. Most built-in playbacks always return 0.
Return the current value of a playback parameter by name (see AudioStream._get_parameter_list()).
Override this method to customize how the audio stream is mixed. This method is called even if the playback is not active.
Note: 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 position, such as by calling AudioStreamPlayer.seek().
Set the current value of a playback parameter by name (see AudioStream._get_parameter_list()).
Override this method to customize what happens when the playback starts at the given position, such as by calling AudioStreamPlayer.play().
Override this method to customize what happens when the playback is stopped, such as by calling AudioStreamPlayer.stop().
Overridable method. Called whenever the audio stream is mixed if the playback is active and AudioServer.set_enable_tagging_used_audio_streams() 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.
Returns the AudioSamplePlayback associated with this AudioStreamPlayback for playing back the audio sample of this stream.
Mixes up to frames of audio from the stream from the current position, at a rate of rate_scale, advancing the stream.
Returns a PackedVector2Array 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.
Associates AudioSamplePlayback to this AudioStreamPlayback for playing back the audio sample of this stream.