summaryrefslogtreecommitdiff
path: root/doc/classes/AudioStreamPlayer.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/AudioStreamPlayer.xml')
-rw-r--r--doc/classes/AudioStreamPlayer.xml156
1 files changed, 156 insertions, 0 deletions
diff --git a/doc/classes/AudioStreamPlayer.xml b/doc/classes/AudioStreamPlayer.xml
new file mode 100644
index 0000000000..edf5dd619b
--- /dev/null
+++ b/doc/classes/AudioStreamPlayer.xml
@@ -0,0 +1,156 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<class name="AudioStreamPlayer" inherits="Node" category="Core" version="3.0.alpha.custom_build">
+ <brief_description>
+ Plays back audio.
+ </brief_description>
+ <description>
+ Plays background audio.
+ </description>
+ <tutorials>
+ </tutorials>
+ <demos>
+ </demos>
+ <methods>
+ <method name="get_bus" qualifiers="const">
+ <return type="String">
+ </return>
+ <description>
+ </description>
+ </method>
+ <method name="get_mix_target" qualifiers="const">
+ <return type="int" enum="AudioStreamPlayer.MixTarget">
+ </return>
+ <description>
+ </description>
+ </method>
+ <method name="get_pos">
+ <return type="float">
+ </return>
+ <description>
+ </description>
+ </method>
+ <method name="get_stream" qualifiers="const">
+ <return type="AudioStream">
+ </return>
+ <description>
+ </description>
+ </method>
+ <method name="get_volume_db" qualifiers="const">
+ <return type="float">
+ </return>
+ <description>
+ </description>
+ </method>
+ <method name="is_autoplay_enabled">
+ <return type="bool">
+ </return>
+ <description>
+ </description>
+ </method>
+ <method name="is_playing" qualifiers="const">
+ <return type="bool">
+ </return>
+ <description>
+ </description>
+ </method>
+ <method name="play">
+ <return type="void">
+ </return>
+ <argument index="0" name="from_pos" type="float" default="0.0">
+ </argument>
+ <description>
+ Plays the audio from the given position 'from_pos', in seconds.
+ </description>
+ </method>
+ <method name="seek">
+ <return type="void">
+ </return>
+ <argument index="0" name="to_pos" type="float">
+ </argument>
+ <description>
+ Sets the position from which audio will be played, in seconds.
+ </description>
+ </method>
+ <method name="set_autoplay">
+ <return type="void">
+ </return>
+ <argument index="0" name="enable" type="bool">
+ </argument>
+ <description>
+ </description>
+ </method>
+ <method name="set_bus">
+ <return type="void">
+ </return>
+ <argument index="0" name="bus" type="String">
+ </argument>
+ <description>
+ </description>
+ </method>
+ <method name="set_mix_target">
+ <return type="void">
+ </return>
+ <argument index="0" name="mix_target" type="int" enum="AudioStreamPlayer.MixTarget">
+ </argument>
+ <description>
+ </description>
+ </method>
+ <method name="set_stream">
+ <return type="void">
+ </return>
+ <argument index="0" name="stream" type="AudioStream">
+ </argument>
+ <description>
+ </description>
+ </method>
+ <method name="set_volume_db">
+ <return type="void">
+ </return>
+ <argument index="0" name="volume_db" type="float">
+ </argument>
+ <description>
+ </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">
+ </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">
+ </constant>
+ <constant name="MIX_TARGET_SURROUND" value="1">
+ </constant>
+ <constant name="MIX_TARGET_CENTER" value="2">
+ </constant>
+ </constants>
+</class>