:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioStreamGeneratorPlayback.xml. .. _class_AudioStreamGeneratorPlayback: AudioStreamGeneratorPlayback ============================ **Inherits:** :ref:`AudioStreamPlaybackResampled` **<** :ref:`AudioStreamPlayback` **<** :ref:`RefCounted` **<** :ref:`Object` Plays back audio generated using :ref:`AudioStreamGenerator`. .. rst-class:: classref-introduction-group Description ----------- This class is meant to be used with :ref:`AudioStreamGenerator` to play back the generated audio in real-time. .. rst-class:: classref-introduction-group Tutorials --------- - `Audio Generator Demo `__ - `Godot 3.2 will get new audio features `__ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`can_push_buffer`\ (\ amount\: :ref:`int`\ ) |const| | +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`clear_buffer`\ (\ ) | +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_frames_available`\ (\ ) |const| | +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_skips`\ (\ ) |const| | +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`push_buffer`\ (\ frames\: :ref:`PackedVector2Array`\ ) | +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`push_frame`\ (\ frame\: :ref:`Vector2`\ ) | +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_AudioStreamGeneratorPlayback_method_can_push_buffer: .. rst-class:: classref-method :ref:`bool` **can_push_buffer**\ (\ amount\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if a buffer of the size ``amount`` can be pushed to the audio sample data buffer without overflowing it, ``false`` otherwise. .. rst-class:: classref-item-separator ---- .. _class_AudioStreamGeneratorPlayback_method_clear_buffer: .. rst-class:: classref-method |void| **clear_buffer**\ (\ ) :ref:`🔗` Clears the audio sample data buffer. .. rst-class:: classref-item-separator ---- .. _class_AudioStreamGeneratorPlayback_method_get_frames_available: .. rst-class:: classref-method :ref:`int` **get_frames_available**\ (\ ) |const| :ref:`🔗` 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. .. rst-class:: classref-item-separator ---- .. _class_AudioStreamGeneratorPlayback_method_get_skips: .. rst-class:: classref-method :ref:`int` **get_skips**\ (\ ) |const| :ref:`🔗` Returns the number of times the playback skipped due to a buffer underrun in the audio sample data. This value is reset at the start of the playback. .. rst-class:: classref-item-separator ---- .. _class_AudioStreamGeneratorPlayback_method_push_buffer: .. rst-class:: classref-method :ref:`bool` **push_buffer**\ (\ frames\: :ref:`PackedVector2Array`\ ) :ref:`🔗` Pushes several audio data frames to the buffer. This is usually more efficient than :ref:`push_frame()` in C# and compiled languages via GDExtension, but :ref:`push_buffer()` may be *less* efficient in GDScript. .. rst-class:: classref-item-separator ---- .. _class_AudioStreamGeneratorPlayback_method_push_frame: .. rst-class:: classref-method :ref:`bool` **push_frame**\ (\ frame\: :ref:`Vector2`\ ) :ref:`🔗` Pushes a single audio data frame to the buffer. This is usually less efficient than :ref:`push_buffer()` in C# and compiled languages via GDExtension, but :ref:`push_frame()` may be *more* efficient in GDScript. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` .. |void| replace:: :abbr:`void (No return value.)`