diff options
Diffstat (limited to 'doc/classes/AudioStreamPlayer.xml')
| -rw-r--r-- | doc/classes/AudioStreamPlayer.xml | 26 |
1 files changed, 12 insertions, 14 deletions
diff --git a/doc/classes/AudioStreamPlayer.xml b/doc/classes/AudioStreamPlayer.xml index 1681d796ea..92f3a9bd73 100644 --- a/doc/classes/AudioStreamPlayer.xml +++ b/doc/classes/AudioStreamPlayer.xml @@ -1,16 +1,14 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="AudioStreamPlayer" inherits="Node" category="Core" version="3.2"> <brief_description> - Plays back audio. + Plays back audio non-positionally. </brief_description> <description> - Plays background audio. + Plays an audio stream non-positionally. </description> <tutorials> <link>https://docs.godotengine.org/en/latest/tutorials/audio/audio_streams.html</link> </tutorials> - <demos> - </demos> <methods> <method name="get_playback_position"> <return type="float"> @@ -31,7 +29,7 @@ <argument index="0" name="from_position" type="float" default="0.0"> </argument> <description> - Plays the audio from the given position 'from_position', in seconds. + Plays the audio from the given [code]from_position[/code], in seconds. </description> </method> <method name="seek"> @@ -52,27 +50,27 @@ </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 name="autoplay" type="bool" setter="set_autoplay" getter="is_autoplay_enabled" default="false"> + If [code]true[/code], audio plays when added to scene tree. </member> - <member name="bus" type="String" setter="set_bus" getter="get_bus"> + <member name="bus" type="String" setter="set_bus" getter="get_bus" default=""Master""> 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 name="mix_target" type="int" setter="set_mix_target" getter="get_mix_target" enum="AudioStreamPlayer.MixTarget" default="0"> 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"> + <member name="pitch_scale" type="float" setter="set_pitch_scale" getter="get_pitch_scale" default="1.0"> Changes the pitch and the tempo of the audio. </member> - <member name="playing" type="bool" setter="_set_playing" getter="is_playing"> + <member name="playing" type="bool" setter="_set_playing" getter="is_playing" default="false"> If [code]true[/code], audio is playing. </member> - <member name="stream" type="AudioStream" setter="set_stream" getter="get_stream"> + <member name="stream" type="AudioStream" setter="set_stream" getter="get_stream" default="null"> The [AudioStream] object to be played. </member> - <member name="stream_paused" type="bool" setter="set_stream_paused" getter="get_stream_paused"> + <member name="stream_paused" type="bool" setter="set_stream_paused" getter="get_stream_paused" default="false"> </member> - <member name="volume_db" type="float" setter="set_volume_db" getter="get_volume_db"> + <member name="volume_db" type="float" setter="set_volume_db" getter="get_volume_db" default="0.0"> Volume of sound, in dB. </member> </members> |