Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

AudioStreamPlayback

Inherits: RefCounted < Object

Inherited By: AudioStreamPlaybackPolyphonic, AudioStreamPlaybackResampled

Meta class for playing back audio.

Description

Can play, loop, pause a scroll through audio. See AudioStream and AudioStreamOggVorbis for usage.

Tutorials

Methods

int

_get_loop_count() virtual const

Variant

_get_parameter(name: StringName) virtual const

float

_get_playback_position() virtual const

bool

_is_playing() virtual const

int

_mix(buffer: AudioFrame*, rate_scale: float, frames: int) virtual

void

_seek(position: float) virtual

void

_set_parameter(name: StringName, value: Variant) virtual

void

_start(from_pos: float) virtual

void

_stop() virtual

void

_tag_used_streams() virtual


Method Descriptions

int _get_loop_count() virtual const

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


Variant _get_parameter(name: StringName) virtual const

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


float _get_playback_position() virtual const

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


bool _is_playing() virtual const

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


int _mix(buffer: AudioFrame*, rate_scale: float, frames: int) virtual

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.


void _seek(position: float) virtual

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


void _set_parameter(name: StringName, value: Variant) virtual

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


void _start(from_pos: float) virtual

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


void _stop() virtual

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


void _tag_used_streams() virtual

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.


User-contributed notes

Please read the User-contributed notes policy before submitting a com