Attention: Here be dragons
This is the
(unstable) version of this documentation, which may document features
not available in or compatible with released stable versions of Godot.
Checking the stable version of the documentation...
Inherits: AudioStreamPlaybackResampled < AudioStreamPlayback < RefCounted < Object
Plays back audio generated using AudioStreamGenerator.
This class is meant to be used with AudioStreamGenerator to play back the generated audio in real-time.
can_push_buffer ( int amount ) const
clear_buffer ( )
get_frames_available ( ) const
get_skips ( ) const
push_buffer ( PackedVector2Array frames )
push_frame ( Vector2 frame )
bool can_push_buffer ( int amount ) const
true if a buffer of the size
amount can be pushed to the audio sample data buffer without overflowing it,
void clear_buffer ( )
Clears the audio sample data buffer.
int get_frames_available ( ) const
Returns the number of frames that can be pushed to the audio sample data buffer without overflowing it. If the result is
0, the buffer is full.
int get_skips ( ) const
There is currently no description for this method. Please help us by contributing one!
bool push_buffer ( PackedVector2Array frames )
Pushes several audio data frames to the buffer. This is usually more efficient than push_frame in C# and compiled languages via GDExtension, but push_buffer may be less efficient in GDScript.
bool push_frame ( Vector2 frame )
Pushes a single audio data frame to the buffer. This is usually less efficient than push_buffer in C# and compiled languages via GDExtension, but push_frame may be more efficient in GDScript.