| github_url: | hide |
|---|
Inherits: :ref:`Node3D<class_Node3D>` < :ref:`Node<class_Node>` < :ref:`Object<class_Object>`
Plays positional sound in 3D space.
.. rst-class:: classref-introduction-group
Plays audio with positional sound effects, based on the relative position of the audio listener. Positional effects include distance attenuation, directionality, and the Doppler effect. For greater realism, a low-pass filter is applied to distant sounds. This can be disabled by setting :ref:`attenuation_filter_cutoff_hz<class_AudioStreamPlayer3D_property_attenuation_filter_cutoff_hz>` to 20500.
By default, audio is heard from the camera position. This can be changed by adding an :ref:`AudioListener3D<class_AudioListener3D>` node to the scene and enabling it by calling :ref:`AudioListener3D.make_current()<class_AudioListener3D_method_make_current>` on it.
See also :ref:`AudioStreamPlayer<class_AudioStreamPlayer>` to play a sound non-positionally.
Note: Hiding an AudioStreamPlayer3D node does not disable its audio output. To temporarily disable an AudioStreamPlayer3D's audio output, set :ref:`volume_db<class_AudioStreamPlayer3D_property_volume_db>` to a very low value like -100 (which isn't audible to human hearing).
.. rst-class:: classref-introduction-group
.. rst-class:: classref-reftable-group
.. rst-class:: classref-reftable-group
.. rst-class:: classref-section-separator
.. rst-class:: classref-descriptions-group
.. rst-class:: classref-signal
finished() :ref:`🔗<class_AudioStreamPlayer3D_signal_finished>`
Emitted when the audio stops playing.
.. rst-class:: classref-section-separator
.. rst-class:: classref-descriptions-group
.. rst-class:: classref-enumeration
enum AttenuationModel: :ref:`🔗<enum_AudioStreamPlayer3D_AttenuationModel>`
.. rst-class:: classref-enumeration-constant
:ref:`AttenuationModel<enum_AudioStreamPlayer3D_AttenuationModel>` ATTENUATION_INVERSE_DISTANCE = 0
Attenuation of loudness according to linear distance.
.. rst-class:: classref-enumeration-constant
:ref:`AttenuationModel<enum_AudioStreamPlayer3D_AttenuationModel>` ATTENUATION_INVERSE_SQUARE_DISTANCE = 1
Attenuation of loudness according to squared distance.
.. rst-class:: classref-enumeration-constant
:ref:`AttenuationModel<enum_AudioStreamPlayer3D_AttenuationModel>` ATTENUATION_LOGARITHMIC = 2
Attenuation of loudness according to logarithmic distance.
.. rst-class:: classref-enumeration-constant
:ref:`AttenuationModel<enum_AudioStreamPlayer3D_AttenuationModel>` ATTENUATION_DISABLED = 3
No attenuation of loudness according to distance. The sound will still be heard positionally, unlike an :ref:`AudioStreamPlayer<class_AudioStreamPlayer>`. :ref:`ATTENUATION_DISABLED<class_AudioStreamPlayer3D_constant_ATTENUATION_DISABLED>` can be combined with a :ref:`max_distance<class_AudioStreamPlayer3D_property_max_distance>` value greater than 0.0 to achieve linear attenuation clamped to a sphere of a defined size.
.. rst-class:: classref-item-separator
.. rst-class:: classref-enumeration
enum DopplerTracking: :ref:`🔗<enum_AudioStreamPlayer3D_DopplerTracking>`
.. rst-class:: classref-enumeration-constant
:ref:`DopplerTracking<enum_AudioStreamPlayer3D_DopplerTracking>` DOPPLER_TRACKING_DISABLED = 0
Disables doppler tracking.
.. rst-class:: classref-enumeration-constant
:ref:`DopplerTracking<enum_AudioStreamPlayer3D_DopplerTracking>` DOPPLER_TRACKING_IDLE_STEP = 1
Executes doppler tracking during process frames (see :ref:`Node.NOTIFICATION_INTERNAL_PROCESS<class_Node_constant_NOTIFICATION_INTERNAL_PROCESS>`).
.. rst-class:: classref-enumeration-constant
:ref:`DopplerTracking<enum_AudioStreamPlayer3D_DopplerTracking>` DOPPLER_TRACKING_PHYSICS_STEP = 2
Executes doppler tracking during physics frames (see :ref:`Node.NOTIFICATION_INTERNAL_PHYSICS_PROCESS<class_Node_constant_NOTIFICATION_INTERNAL_PHYSICS_PROCESS>`).
.. rst-class:: classref-section-separator
.. rst-class:: classref-descriptions-group
.. rst-class:: classref-property
:ref:`int<class_int>` area_mask = 1 :ref:`🔗<class_AudioStreamPlayer3D_property_area_mask>`
.. rst-class:: classref-property-setget
- |void| set_area_mask(value: :ref:`int<class_int>`)
- :ref:`int<class_int>` get_area_mask()
Determines which :ref:`Area3D<class_Area3D>` layers affect the sound for reverb and audio bus effects. Areas can be used to redirect :ref:`AudioStream<class_AudioStream>`s so that they play in a certain audio bus. An example of how you might use this is making a "water" area so that sounds played in the water are redirected through an audio bus to make them sound like they are being played underwater.
.. rst-class:: classref-item-separator
.. rst-class:: classref-property
:ref:`float<class_float>` attenuation_filter_cutoff_hz = 5000.0 :ref:`🔗<class_AudioStreamPlayer3D_property_attenuation_filter_cutoff_hz>`
.. rst-class:: classref-property-setget
- |void| set_attenuation_filter_cutoff_hz(value: :ref:`float<class_float>`)
- :ref:`float<class_float>` get_attenuation_filter_cutoff_hz()
The cutoff frequency of the attenuation low-pass filter, in Hz. A sound above this frequency is attenuated more than a sound below this frequency. To disable this effect, set this to 20500 as this frequency is above the human hearing limit.
.. rst-class:: classref-item-separator
.. rst-class:: classref-property
:ref:`float<class_float>` attenuation_filter_db = -24.0 :ref:`🔗<class_AudioStreamPlayer3D_property_attenuation_filter_db>`
.. rst-class:: classref-property-setget
- |void| set_attenuation_filter_db(value: :ref:`float<class_float>`)
- :ref:`float<class_float>` get_attenuation_filter_db()
Amount how much the filter affects the loudness, in decibels.
.. rst-class:: classref-item-separator
.. rst-class:: classref-property
:ref:`AttenuationModel<enum_AudioStreamPlayer3D_AttenuationModel>` attenuation_model = 0 :ref:`🔗<class_AudioStreamPlayer3D_property_attenuation_model>`
.. rst-class:: classref-property-setget
- |void| set_attenuation_model(value: :ref:`AttenuationModel<enum_AudioStreamPlayer3D_AttenuationModel>`)
- :ref:`AttenuationModel<enum_AudioStreamPlayer3D_AttenuationModel>` get_attenuation_model()
Decides if audio should get quieter with distance linearly, quadratically, logarithmically, or not be affected by distance, effectively disabling attenuation.
.. rst-class:: classref-item-separator
.. rst-class:: classref-property
:ref:`bool<class_bool>` autoplay = false :ref:`🔗<class_AudioStreamPlayer3D_property_autoplay>`
.. rst-class:: classref-property-setget
- |void| set_autoplay(value: :ref:`bool<class_bool>`)
- :ref:`bool<class_bool>` is_autoplay_enabled()
If true, audio plays when the AudioStreamPlayer3D node is added to scene tree.
.. rst-class:: classref-item-separator
.. rst-class:: classref-property
:ref:`StringName<class_StringName>` bus = &"Master" :ref:`🔗<class_AudioStreamPlayer3D_property_bus>`
.. rst-class:: classref-property-setget
- |void| set_bus(value: :ref:`StringName<class_StringName>`)
- :ref:`StringName<class_StringName>` get_bus()
The bus on which this audio is playing.
Note: When setting this property, keep in mind that no validation is performed to see if the given name matches an existing bus. This is because audio bus layouts might be loaded after this property is set. If this given name can't be resolved at runtime, it will fall back to "Master".
.. rst-class:: classref-item-separator
.. rst-class:: classref-property
:ref:`DopplerTracking<enum_AudioStreamPlayer3D_DopplerTracking>` doppler_tracking = 0 :ref:`🔗<class_AudioStreamPlayer3D_property_doppler_tracking>`
.. rst-class:: classref-property-setget
- |void| set_doppler_tracking(value: :ref:`DopplerTracking<enum_AudioStreamPlayer3D_DopplerTracking>`)
- :ref:`DopplerTracking<enum_AudioStreamPlayer3D_DopplerTracking>` get_doppler_tracking()
Decides in which step the Doppler effect should be calculated.
.. rst-class:: classref-item-separator
.. rst-class:: classref-property
:ref:`float<class_float>` emission_angle_degrees = 45.0 :ref:`🔗<class_AudioStreamPlayer3D_property_emission_angle_degrees>`
.. rst-class:: classref-property-setget
- |void| set_emission_angle(value: :ref:`float<class_float>`)
- :ref:`float<class_float>` get_emission_angle()
The angle in which the audio reaches a listener unattenuated.
.. rst-class:: classref-item-separator
.. rst-class:: classref-property
:ref:`bool<class_bool>` emission_angle_enabled = false :ref:`🔗<class_AudioStreamPlayer3D_property_emission_angle_enabled>`
.. rst-class:: classref-property-setget
- |void| set_emission_angle_enabled(value: :ref:`bool<class_bool>`)
- :ref:`bool<class_bool>` is_emission_angle_enabled()
If true, the audio should be attenuated according to the direction of the sound.
.. rst-class:: classref-item-separator
.. rst-class:: classref-property
:ref:`float<class_float>` emission_angle_filter_attenuation_db = -12.0 :ref:`🔗<class_AudioStreamPlayer3D_property_emission_angle_filter_attenuation_db>`
.. rst-class:: classref-property-setget
- |void| set_emission_angle_filter_attenuation_db(value: :ref:`float<class_float>`)
- :ref:`float<class_float>` get_emission_angle_filter_attenuation_db()
Attenuation factor used if listener is outside of :ref:`emission_angle_degrees<class_AudioStreamPlayer3D_property_emission_angle_degrees>` and :ref:`emission_angle_enabled<class_AudioStreamPlayer3D_property_emission_angle_enabled>` is set, in decibels.
.. rst-class:: classref-item-separator
.. rst-class:: classref-property
:ref:`float<class_float>` max_db = 3.0 :ref:`🔗<class_AudioStreamPlayer3D_property_max_db>`
.. rst-class:: classref-property-setget
- |void| set_max_db(value: :ref:`float<class_float>`)
- :ref:`float<class_float>` get_max_db()
Sets the absolute maximum of the sound level, in decibels.
.. rst-class:: classref-item-separator
.. rst-class:: classref-property
:ref:`float<class_float>` max_distance = 0.0 :ref:`🔗<class_AudioStreamPlayer3D_property_max_distance>`
.. rst-class:: classref-property-setget
- |void| set_max_distance(value: :ref:`float<class_float>`)
- :ref:`float<class_float>` get_max_distance()
The distance past which the sound can no longer be heard at all. Only has an effect if set to a value greater than 0.0. :ref:`max_distance<class_AudioStreamPlayer3D_property_max_distance>` works in tandem with :ref:`unit_size<class_AudioStreamPlayer3D_property_unit_size>`. However, unlike :ref:`unit_size<class_AudioStreamPlayer3D_property_unit_size>` whose behavior depends on the :ref:`attenuation_model<class_AudioStreamPlayer3D_property_attenuation_model>`, :ref:`max_distance<class_AudioStreamPlayer3D_property_max_distance>` always works in a linear fashion. This can be used to prevent the AudioStreamPlayer3D from requiring audio mixing when the listener is far away, which saves CPU resources.
.. rst-class:: classref-item-separator
.. rst-class:: classref-property
:ref:`int<class_int>` max_polyphony = 1 :ref:`🔗<class_AudioStreamPlayer3D_property_max_polyphony>`
.. rst-class:: classref-property-setget
- |void| set_max_polyphony(value: :ref:`int<class_int>`)
- :ref:`int<class_int>` get_max_polyphony()
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.
.. rst-class:: classref-item-separator
.. rst-class:: classref-property
:ref:`float<class_float>` panning_strength = 1.0 :ref:`🔗<class_AudioStreamPlayer3D_property_panning_strength>`
.. rst-class:: classref-property-setget
- |void| set_panning_strength(value: :ref:`float<class_float>`)
- :ref:`float<class_float>` get_panning_strength()
Scales the panning strength for this node by multiplying the base :ref:`ProjectSettings.audio/general/3d_panning_strength<class_ProjectSettings_property_audio/general/3d_panning_strength>` by this factor. If the product is 0.0 then stereo panning is disabled and the volume is the same for all channels. If the product is 1.0 then one of the channels will be muted when the sound is located exactly to the left (or right) of the listener.
Two speaker stereo arrangements implement the WebAudio standard for StereoPannerNode Panning where the volume is cosine of half the azimuth angle to the ear.
For other speaker arrangements such as the 5.1 and 7.1 the SPCAP (Speaker-Placement Correction Amplitude) algorithm is implemented.
.. rst-class:: classref-item-separator
.. rst-class:: classref-property
:ref:`float<class_float>` pitch_scale = 1.0 :ref:`🔗<class_AudioStreamPlayer3D_property_pitch_scale>`
.. rst-class:: classref-property-setget
- |void| set_pitch_scale(value: :ref:`float<class_float>`)
- :ref:`float<class_float>` get_pitch_scale()
The pitch and the tempo of the audio, as a multiplier of the audio sample's sample rate.
.. rst-class:: classref-item-separator
.. rst-class:: classref-property
:ref:`PlaybackType<enum_AudioServer_PlaybackType>` playback_type = 0 :ref:`🔗<class_AudioStreamPlayer3D_property_playback_type>`
.. rst-class:: classref-property-setget
- |void| set_playback_type(value: :ref:`PlaybackType<enum_AudioServer_PlaybackType>`)
- :ref:`PlaybackType<enum_AudioServer_PlaybackType>` get_playback_type()
Experimental: This property may be changed or removed in future versions.
The playback type of the stream player. If set other than to the default value, it will force that playback type.
.. rst-class:: classref-item-separator
.. rst-class:: classref-property
:ref:`bool<class_bool>` playing = false :ref:`🔗<class_AudioStreamPlayer3D_property_playing>`
.. rst-class:: classref-property-setget
- |void| set_playing(value: :ref:`bool<class_bool>`)
- :ref:`bool<class_bool>` is_playing()
If true, audio is playing or is queued to be played (see :ref:`play()<class_AudioStreamPlayer3D_method_play>`).
.. rst-class:: classref-item-separator
.. rst-class:: classref-property
:ref:`AudioStream<class_AudioStream>` stream :ref:`🔗<class_AudioStreamPlayer3D_property_stream>`
.. rst-class:: classref-property-setget
- |void| set_stream(value: :ref:`AudioStream<class_AudioStream>`)
- :ref:`AudioStream<class_AudioStream>` get_stream()
The :ref:`AudioStream<class_AudioStream>` resource to be played.
.. rst-class:: classref-item-separator
.. rst-class:: classref-property
:ref:`bool<class_bool>` stream_paused = false :ref:`🔗<class_AudioStreamPlayer3D_property_stream_paused>`
.. rst-class:: classref-property-setget
- |void| set_stream_paused(value: :ref:`bool<class_bool>`)
- :ref:`bool<class_bool>` get_stream_paused()
If true, the playback is paused. You can resume it by setting :ref:`stream_paused<class_AudioStreamPlayer3D_property_stream_paused>` to false.
.. rst-class:: classref-item-separator
.. rst-class:: classref-property
:ref:`float<class_float>` unit_size = 10.0 :ref:`🔗<class_AudioStreamPlayer3D_property_unit_size>`
.. rst-class:: classref-property-setget
- |void| set_unit_size(value: :ref:`float<class_float>`)
- :ref:`float<class_float>` get_unit_size()
The factor for the attenuation effect. Higher values make the sound audible over a larger distance.
.. rst-class:: classref-item-separator
.. rst-class:: classref-property
:ref:`float<class_float>` volume_db = 0.0 :ref:`🔗<class_AudioStreamPlayer3D_property_volume_db>`
.. rst-class:: classref-property-setget
- |void| set_volume_db(value: :ref:`float<class_float>`)
- :ref:`float<class_float>` get_volume_db()
The base sound level before attenuation, in decibels.
.. rst-class:: classref-item-separator
.. rst-class:: classref-property
:ref:`float<class_float>` volume_linear :ref:`🔗<class_AudioStreamPlayer3D_property_volume_linear>`
.. rst-class:: classref-property-setget
- |void| set_volume_linear(value: :ref:`float<class_float>`)
- :ref:`float<class_float>` get_volume_linear()
The base sound level before attenuation, as a linear value.
Note: This member modifies :ref:`volume_db<class_AudioStreamPlayer3D_property_volume_db>` for convenience. The returned value is equivalent to the result of :ref:`@GlobalScope.db_to_linear()<class_@GlobalScope_method_db_to_linear>` on :ref:`volume_db<class_AudioStreamPlayer3D_property_volume_db>`. Setting this member is equivalent to setting :ref:`volume_db<class_AudioStreamPlayer3D_property_volume_db>` to the result of :ref:`@GlobalScope.linear_to_db()<class_@GlobalScope_method_linear_to_db>` on a value.
.. rst-class:: classref-section-separator
.. rst-class:: classref-descriptions-group
.. rst-class:: classref-method
:ref:`float<class_float>` get_playback_position() :ref:`🔗<class_AudioStreamPlayer3D_method_get_playback_position>`
Returns the position in the :ref:`AudioStream<class_AudioStream>`.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`AudioStreamPlayback<class_AudioStreamPlayback>` get_stream_playback() :ref:`🔗<class_AudioStreamPlayer3D_method_get_stream_playback>`
Returns the :ref:`AudioStreamPlayback<class_AudioStreamPlayback>` object associated with this AudioStreamPlayer3D.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`bool<class_bool>` has_stream_playback() :ref:`🔗<class_AudioStreamPlayer3D_method_has_stream_playback>`
Returns whether the :ref:`AudioStreamPlayer<class_AudioStreamPlayer>` can return the :ref:`AudioStreamPlayback<class_AudioStreamPlayback>` object or not.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
|void| play(from_position: :ref:`float<class_float>` = 0.0) :ref:`🔗<class_AudioStreamPlayer3D_method_play>`
Queues the audio to play on the next physics frame, from the given position from_position, in seconds.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
|void| seek(to_position: :ref:`float<class_float>`) :ref:`🔗<class_AudioStreamPlayer3D_method_seek>`
Sets the position from which audio will be played, in seconds.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
|void| stop() :ref:`🔗<class_AudioStreamPlayer3D_method_stop>`
Stops the audio.