Up to date

This page is up to date for Godot 4.1. If you still find outdated information, please open an issue.

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¶

Audio Generator Demo

Methods¶

int	_get_loop_count ( ) virtual const
float	_get_playback_position ( ) virtual const
bool	_is_playing ( ) virtual const
int	_mix ( AudioFrame* buffer, float rate_scale, int frames ) virtual
void	_seek ( float position ) virtual
void	_start ( float from_pos ) 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.

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 ( AudioFrame* buffer, float rate_scale, int frames ) 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 ( float position ) virtual

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

void _start ( float from_pos ) 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.