<?xml version="1.0" encoding="UTF-8" ?> <class name="AudioStreamPlayback" inherits="RefCounted" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> Meta class for playing back audio. </brief_description> <description> Can play, loop, pause a scroll through audio. See [AudioStream] and [AudioStreamOggVorbis] for usage. </description> <tutorials> <link title="Audio Generator Demo">https://godotengine.org/asset-library/asset/526</link> </tutorials> <methods> <method name="_get_loop_count" qualifiers="virtual const"> <return type="int" /> <description> Overridable method. Should return how many times this audio stream has looped. Most built-in playbacks always return [code]0[/code]. </description> </method> <method name="_get_parameter" qualifiers="virtual const"> <return type="Variant" /> <param index="0" name="name" type="StringName" /> <description> Return the current value of a playback parameter by name (see [method AudioStream._get_parameter_list]). </description> </method> <method name="_get_playback_position" qualifiers="virtual const"> <return type="float" /> <description> Overridable method. Should return the current progress along the audio stream, in seconds. </description> </method> <method name="_is_playing" qualifiers="virtual const"> <return type="bool" /> <description> Overridable method. Should return [code]true[/code] if this playback is active and playing its audio stream. </description> </method> <method name="_mix" qualifiers="virtual"> <return type="int" /> <param index="0" name="buffer" type="AudioFrame*" /> <param index="1" name="rate_scale" type="float" /> <param index="2" name="frames" type="int" /> <description> Override this method to customize how the audio stream is mixed. This method is called even if the playback is not active. [b]Note:[/b] It is not useful to override this method in GDScript or C#. Only GDExtension can take advantage of it. </description> </method> <method name="_seek" qualifiers="virtual"> <return type="void" /> <param index="0" name="position" type="float" /> <description> Override this method to customize what happens when seeking this audio stream at the given [param position], such as by calling [method AudioStreamPlayer.seek]. </description> </method> <method name="_set_parameter" qualifiers="virtual"> <return type="void" /> <param index="0" name="name" type="StringName" /> <param index="1" name="value" type="Variant" /> <description> Set the current value of a playback parameter by name (see [method AudioStream._get_parameter_list]). </description> </method> <method name="_start" qualifiers="virtual"> <return type="void" /> <param index="0" name="from_pos" type="float" /> <description> Override this method to customize what happens when the playback starts at the given position, such as by calling [method AudioStreamPlayer.play]. </description> </method> <method name="_stop" qualifiers="virtual"> <return type="void" /> <description> Override this method to customize what happens when the playback is stopped, such as by calling [method AudioStreamPlayer.stop]. </description> </method> <method name="_tag_used_streams" qualifiers="virtual"> <return type="void" /> <description> Overridable method. Called whenever the audio stream is mixed if the playback is active and [method AudioServer.set_enable_tagging_used_audio_streams] has been set to [code]true[/code]. Editor plugins may use this method to "tag" the current position along the audio stream and display it in a preview. </description> </method> </methods> </class>