diff options
Diffstat (limited to 'doc/classes/AudioStreamPlayer3D.xml')
| -rw-r--r-- | doc/classes/AudioStreamPlayer3D.xml | 68 |
1 files changed, 37 insertions, 31 deletions
diff --git a/doc/classes/AudioStreamPlayer3D.xml b/doc/classes/AudioStreamPlayer3D.xml index e61515ffc0..a73f96d082 100644 --- a/doc/classes/AudioStreamPlayer3D.xml +++ b/doc/classes/AudioStreamPlayer3D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="AudioStreamPlayer3D" inherits="Spatial" category="Core" version="3.1"> +<class name="AudioStreamPlayer3D" inherits="Spatial" category="Core" version="3.2"> <brief_description> Plays 3D sound in 3D space. </brief_description> @@ -7,11 +7,8 @@ Plays a sound effect with directed sound effects, dampens with distance if needed, generates effect of hearable position in space. </description> <tutorials> - <link>http://docs.godotengine.org/en/latest/learning/features/audio/index.html</link> - <link>http://docs.godotengine.org/en/3.0/tutorials/audio/audio_streams.html</link> + <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"> @@ -20,13 +17,19 @@ Returns the position in the [AudioStream]. </description> </method> + <method name="get_stream_playback"> + <return type="AudioStreamPlayback"> + </return> + <description> + </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. + Plays the audio from the given position [code]from_position[/code], in seconds. </description> </method> <method name="seek"> @@ -47,67 +50,67 @@ </method> </methods> <members> - <member name="area_mask" type="int" setter="set_area_mask" getter="get_area_mask"> + <member name="area_mask" type="int" setter="set_area_mask" getter="get_area_mask" default="1"> Areas in which this sound plays. </member> - <member name="attenuation_filter_cutoff_hz" type="float" setter="set_attenuation_filter_cutoff_hz" getter="get_attenuation_filter_cutoff_hz"> + <member name="attenuation_filter_cutoff_hz" type="float" setter="set_attenuation_filter_cutoff_hz" getter="get_attenuation_filter_cutoff_hz" default="5000.0"> Dampens audio above this frequency, in Hz. </member> - <member name="attenuation_filter_db" type="float" setter="set_attenuation_filter_db" getter="get_attenuation_filter_db"> + <member name="attenuation_filter_db" type="float" setter="set_attenuation_filter_db" getter="get_attenuation_filter_db" default="-24.0"> Amount how much the filter affects the loudness, in dB. </member> - <member name="attenuation_model" type="int" setter="set_attenuation_model" getter="get_attenuation_model" enum="AudioStreamPlayer3D.AttenuationModel"> - Decides if audio should get quieter with distance linearly, quadratically or logarithmically. + <member name="attenuation_model" type="int" setter="set_attenuation_model" getter="get_attenuation_model" enum="AudioStreamPlayer3D.AttenuationModel" default="0"> + Decides if audio should get quieter with distance linearly, quadratically, logarithmically, or not be affected by distance, effectively disabling attenuation. </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 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="doppler_tracking" type="int" setter="set_doppler_tracking" getter="get_doppler_tracking" enum="AudioStreamPlayer3D.DopplerTracking"> + <member name="doppler_tracking" type="int" setter="set_doppler_tracking" getter="get_doppler_tracking" enum="AudioStreamPlayer3D.DopplerTracking" default="0"> Decides in which step the Doppler effect should be calculated. </member> - <member name="emission_angle_degrees" type="float" setter="set_emission_angle" getter="get_emission_angle"> + <member name="emission_angle_degrees" type="float" setter="set_emission_angle" getter="get_emission_angle" default="45.0"> The angle in which the audio reaches cameras undampened. </member> - <member name="emission_angle_enabled" type="bool" setter="set_emission_angle_enabled" getter="is_emission_angle_enabled"> - If [code]true[/code] the audio should be dampened according to the direction of the sound. + <member name="emission_angle_enabled" type="bool" setter="set_emission_angle_enabled" getter="is_emission_angle_enabled" default="false"> + If [code]true[/code], the audio should be dampened according to the direction of the sound. </member> - <member name="emission_angle_filter_attenuation_db" type="float" setter="set_emission_angle_filter_attenuation_db" getter="get_emission_angle_filter_attenuation_db"> - dampens audio if camera is outside of 'emission_angle_degrees' and 'emission_angle_enabled' is set by this factor, in dB. + <member name="emission_angle_filter_attenuation_db" type="float" setter="set_emission_angle_filter_attenuation_db" getter="get_emission_angle_filter_attenuation_db" default="-12.0"> + Dampens audio if camera is outside of [member emission_angle_degrees] and [member emission_angle_enabled] is set by this factor, in dB. </member> - <member name="max_db" type="float" setter="set_max_db" getter="get_max_db"> + <member name="max_db" type="float" setter="set_max_db" getter="get_max_db" default="3.0"> Sets the absolute maximum of the soundlevel, in dB. </member> - <member name="max_distance" type="float" setter="set_max_distance" getter="get_max_distance"> - Sets the distance from which the 'out_of_range_mode' takes effect. Has no effect if set to 0. + <member name="max_distance" type="float" setter="set_max_distance" getter="get_max_distance" default="0.0"> + Sets the distance from which the [member out_of_range_mode] takes effect. Has no effect if set to 0. </member> - <member name="out_of_range_mode" type="int" setter="set_out_of_range_mode" getter="get_out_of_range_mode" enum="AudioStreamPlayer3D.OutOfRangeMode"> - Decides if audio should pause when source is outside of 'max_distance' range. + <member name="out_of_range_mode" type="int" setter="set_out_of_range_mode" getter="get_out_of_range_mode" enum="AudioStreamPlayer3D.OutOfRangeMode" default="0"> + Decides if audio should pause when source is outside of [member max_distance] range. </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"> 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="unit_db" type="float" setter="set_unit_db" getter="get_unit_db"> + <member name="unit_db" type="float" setter="set_unit_db" getter="get_unit_db" default="0.0"> Base sound level unaffected by dampening, in dB. </member> - <member name="unit_size" type="float" setter="set_unit_size" getter="get_unit_size"> + <member name="unit_size" type="float" setter="set_unit_size" getter="get_unit_size" default="1.0"> Factor for the attenuation effect. </member> </members> <signals> <signal name="finished"> <description> - Fires when the audio stops playing. + Emitted when the audio stops playing. </description> </signal> </signals> @@ -121,6 +124,9 @@ <constant name="ATTENUATION_LOGARITHMIC" value="2" enum="AttenuationModel"> Logarithmic dampening of loudness according to distance. </constant> + <constant name="ATTENUATION_DISABLED" value="3" enum="AttenuationModel"> + No dampening of loudness according to distance. + </constant> <constant name="OUT_OF_RANGE_MIX" value="0" enum="OutOfRangeMode"> Mix this audio in, even when it's out of range. </constant> |