2017-09-12 22:42:36 +02:00
|
|
|
<?xml version="1.0" encoding="UTF-8" ?>
|
2021-03-23 13:40:34 +01:00
|
|
|
<class name="AudioStreamPlayer" inherits="Node" version="3.3">
|
2017-09-12 22:42:36 +02:00
|
|
|
<brief_description>
|
2019-06-22 01:04:47 +02:00
|
|
|
Plays back audio non-positionally.
|
2017-09-12 22:42:36 +02:00
|
|
|
</brief_description>
|
|
|
|
<description>
|
2019-06-22 01:04:47 +02:00
|
|
|
Plays an audio stream non-positionally.
|
2021-05-05 20:37:35 +02:00
|
|
|
To play audio positionally, use [AudioStreamPlayer2D] or [AudioStreamPlayer3D] instead of [AudioStreamPlayer].
|
2017-09-12 22:42:36 +02:00
|
|
|
</description>
|
|
|
|
<tutorials>
|
2021-03-26 10:43:43 +01:00
|
|
|
<link title="Audio streams">https://docs.godotengine.org/en/3.3/tutorials/audio/audio_streams.html</link>
|
2020-10-01 10:34:47 +02:00
|
|
|
<link title="2D Dodge The Creeps Demo">https://godotengine.org/asset-library/asset/515</link>
|
|
|
|
<link title="Audio Device Changer Demo">https://godotengine.org/asset-library/asset/525</link>
|
|
|
|
<link title="Audio Generator Demo">https://godotengine.org/asset-library/asset/526</link>
|
|
|
|
<link title="Audio Mic Record Demo">https://godotengine.org/asset-library/asset/527</link>
|
|
|
|
<link title="Audio Spectrum Demo">https://godotengine.org/asset-library/asset/528</link>
|
2017-09-12 22:42:36 +02:00
|
|
|
</tutorials>
|
|
|
|
<methods>
|
2017-09-21 05:31:36 +02:00
|
|
|
<method name="get_playback_position">
|
2017-09-12 22:42:36 +02:00
|
|
|
<return type="float">
|
|
|
|
</return>
|
|
|
|
<description>
|
2018-07-31 21:20:27 +02:00
|
|
|
Returns the position in the [AudioStream] in seconds.
|
2017-09-12 22:42:36 +02:00
|
|
|
</description>
|
|
|
|
</method>
|
2019-04-15 14:49:41 +02:00
|
|
|
<method name="get_stream_playback">
|
|
|
|
<return type="AudioStreamPlayback">
|
|
|
|
</return>
|
|
|
|
<description>
|
2020-01-08 22:51:16 +01:00
|
|
|
Returns the [AudioStreamPlayback] object associated with this [AudioStreamPlayer].
|
2019-04-15 14:49:41 +02:00
|
|
|
</description>
|
|
|
|
</method>
|
2017-09-12 22:42:36 +02:00
|
|
|
<method name="play">
|
|
|
|
<return type="void">
|
|
|
|
</return>
|
2017-09-10 15:37:49 +02:00
|
|
|
<argument index="0" name="from_position" type="float" default="0.0">
|
2017-09-12 22:42:36 +02:00
|
|
|
</argument>
|
|
|
|
<description>
|
2019-06-22 01:04:47 +02:00
|
|
|
Plays the audio from the given [code]from_position[/code], in seconds.
|
2017-09-12 22:42:36 +02:00
|
|
|
</description>
|
|
|
|
</method>
|
|
|
|
<method name="seek">
|
|
|
|
<return type="void">
|
|
|
|
</return>
|
2017-09-10 15:37:49 +02:00
|
|
|
<argument index="0" name="to_position" type="float">
|
2017-09-12 22:42:36 +02:00
|
|
|
</argument>
|
|
|
|
<description>
|
2017-09-16 20:09:29 +02:00
|
|
|
Sets the position from which audio will be played, in seconds.
|
2017-09-12 22:42:36 +02:00
|
|
|
</description>
|
|
|
|
</method>
|
|
|
|
<method name="stop">
|
|
|
|
<return type="void">
|
|
|
|
</return>
|
|
|
|
<description>
|
2017-09-16 20:09:29 +02:00
|
|
|
Stops the audio.
|
2017-09-12 22:42:36 +02:00
|
|
|
</description>
|
|
|
|
</method>
|
|
|
|
</methods>
|
|
|
|
<members>
|
2019-06-29 12:38:01 +02:00
|
|
|
<member name="autoplay" type="bool" setter="set_autoplay" getter="is_autoplay_enabled" default="false">
|
2019-06-29 15:24:23 +02:00
|
|
|
If [code]true[/code], audio plays when added to scene tree.
|
2017-09-12 22:42:36 +02:00
|
|
|
</member>
|
2019-06-29 12:38:01 +02:00
|
|
|
<member name="bus" type="String" setter="set_bus" getter="get_bus" default=""Master"">
|
2017-09-16 20:09:29 +02:00
|
|
|
Bus on which this audio is playing.
|
2017-09-12 22:42:36 +02:00
|
|
|
</member>
|
2019-06-29 12:38:01 +02:00
|
|
|
<member name="mix_target" type="int" setter="set_mix_target" getter="get_mix_target" enum="AudioStreamPlayer.MixTarget" default="0">
|
2019-12-06 23:09:20 +01:00
|
|
|
If the audio configuration has more than two speakers, this sets the target channels. See [enum MixTarget] constants.
|
2017-09-12 22:42:36 +02:00
|
|
|
</member>
|
2019-06-29 12:38:01 +02:00
|
|
|
<member name="pitch_scale" type="float" setter="set_pitch_scale" getter="get_pitch_scale" default="1.0">
|
2020-04-26 16:37:22 +02:00
|
|
|
The pitch and the tempo of the audio, as a multiplier of the audio sample's sample rate.
|
2018-02-19 10:47:16 +01:00
|
|
|
</member>
|
2019-06-29 12:38:01 +02:00
|
|
|
<member name="playing" type="bool" setter="_set_playing" getter="is_playing" default="false">
|
2018-12-20 13:46:54 +01:00
|
|
|
If [code]true[/code], audio is playing.
|
2017-09-12 22:42:36 +02:00
|
|
|
</member>
|
2019-07-15 20:42:47 +02:00
|
|
|
<member name="stream" type="AudioStream" setter="set_stream" getter="get_stream">
|
2017-09-16 20:09:29 +02:00
|
|
|
The [AudioStream] object to be played.
|
2017-09-12 22:42:36 +02:00
|
|
|
</member>
|
2019-06-29 12:38:01 +02:00
|
|
|
<member name="stream_paused" type="bool" setter="set_stream_paused" getter="get_stream_paused" default="false">
|
2020-01-08 22:51:16 +01:00
|
|
|
If [code]true[/code], the playback is paused. You can resume it by setting [code]stream_paused[/code] to [code]false[/code].
|
2018-07-26 11:56:21 +02:00
|
|
|
</member>
|
2019-06-29 12:38:01 +02:00
|
|
|
<member name="volume_db" type="float" setter="set_volume_db" getter="get_volume_db" default="0.0">
|
2017-09-16 20:09:29 +02:00
|
|
|
Volume of sound, in dB.
|
2017-09-12 22:42:36 +02:00
|
|
|
</member>
|
|
|
|
</members>
|
|
|
|
<signals>
|
|
|
|
<signal name="finished">
|
|
|
|
<description>
|
2017-09-16 20:09:29 +02:00
|
|
|
Emitted when the audio stops playing.
|
2017-09-12 22:42:36 +02:00
|
|
|
</description>
|
|
|
|
</signal>
|
|
|
|
</signals>
|
|
|
|
<constants>
|
2017-11-24 23:16:30 +01:00
|
|
|
<constant name="MIX_TARGET_STEREO" value="0" enum="MixTarget">
|
2017-10-10 16:00:10 +02:00
|
|
|
The audio will be played only on the first channel.
|
2017-09-16 01:46:14 +02:00
|
|
|
</constant>
|
2017-11-24 23:16:30 +01:00
|
|
|
<constant name="MIX_TARGET_SURROUND" value="1" enum="MixTarget">
|
2017-10-10 16:00:10 +02:00
|
|
|
The audio will be played on all surround channels.
|
2017-09-16 01:46:14 +02:00
|
|
|
</constant>
|
2017-11-24 23:16:30 +01:00
|
|
|
<constant name="MIX_TARGET_CENTER" value="2" enum="MixTarget">
|
2017-10-10 16:00:10 +02:00
|
|
|
The audio will be played on the second channel, which is usually the center.
|
2017-09-16 01:46:14 +02:00
|
|
|
</constant>
|
2017-09-12 22:42:36 +02:00
|
|
|
</constants>
|
|
|
|
</class>
|