godot/doc/classes/AudioStreamPlayer.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioStreamPlayer" inherits="Node" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		Plays back audio non-positionally.
	</brief_description>
	<description>
		Plays an audio stream non-positionally.
		To play audio positionally, use [AudioStreamPlayer2D] or [AudioStreamPlayer3D] instead of [AudioStreamPlayer].
	</description>
	<tutorials>
		<link title="Audio streams">$DOCS_URL/tutorials/audio/audio_streams.html</link>
		<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>
	</tutorials>
	<methods>
		<method name="get_playback_position">
			<return type="float" />
			<description>
				Returns the position in the [AudioStream] in seconds.
			</description>
		</method>
		<method name="get_stream_playback">
			<return type="AudioStreamPlayback" />
			<description>
				Returns the [AudioStreamPlayback] object associated with this [AudioStreamPlayer].
			</description>
		</method>
		<method name="play">
			<return type="void" />
			<argument index="0" name="from_position" type="float" default="0.0" />
			<description>
				Plays the audio from the given [code]from_position[/code], in seconds.
			</description>
		</method>
		<method name="seek">
			<return type="void" />
			<argument index="0" name="to_position" type="float" />
			<description>
				Sets the position from which audio will be played, in seconds.
			</description>
		</method>
		<method name="stop">
			<return type="void" />
			<description>
				Stops the audio.
			</description>
		</method>
	</methods>
	<members>
		<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="StringName" setter="set_bus" getter="get_bus" default="&amp;&quot;Master&quot;">
			Bus on which this audio is playing.
		</member>
		<member name="max_polyphony" type="int" setter="set_max_polyphony" getter="get_max_polyphony" default="1">
			The maximum number of sounds this node can play at the same time. Playing additional sounds after this value is reached will cut off the oldest sounds.
		</member>
		<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 [enum MixTarget] constants.
		</member>
		<member name="pitch_scale" type="float" setter="set_pitch_scale" getter="get_pitch_scale" default="1.0">
			The pitch and the tempo of the audio, as a multiplier of the audio sample's sample rate.
		</member>
		<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">
			The [AudioStream] object to be played.
		</member>
		<member name="stream_paused" type="bool" setter="set_stream_paused" getter="get_stream_paused" default="false">
			If [code]true[/code], the playback is paused. You can resume it by setting [code]stream_paused[/code] to [code]false[/code].
		</member>
		<member name="volume_db" type="float" setter="set_volume_db" getter="get_volume_db" default="0.0">
			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>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`<?xml version="1.0" encoding="UTF-8" ?>`
Add an XML schema for documentation This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions. 2022-02-14 21:18:53 +08:00			`<class name="AudioStreamPlayer" inherits="Node" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`<brief_description>`
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies 2019-06-22 07:04:47 +08:00			`Plays back audio non-positionally.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`</brief_description>`
			`<description>`
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies 2019-06-22 07:04:47 +08:00			`Plays an audio stream non-positionally.`
Improve the AudioStreamPlayer(2D/3D) class descriptions 2021-05-06 02:37:35 +08:00			`To play audio positionally, use [AudioStreamPlayer2D] or [AudioStreamPlayer3D] instead of [AudioStreamPlayer].`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`</description>`
			`<tutorials>`
Replace Godot docs URL with `$DOCS_URL` in XML class reference 2021-11-15 17:43:07 +08:00			`<link title="Audio streams">$DOCS_URL/tutorials/audio/audio_streams.html</link>`
Link to demos from within the class reference 2020-10-01 16:34:47 +08: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>`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`</tutorials>`
			`<methods>`
Rename get_position => get_playback_position and seek_pos => seek on audio classes 2017-09-21 11:31:36 +08:00			`<method name="get_playback_position">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. 2021-07-30 21:28:05 +08:00			`<return type="float" />`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`<description>`
Added description and measurement 2018-08-01 03:20:27 +08:00			`Returns the position in the [AudioStream] in seconds.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`</description>`
			`</method>`
doc: Sync classref with current source 2019-04-15 20:49:41 +08:00			`<method name="get_stream_playback">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. 2021-07-30 21:28:05 +08:00			`<return type="AudioStreamPlayback" />`
doc: Sync classref with current source 2019-04-15 20:49:41 +08:00			`<description>`
Complete documentation of various classes 2020-01-09 05:51:16 +08:00			`Returns the [AudioStreamPlayback] object associated with this [AudioStreamPlayer].`
doc: Sync classref with current source 2019-04-15 20:49:41 +08:00			`</description>`
			`</method>`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`<method name="play">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. 2021-07-30 21:28:05 +08:00			`<return type="void" />`
			`<argument index="0" name="from_position" type="float" default="0.0" />`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`<description>`
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies 2019-06-22 07:04:47 +08:00			`Plays the audio from the given [code]from_position[/code], in seconds.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`</description>`
			`</method>`
			`<method name="seek">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. 2021-07-30 21:28:05 +08:00			`<return type="void" />`
			`<argument index="0" name="to_position" type="float" />`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`<description>`
Added Documentation of AudioStreamPlayer Fixed according to Comments autoplay issue fixed 2017-09-17 02:09:29 +08:00			`Sets the position from which audio will be played, in seconds.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`</description>`
			`</method>`
			`<method name="stop">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. 2021-07-30 21:28:05 +08:00			`<return type="void" />`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`<description>`
Added Documentation of AudioStreamPlayer Fixed according to Comments autoplay issue fixed 2017-09-17 02:09:29 +08:00			`Stops the audio.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`</description>`
			`</method>`
			`</methods>`
			`<members>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 18:38:01 +08:00			`<member name="autoplay" type="bool" setter="set_autoplay" getter="is_autoplay_enabled" default="false">`
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool. 2019-06-29 21:24:23 +08:00			`If [code]true[/code], audio plays when added to scene tree.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`</member>`
Let var2str display StringName with correct sigil 2021-06-06 03:24:24 +08:00			`<member name="bus" type="StringName" setter="set_bus" getter="get_bus" default="&"Master"">`
Added Documentation of AudioStreamPlayer Fixed according to Comments autoplay issue fixed 2017-09-17 02:09:29 +08:00			`Bus on which this audio is playing.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`</member>`
Add polyphony to Audio Stream Player nodes 2021-08-28 12:51:03 +08:00			`<member name="max_polyphony" type="int" setter="set_max_polyphony" getter="get_max_polyphony" default="1">`
			`The maximum number of sounds this node can play at the same time. Playing additional sounds after this value is reached will cut off the oldest sounds.`
			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 18:38:01 +08:00			`<member name="mix_target" type="int" setter="set_mix_target" getter="get_mix_target" enum="AudioStreamPlayer.MixTarget" default="0">`
doc: Markup fixes for enums and constants 2019-12-07 06:09:20 +08:00			`If the audio configuration has more than two speakers, this sets the target channels. See [enum MixTarget] constants.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 18:38:01 +08:00			`<member name="pitch_scale" type="float" setter="set_pitch_scale" getter="get_pitch_scale" default="1.0">`
Improve `pitch_scale` descriptions in AudioStreamPlayer documentation This closes #29439. Co-authored-by: Cheeseness <contact@jbushproductions.com> 2020-04-26 22:37:22 +08:00			`The pitch and the tempo of the audio, as a multiplier of the audio sample's sample rate.`
doc: Sync classref with current source 2018-02-19 17:47:16 +08:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 18:38:01 +08:00			`<member name="playing" type="bool" setter="_set_playing" getter="is_playing" default="false">`
doc: Add missing commas after "If true/false" 2018-12-20 20:46:54 +08:00			`If [code]true[/code], audio is playing.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`</member>`
doc: Sync classref with current source 2019-07-16 02:42:47 +08:00			`<member name="stream" type="AudioStream" setter="set_stream" getter="get_stream">`
Added Documentation of AudioStreamPlayer Fixed according to Comments autoplay issue fixed 2017-09-17 02:09:29 +08:00			`The [AudioStream] object to be played.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 18:38:01 +08:00			`<member name="stream_paused" type="bool" setter="set_stream_paused" getter="get_stream_paused" default="false">`
Complete documentation of various classes 2020-01-09 05:51:16 +08:00			`If [code]true[/code], the playback is paused. You can resume it by setting [code]stream_paused[/code] to [code]false[/code].`
doc: Sync classref with current source Fix various missing arguments in bindings. 2018-07-26 17:56:21 +08:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 18:38:01 +08:00			`<member name="volume_db" type="float" setter="set_volume_db" getter="get_volume_db" default="0.0">`
Added Documentation of AudioStreamPlayer Fixed according to Comments autoplay issue fixed 2017-09-17 02:09:29 +08:00			`Volume of sound, in dB.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`</member>`
			`</members>`
			`<signals>`
			`<signal name="finished">`
			`<description>`
Added Documentation of AudioStreamPlayer Fixed according to Comments autoplay issue fixed 2017-09-17 02:09:29 +08:00			`Emitted when the audio stops playing.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`</description>`
			`</signal>`
			`</signals>`
			`<constants>`
doc: Fix enum tags thanks to 2bc6db6 2017-11-25 06:16:30 +08:00			`<constant name="MIX_TARGET_STEREO" value="0" enum="MixTarget">`
updated AudioStream docs and added AudioServer docs 2017-10-10 22:00:10 +08:00			`The audio will be played only on the first channel.`
doc: Sync classref with current source [ci skip] 2017-09-16 07:46:14 +08:00			`</constant>`
doc: Fix enum tags thanks to 2bc6db6 2017-11-25 06:16:30 +08:00			`<constant name="MIX_TARGET_SURROUND" value="1" enum="MixTarget">`
updated AudioStream docs and added AudioServer docs 2017-10-10 22:00:10 +08:00			`The audio will be played on all surround channels.`
doc: Sync classref with current source [ci skip] 2017-09-16 07:46:14 +08:00			`</constant>`
doc: Fix enum tags thanks to 2bc6db6 2017-11-25 06:16:30 +08:00			`<constant name="MIX_TARGET_CENTER" value="2" enum="MixTarget">`
updated AudioStream docs and added AudioServer docs 2017-10-10 22:00:10 +08:00			`The audio will be played on the second channel, which is usually the center.`
doc: Sync classref with current source [ci skip] 2017-09-16 07:46:14 +08:00			`</constant>`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`</constants>`
			`</class>`