asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
virtualx-engine/doc/classes/AudioStreamPlayer3D.xml

364 lines
11 KiB
XML
Raw Normal View History

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-12 22:42:36 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioStreamPlayer3D" inherits="Spatial" category="Core" version="3.0.alpha.custom_build">
<brief_description>
wrote documentation for audio stream player 3D
2017-09-16 13:33:58 +02:00
Plays 3D sound in 3D space
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-12 22:42:36 +02:00
</brief_description>
<description>
wrote documentation for audio stream player 3D
2017-09-16 13:33:58 +02:00
Plays a sound effect with directed sound effects, dampens with distance if needed, generates effect of hearable position in space.
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-12 22:42:36 +02:00
</description>
<tutorials>
wrote documentation for audio stream player 3D
2017-09-16 13:33:58 +02:00
http://docs.godotengine.org/en/latest/learning/features/audio/index.html
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-12 22:42:36 +02:00
</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>
Rename get_position => get_playback_position and seek_pos => seek on audio classes
2017-09-21 05:31:36 +02:00
<method name="get_playback_position">
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-12 22:42:36 +02:00
<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>
Rename pos to position in user facing methods and variables Rename user facing methods and variables as well as the corresponding C++ methods according to the folloming changes: * pos -> position * rot -> rotation * loc -> location C++ variables are left as is.
2017-09-10 15:37:49 +02:00
<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-12 22:42:36 +02:00
</argument>
<description>
Rename pos to position in user facing methods and variables Rename user facing methods and variables as well as the corresponding C++ methods according to the folloming changes: * pos -> position * rot -> rotation * loc -> location C++ variables are left as is.
2017-09-10 15:37:49 +02:00
Plays the audio from the given position 'from_position', 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-12 22:42:36 +02:00
</description>
</method>
<method name="seek">
<return type="void">
</return>
Rename pos to position in user facing methods and variables Rename user facing methods and variables as well as the corresponding C++ methods according to the folloming changes: * pos -> position * rot -> rotation * loc -> location C++ variables are left as is.
2017-09-10 15:37:49 +02:00
<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-12 22:42:36 +02:00
</argument>
<description>
wrote documentation for audio stream player 3D
2017-09-16 13:33:58 +02: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-12 22:42:36 +02:00
</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>
wrote documentation for audio stream player 3D
2017-09-16 13:33:58 +02: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-12 22:42:36 +02:00
</description>
</method>
</methods>
<members>
doc: Sync classref with current source [ci skip]
2017-09-13 08:49:40 +02:00
<member name="area_mask" type="int" setter="set_area_mask" getter="get_area_mask">
wrote documentation for audio stream player 3D
2017-09-16 13:33:58 +02:00
Areas in which this sound plays.
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-12 22:42:36 +02:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 08:49:40 +02:00
<member name="attenuation_filter_cutoff_hz" type="float" setter="set_attenuation_filter_cutoff_hz" getter="get_attenuation_filter_cutoff_hz">
wrote documentation for audio stream player 3D
2017-09-16 13:33:58 +02:00
Dampens audio above this frequency, in Hz.
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-12 22:42:36 +02:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 08:49:40 +02:00
<member name="attenuation_filter_db" type="float" setter="set_attenuation_filter_db" getter="get_attenuation_filter_db">
wrote documentation for audio stream player 3D
2017-09-16 13:33:58 +02:00
Amount how much the filter affects the loudness, 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-12 22:42:36 +02:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 08:49:40 +02:00
<member name="attenuation_model" type="int" setter="set_attenuation_model" getter="get_attenuation_model" enum="AudioStreamPlayer3D.AttenuationModel">
wrote documentation for audio stream player 3D
2017-09-16 13:33:58 +02:00
Decides if audio should get quieter with distance linearly, quadratically or logarithmically.
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-12 22:42:36 +02:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 08:49:40 +02:00
<member name="autoplay" type="bool" setter="set_autoplay" getter="is_autoplay_enabled">
wrote documentation for audio stream player 3D
2017-09-16 13:33:58 +02:00
If [code]true[/code], audio plays audio plays when added to scene tree. Default value: [code]false[/code].
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-12 22:42:36 +02:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 08:49:40 +02:00
<member name="bus" type="String" setter="set_bus" getter="get_bus">
wrote documentation for audio stream player 3D
2017-09-16 13:33:58 +02: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-12 22:42:36 +02:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 08:49:40 +02:00
<member name="doppler_tracking" type="int" setter="set_doppler_tracking" getter="get_doppler_tracking" enum="AudioStreamPlayer3D.DopplerTracking">
wrote documentation for audio stream player 3D
2017-09-16 13:33:58 +02:00
Decides in which step the Doppler effect should be calculated.
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-12 22:42:36 +02:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 08:49:40 +02:00
<member name="emission_angle_degrees" type="float" setter="set_emission_angle" getter="get_emission_angle">
wrote documentation for audio stream player 3D
2017-09-16 13:33:58 +02:00
The angle in which the audio reaches cameras undampened.
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-12 22:42:36 +02:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 08:49:40 +02:00
<member name="emission_angle_enabled" type="bool" setter="set_emission_angle_enabled" getter="is_emission_angle_enabled">
wrote documentation for audio stream player 3D
2017-09-16 13:33:58 +02:00
If [code]true[/code], the audio should be dampened according to the direction of the sound.
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-12 22:42:36 +02:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 08:49:40 +02:00
<member name="emission_angle_filter_attenuation_db" type="float" setter="set_emission_angle_filter_attenuation_db" getter="get_emission_angle_filter_attenuation_db">
wrote documentation for audio stream player 3D
2017-09-16 13:33:58 +02:00
dampens audio if camera is outside of 'emission_angle_degrees' and 'emission_angle_enabled' is set by this factor, 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-12 22:42:36 +02:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 08:49:40 +02:00
<member name="max_db" type="float" setter="set_max_db" getter="get_max_db">
wrote documentation for audio stream player 3D
2017-09-16 13:33:58 +02:00
Sets the absolute maximum of the soundlevel, 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-12 22:42:36 +02:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 08:49:40 +02:00
<member name="max_distance" type="float" setter="set_max_distance" getter="get_max_distance">
wrote documentation for audio stream player 3D
2017-09-16 13:33:58 +02:00
Sets the distance from wich the 'out_of_range_mode' takes effect. Has no effect if set to 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-12 22:42:36 +02:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 08:49:40 +02:00
<member name="out_of_range_mode" type="int" setter="set_out_of_range_mode" getter="get_out_of_range_mode" enum="AudioStreamPlayer3D.OutOfRangeMode">
wrote documentation for audio stream player 3D
2017-09-16 13:33:58 +02:00
Decides if audio should pause when source is outside of 'max_distance' range.
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-12 22:42:36 +02:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 20:56:01 +02:00
<member name="playing" type="bool" setter="_set_playing" getter="is_playing">
wrote documentation for audio stream player 3D
2017-09-16 13:33:58 +02: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-12 22:42:36 +02:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 08:49:40 +02:00
<member name="stream" type="AudioStream" setter="set_stream" getter="get_stream">
wrote documentation for audio stream player 3D
2017-09-16 13:33:58 +02: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-12 22:42:36 +02:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 08:49:40 +02:00
<member name="unit_db" type="float" setter="set_unit_db" getter="get_unit_db">
wrote documentation for audio stream player 3D
2017-09-16 13:33:58 +02:00
Base sound level unaffected by dampening, 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-12 22:42:36 +02:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 08:49:40 +02:00
<member name="unit_size" type="float" setter="set_unit_size" getter="get_unit_size">
wrote documentation for audio stream player 3D
2017-09-16 13:33:58 +02:00
Factor for the attenuation effect.
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-12 22:42:36 +02:00
</member>
</members>
<signals>
<signal name="finished">
<description>
wrote documentation for audio stream player 3D
2017-09-16 13:33:58 +02:00
Fires 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-12 22:42:36 +02:00
</description>
</signal>
</signals>
<constants>
<constant name="ATTENUATION_INVERSE_DISTANCE" value="0">
wrote documentation for audio stream player 3D
2017-09-16 13:33:58 +02:00
Linear dampening of loudness according to distance.
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-12 22:42:36 +02:00
</constant>
<constant name="ATTENUATION_INVERSE_SQUARE_DISTANCE" value="1">
wrote documentation for audio stream player 3D
2017-09-16 13:33:58 +02:00
Squared dampening of loudness according to distance.
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-12 22:42:36 +02:00
</constant>
<constant name="ATTENUATION_LOGARITHMIC" value="2">
wrote documentation for audio stream player 3D
2017-09-16 13:33:58 +02:00
Logarithmic dampening of loudness according to distance.
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-12 22:42:36 +02:00
</constant>
<constant name="OUT_OF_RANGE_MIX" value="0">
wrote documentation for audio stream player 3D
2017-09-16 13:33:58 +02:00
Mix this audio in, even when it's out of range.
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-12 22:42:36 +02:00
</constant>
<constant name="OUT_OF_RANGE_PAUSE" value="1">
wrote documentation for audio stream player 3D
2017-09-16 13:33:58 +02:00
Pause this audio when it gets out of range.
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-12 22:42:36 +02:00
</constant>
<constant name="DOPPLER_TRACKING_DISABLED" value="0">
wrote documentation for audio stream player 3D
2017-09-16 13:33:58 +02:00
Disables doppler tracking.
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-12 22:42:36 +02:00
</constant>
<constant name="DOPPLER_TRACKING_IDLE_STEP" value="1">
wrote documentation for audio stream player 3D
2017-09-16 13:33:58 +02:00
Executes doppler trackin in idle step.
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-12 22:42:36 +02:00
</constant>
<constant name="DOPPLER_TRACKING_FIXED_STEP" value="2">
wrote documentation for audio stream player 3D
2017-09-16 13:33:58 +02:00
Executes doppler tracking in fixed step.
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-12 22:42:36 +02:00
</constant>
</constants>
</class>
Reference in a new issue Copy permalink