90 lines
3 KiB
XML
90 lines
3 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="AudioStreamPlayer" inherits="Node" category="Core" version="3.1">
|
|
<brief_description>
|
|
Plays back audio.
|
|
</brief_description>
|
|
<description>
|
|
Plays background audio.
|
|
</description>
|
|
<tutorials>
|
|
http://docs.godotengine.org/en/latest/learning/features/audio/index.html
|
|
http://docs.godotengine.org/en/3.0/tutorials/audio/audio_streams.html
|
|
</tutorials>
|
|
<demos>
|
|
</demos>
|
|
<methods>
|
|
<method name="get_playback_position">
|
|
<return type="float">
|
|
</return>
|
|
<description>
|
|
Returns the position in the [AudioStream].
|
|
</description>
|
|
</method>
|
|
<method name="play">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="from_position" type="float" default="0.0">
|
|
</argument>
|
|
<description>
|
|
Plays the audio from the given position 'from_position', in seconds.
|
|
</description>
|
|
</method>
|
|
<method name="seek">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="to_position" type="float">
|
|
</argument>
|
|
<description>
|
|
Sets the position from which audio will be played, in seconds.
|
|
</description>
|
|
</method>
|
|
<method name="stop">
|
|
<return type="void">
|
|
</return>
|
|
<description>
|
|
Stops the audio.
|
|
</description>
|
|
</method>
|
|
</methods>
|
|
<members>
|
|
<member name="autoplay" type="bool" setter="set_autoplay" getter="is_autoplay_enabled">
|
|
If [code]true[/code] audio plays when added to scene tree. Default value: [code]false[/code].
|
|
</member>
|
|
<member name="bus" type="String" setter="set_bus" getter="get_bus">
|
|
Bus on which this audio is playing.
|
|
</member>
|
|
<member name="mix_target" type="int" setter="set_mix_target" getter="get_mix_target" enum="AudioStreamPlayer.MixTarget">
|
|
If the audio configuration has more than two speakers, this sets the target channels. See [code]MIX_TARGET_*[/code] constants.
|
|
</member>
|
|
<member name="pitch_scale" type="float" setter="set_pitch_scale" getter="get_pitch_scale">
|
|
Changes the pitch and the tempo of the audio.
|
|
</member>
|
|
<member name="playing" type="bool" setter="_set_playing" getter="is_playing">
|
|
If [code]true[/code] audio is playing.
|
|
</member>
|
|
<member name="stream" type="AudioStream" setter="set_stream" getter="get_stream">
|
|
The [AudioStream] object to be played.
|
|
</member>
|
|
<member name="volume_db" type="float" setter="set_volume_db" getter="get_volume_db">
|
|
Volume of sound, in dB.
|
|
</member>
|
|
</members>
|
|
<signals>
|
|
<signal name="finished">
|
|
<description>
|
|
Emitted when the audio stops playing.
|
|
</description>
|
|
</signal>
|
|
</signals>
|
|
<constants>
|
|
<constant name="MIX_TARGET_STEREO" value="0" enum="MixTarget">
|
|
The audio will be played only on the first channel.
|
|
</constant>
|
|
<constant name="MIX_TARGET_SURROUND" value="1" enum="MixTarget">
|
|
The audio will be played on all surround channels.
|
|
</constant>
|
|
<constant name="MIX_TARGET_CENTER" value="2" enum="MixTarget">
|
|
The audio will be played on the second channel, which is usually the center.
|
|
</constant>
|
|
</constants>
|
|
</class>
|