virtualx-engine/doc/classes/AudioStreamPlayer3D.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioStreamPlayer3D" inherits="Spatial" category="Core" version="3.0.alpha.custom_build">
	<brief_description>
	</brief_description>
	<description>
	</description>
	<tutorials>
	</tutorials>
	<demos>
	</demos>
	<methods>
		<method name="get_area_mask" qualifiers="const">
			<return type="int">
			</return>
			<description>
			</description>
		</method>
		<method name="get_attenuation_filter_cutoff_hz" qualifiers="const">
			<return type="float">
			</return>
			<description>
			</description>
		</method>
		<method name="get_attenuation_filter_db" qualifiers="const">
			<return type="float">
			</return>
			<description>
			</description>
		</method>
		<method name="get_attenuation_model" qualifiers="const">
			<return type="int" enum="AudioStreamPlayer3D.AttenuationModel">
			</return>
			<description>
			</description>
		</method>
		<method name="get_bus" qualifiers="const">
			<return type="String">
			</return>
			<description>
			</description>
		</method>
		<method name="get_doppler_tracking" qualifiers="const">
			<return type="int" enum="AudioStreamPlayer3D.DopplerTracking">
			</return>
			<description>
			</description>
		</method>
		<method name="get_emission_angle" qualifiers="const">
			<return type="float">
			</return>
			<description>
			</description>
		</method>
		<method name="get_emission_angle_filter_attenuation_db" qualifiers="const">
			<return type="float">
			</return>
			<description>
			</description>
		</method>
		<method name="get_max_db" qualifiers="const">
			<return type="float">
			</return>
			<description>
			</description>
		</method>
		<method name="get_max_distance" qualifiers="const">
			<return type="float">
			</return>
			<description>
			</description>
		</method>
		<method name="get_out_of_range_mode" qualifiers="const">
			<return type="int" enum="AudioStreamPlayer3D.OutOfRangeMode">
			</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_unit_db" qualifiers="const">
			<return type="float">
			</return>
			<description>
			</description>
		</method>
		<method name="get_unit_size" qualifiers="const">
			<return type="float">
			</return>
			<description>
			</description>
		</method>
		<method name="is_autoplay_enabled">
			<return type="bool">
			</return>
			<description>
			</description>
		</method>
		<method name="is_emission_angle_enabled" qualifiers="const">
			<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>
			</description>
		</method>
		<method name="seek">
			<return type="void">
			</return>
			<argument index="0" name="to_pos" type="float">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_area_mask">
			<return type="void">
			</return>
			<argument index="0" name="mask" type="int">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_attenuation_filter_cutoff_hz">
			<return type="void">
			</return>
			<argument index="0" name="degrees" type="float">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_attenuation_filter_db">
			<return type="void">
			</return>
			<argument index="0" name="db" type="float">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_attenuation_model">
			<return type="void">
			</return>
			<argument index="0" name="model" type="int" enum="AudioStreamPlayer3D.AttenuationModel">
			</argument>
			<description>
			</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_doppler_tracking">
			<return type="void">
			</return>
			<argument index="0" name="mode" type="int" enum="AudioStreamPlayer3D.DopplerTracking">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_emission_angle">
			<return type="void">
			</return>
			<argument index="0" name="degrees" type="float">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_emission_angle_enabled">
			<return type="void">
			</return>
			<argument index="0" name="enabled" type="bool">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_emission_angle_filter_attenuation_db">
			<return type="void">
			</return>
			<argument index="0" name="db" type="float">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_max_db">
			<return type="void">
			</return>
			<argument index="0" name="max_db" type="float">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_max_distance">
			<return type="void">
			</return>
			<argument index="0" name="metres" type="float">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_out_of_range_mode">
			<return type="void">
			</return>
			<argument index="0" name="mode" type="int" enum="AudioStreamPlayer3D.OutOfRangeMode">
			</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_unit_db">
			<return type="void">
			</return>
			<argument index="0" name="unit_db" type="float">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_unit_size">
			<return type="void">
			</return>
			<argument index="0" name="unit_size" type="float">
			</argument>
			<description>
			</description>
		</method>
		<method name="stop">
			<return type="void">
			</return>
			<description>
			</description>
		</method>
	</methods>
	<members>
		<member name="area_mask" type="int" setter="set_area_mask" getter="get_area_mask">
		</member>
		<member name="attenuation_filter_cutoff_hz" type="float" setter="set_attenuation_filter_cutoff_hz" getter="get_attenuation_filter_cutoff_hz">
		</member>
		<member name="attenuation_filter_db" type="float" setter="set_attenuation_filter_db" getter="get_attenuation_filter_db">
		</member>
		<member name="attenuation_model" type="int" setter="set_attenuation_model" getter="get_attenuation_model" enum="AudioStreamPlayer3D.AttenuationModel">
		</member>
		<member name="autoplay" type="bool" setter="set_autoplay" getter="is_autoplay_enabled">
		</member>
		<member name="bus" type="String" setter="set_bus" getter="get_bus">
		</member>
		<member name="doppler_tracking" type="int" setter="set_doppler_tracking" getter="get_doppler_tracking" enum="AudioStreamPlayer3D.DopplerTracking">
		</member>
		<member name="emission_angle_degrees" type="float" setter="set_emission_angle" getter="get_emission_angle">
		</member>
		<member name="emission_angle_enabled" type="bool" setter="set_emission_angle_enabled" getter="is_emission_angle_enabled">
		</member>
		<member name="emission_angle_filter_attenuation_db" type="float" setter="set_emission_angle_filter_attenuation_db" getter="get_emission_angle_filter_attenuation_db">
		</member>
		<member name="max_db" type="float" setter="set_max_db" getter="get_max_db">
		</member>
		<member name="max_distance" type="float" setter="set_max_distance" getter="get_max_distance">
		</member>
		<member name="out_of_range_mode" type="int" setter="set_out_of_range_mode" getter="get_out_of_range_mode" enum="AudioStreamPlayer3D.OutOfRangeMode">
		</member>
		<member name="playing" type="bool" setter="_set_playing" getter="is_playing">
		</member>
		<member name="stream" type="AudioStream" setter="set_stream" getter="get_stream">
		</member>
		<member name="unit_db" type="float" setter="set_unit_db" getter="get_unit_db">
		</member>
		<member name="unit_size" type="float" setter="set_unit_size" getter="get_unit_size">
		</member>
	</members>
	<signals>
		<signal name="finished">
			<description>
			</description>
		</signal>
	</signals>
	<constants>
		<constant name="ATTENUATION_INVERSE_DISTANCE" value="0">
		</constant>
		<constant name="ATTENUATION_INVERSE_SQUARE_DISTANCE" value="1">
		</constant>
		<constant name="ATTENUATION_LOGARITHMIC" value="2">
		</constant>
		<constant name="OUT_OF_RANGE_MIX" value="0">
		</constant>
		<constant name="OUT_OF_RANGE_PAUSE" value="1">
		</constant>
		<constant name="DOPPLER_TRACKING_DISABLED" value="0">
		</constant>
		<constant name="DOPPLER_TRACKING_IDLE_STEP" value="1">
		</constant>
		<constant name="DOPPLER_TRACKING_FIXED_STEP" value="2">
		</constant>
	</constants>
</class>