virtualx-engine/doc/classes/AudioStreamPlayer2D.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioStreamPlayer2D" inherits="Node2D" category="Core" version="3.1-dev">
	<brief_description>
		Plays audio in 2D.
	</brief_description>
	<description>
		Plays audio that dampens with distance from screen center.
	</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="area_mask" type="int" setter="set_area_mask" getter="get_area_mask">
			Areas in which this sound plays.
		</member>
		<member name="attenuation" type="float" setter="set_attenuation" getter="get_attenuation">
			Dampens audio over distance with this as an exponent.
		</member>
		<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="max_distance" type="float" setter="set_max_distance" getter="get_max_distance">
			Maximum distance from which audio is still hearable.
		</member>
		<member name="pitch_scale" type="float" setter="set_pitch_scale" getter="get_pitch_scale">
		</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">
			Base volume without dampening.
		</member>
	</members>
	<signals>
		<signal name="finished">
			<description>
				Emitted when the audio stops playing.
			</description>
		</signal>
	</signals>
	<constants>
	</constants>
</class>