Plays positional sound in 3D space.
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 attenuation_filter_cutoff_hz to 20500.
By default, audio is heard from the camera position. This can be changed by adding an AudioListener3D node to the scene and enabling it by calling AudioListener3D.make_current() on it.
See also 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 volume_db to a very low value like -100 (which isn't audible to human hearing).
Determines which Area3D layers affect the sound for reverb and audio bus effects. Areas can be used to redirect AudioStreams 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.
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.
Decides if audio should get quieter with distance linearly, quadratically, logarithmically, or not be affected by distance, effectively disabling attenuation.
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".
Decides in which step the Doppler effect should be calculated.
Note: If doppler_tracking is not DOPPLER_TRACKING_DISABLED but the current Camera3D/AudioListener3D has doppler tracking disabled, the Doppler effect will be heard but will not take the movement of the current listener into account. If accurate Doppler effect is desired, doppler tracking should be enabled on both the AudioStreamPlayer3D and the current Camera3D/AudioListener3D.
Attenuation factor used if listener is outside of emission_angle_degrees and emission_angle_enabled is set, in decibels.
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. max_distance works in tandem with unit_size. However, unlike unit_size whose behavior depends on the attenuation_model, 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.
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.
Scales the panning strength for this node by multiplying the base ProjectSettings.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.
The playback type of the stream player. If set other than to the default value, it will force that playback type.
If true, the playback is paused. You can resume it by setting stream_paused to false.
The base sound level before attenuation, as a linear value.
Note: This member modifies volume_db for convenience. The returned value is equivalent to the result of db_to_linear() on volume_db. Setting this member is equivalent to setting volume_db to the result of linear_to_db() on a value.
Returns the AudioStreamPlayback object associated with this AudioStreamPlayer3D.
Returns whether the AudioStreamPlayer can return the AudioStreamPlayback object or not.
Queues the audio to play on the next physics frame, from the given position from_position, in seconds.
ATTENUATION_INVERSE_DISTANCE = 0Attenuation of loudness according to linear distance.
ATTENUATION_INVERSE_SQUARE_DISTANCE = 1Attenuation of loudness according to squared distance.
ATTENUATION_LOGARITHMIC = 2Attenuation of loudness according to logarithmic distance.
ATTENUATION_DISABLED = 3No attenuation of loudness according to distance. The sound will still be heard positionally, unlike an AudioStreamPlayer. ATTENUATION_DISABLED can be combined with a max_distance value greater than 0.0 to achieve linear attenuation clamped to a sphere of a defined size.
DOPPLER_TRACKING_DISABLED = 0Disables doppler tracking.
DOPPLER_TRACKING_IDLE_STEP = 1Executes doppler tracking during process frames (see Node.NOTIFICATION_INTERNAL_PROCESS).
DOPPLER_TRACKING_PHYSICS_STEP = 2Executes doppler tracking during physics frames (see Node.NOTIFICATION_INTERNAL_PHYSICS_PROCESS).