: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/AudioStreamPlayback.xml. .. _class_AudioStreamPlayback: AudioStreamPlayback =================== **Inherits:** :ref:`RefCounted` **<** :ref:`Object` **Inherited By:** :ref:`AudioStreamPlaybackInteractive`, :ref:`AudioStreamPlaybackPlaylist`, :ref:`AudioStreamPlaybackPolyphonic`, :ref:`AudioStreamPlaybackResampled`, :ref:`AudioStreamPlaybackSynchronized` Meta class for playing back audio. .. rst-class:: classref-introduction-group Description ----------- Can play, loop, pause a scroll through audio. See :ref:`AudioStream` and :ref:`AudioStreamOggVorbis` for usage. .. rst-class:: classref-introduction-group Tutorials --------- - `Audio Generator Demo `__ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`_get_loop_count`\ (\ ) |virtual| |const| | +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`_get_parameter`\ (\ name\: :ref:`StringName`\ ) |virtual| |const| | +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`_get_playback_position`\ (\ ) |virtual| |const| | +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`_is_playing`\ (\ ) |virtual| |const| | +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`_mix`\ (\ buffer\: ``AudioFrame*``, rate_scale\: :ref:`float`, frames\: :ref:`int`\ ) |virtual| |required| | +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`_seek`\ (\ position\: :ref:`float`\ ) |virtual| | +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`_set_parameter`\ (\ name\: :ref:`StringName`, value\: :ref:`Variant`\ ) |virtual| | +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`_start`\ (\ from_pos\: :ref:`float`\ ) |virtual| | +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`_stop`\ (\ ) |virtual| | +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`_tag_used_streams`\ (\ ) |virtual| | +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_loop_count`\ (\ ) |const| | +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_playback_position`\ (\ ) |const| | +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`AudioSamplePlayback` | :ref:`get_sample_playback`\ (\ ) |const| | +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_playing`\ (\ ) |const| | +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedVector2Array` | :ref:`mix_audio`\ (\ rate_scale\: :ref:`float`, frames\: :ref:`int`\ ) | +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`seek`\ (\ time\: :ref:`float` = 0.0\ ) | +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_sample_playback`\ (\ playback_sample\: :ref:`AudioSamplePlayback`\ ) | +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`start`\ (\ from_pos\: :ref:`float` = 0.0\ ) | +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`stop`\ (\ ) | +-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_AudioStreamPlayback_private_method__get_loop_count: .. rst-class:: classref-method :ref:`int` **_get_loop_count**\ (\ ) |virtual| |const| :ref:`🔗` Overridable method. Should return how many times this audio stream has looped. Most built-in playbacks always return ``0``. .. rst-class:: classref-item-separator ---- .. _class_AudioStreamPlayback_private_method__get_parameter: .. rst-class:: classref-method :ref:`Variant` **_get_parameter**\ (\ name\: :ref:`StringName`\ ) |virtual| |const| :ref:`🔗` Return the current value of a playback parameter by name (see :ref:`AudioStream._get_parameter_list()`). .. rst-class:: classref-item-separator ---- .. _class_AudioStreamPlayback_private_method__get_playback_position: .. rst-class:: classref-method :ref:`float` **_get_playback_position**\ (\ ) |virtual| |const| :ref:`🔗` Overridable method. Should return the current progress along the audio stream, in seconds. .. rst-class:: classref-item-separator ---- .. _class_AudioStreamPlayback_private_method__is_playing: .. rst-class:: classref-method :ref:`bool` **_is_playing**\ (\ ) |virtual| |const| :ref:`🔗` Overridable method. Should return ``true`` if this playback is active and playing its audio stream. .. rst-class:: classref-item-separator ---- .. _class_AudioStreamPlayback_private_method__mix: .. rst-class:: classref-method :ref:`int` **_mix**\ (\ buffer\: ``AudioFrame*``, rate_scale\: :ref:`float`, frames\: :ref:`int`\ ) |virtual| |required| :ref:`🔗` 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. .. rst-class:: classref-item-separator ---- .. _class_AudioStreamPlayback_private_method__seek: .. rst-class:: classref-method |void| **_seek**\ (\ position\: :ref:`float`\ ) |virtual| :ref:`🔗` Override this method to customize what happens when seeking this audio stream at the given ``position``, such as by calling :ref:`AudioStreamPlayer.seek()`. .. rst-class:: classref-item-separator ---- .. _class_AudioStreamPlayback_private_method__set_parameter: .. rst-class:: classref-method |void| **_set_parameter**\ (\ name\: :ref:`StringName`, value\: :ref:`Variant`\ ) |virtual| :ref:`🔗` Set the current value of a playback parameter by name (see :ref:`AudioStream._get_parameter_list()`). .. rst-class:: classref-item-separator ---- .. _class_AudioStreamPlayback_private_method__start: .. rst-class:: classref-method |void| **_start**\ (\ from_pos\: :ref:`float`\ ) |virtual| :ref:`🔗` Override this method to customize what happens when the playback starts at the given position, such as by calling :ref:`AudioStreamPlayer.play()`. .. rst-class:: classref-item-separator ---- .. _class_AudioStreamPlayback_private_method__stop: .. rst-class:: classref-method |void| **_stop**\ (\ ) |virtual| :ref:`🔗` Override this method to customize what happens when the playback is stopped, such as by calling :ref:`AudioStreamPlayer.stop()`. .. rst-class:: classref-item-separator ---- .. _class_AudioStreamPlayback_private_method__tag_used_streams: .. rst-class:: classref-method |void| **_tag_used_streams**\ (\ ) |virtual| :ref:`🔗` Overridable method. Called whenever the audio stream is mixed if the playback is active and :ref:`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. .. rst-class:: classref-item-separator ---- .. _class_AudioStreamPlayback_method_get_loop_count: .. rst-class:: classref-method :ref:`int` **get_loop_count**\ (\ ) |const| :ref:`🔗` Returns the number of times the stream has looped. .. rst-class:: classref-item-separator ---- .. _class_AudioStreamPlayback_method_get_playback_position: .. rst-class:: classref-method :ref:`float` **get_playback_position**\ (\ ) |const| :ref:`🔗` Returns the current position in the stream, in seconds. .. rst-class:: classref-item-separator ---- .. _class_AudioStreamPlayback_method_get_sample_playback: .. rst-class:: classref-method :ref:`AudioSamplePlayback` **get_sample_playback**\ (\ ) |const| :ref:`🔗` **Experimental:** This method may be changed or removed in future versions. Returns the :ref:`AudioSamplePlayback` associated with this **AudioStreamPlayback** for playing back the audio sample of this stream. .. rst-class:: classref-item-separator ---- .. _class_AudioStreamPlayback_method_is_playing: .. rst-class:: classref-method :ref:`bool` **is_playing**\ (\ ) |const| :ref:`🔗` Returns ``true`` if the stream is playing. .. rst-class:: classref-item-separator ---- .. _class_AudioStreamPlayback_method_mix_audio: .. rst-class:: classref-method :ref:`PackedVector2Array` **mix_audio**\ (\ rate_scale\: :ref:`float`, frames\: :ref:`int`\ ) :ref:`🔗` Mixes up to ``frames`` of audio from the stream from the current position, at a rate of ``rate_scale``, advancing the stream. Returns a :ref:`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. .. rst-class:: classref-item-separator ---- .. _class_AudioStreamPlayback_method_seek: .. rst-class:: classref-method |void| **seek**\ (\ time\: :ref:`float` = 0.0\ ) :ref:`🔗` Seeks the stream at the given ``time``, in seconds. .. rst-class:: classref-item-separator ---- .. _class_AudioStreamPlayback_method_set_sample_playback: .. rst-class:: classref-method |void| **set_sample_playback**\ (\ playback_sample\: :ref:`AudioSamplePlayback`\ ) :ref:`🔗` **Experimental:** This method may be changed or removed in future versions. Associates :ref:`AudioSamplePlayback` to this **AudioStreamPlayback** for playing back the audio sample of this stream. .. rst-class:: classref-item-separator ---- .. _class_AudioStreamPlayback_method_start: .. rst-class:: classref-method |void| **start**\ (\ from_pos\: :ref:`float` = 0.0\ ) :ref:`🔗` Starts the stream from the given ``from_pos``, in seconds. .. rst-class:: classref-item-separator ---- .. _class_AudioStreamPlayback_method_stop: .. rst-class:: classref-method |void| **stop**\ (\ ) :ref:`🔗` Stops the stream. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |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.)`