AudioStreamPlayer3D

public uint AreaMask { get; set; }

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.

public float AttenuationFilterCutoffHz { get; set; }

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.

public float AttenuationFilterDb { get; set; }

Amount how much the filter affects the loudness, in decibels.

public AudioStreamPlayer3D.AttenuationModelEnum AttenuationModel { get; set; }

Decides if audio should get quieter with distance linearly, quadratically, logarithmically, or not be affected by distance, effectively disabling attenuation.

public bool Autoplay { get; set; }

If true, audio plays when the AudioStreamPlayer3D node is added to scene tree.

public StringName Bus { get; set; }

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".

public AudioStreamPlayer3D.DopplerTrackingEnum DopplerTracking { get; set; }

Decides in which step the Doppler effect should be calculated. Note: If AudioStreamPlayer3D.DopplerTracking is not AudioStreamPlayer3D.DopplerTrackingEnum.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.

public float EmissionAngleDegrees { get; set; }

The angle in which the audio reaches a listener unattenuated.

public bool EmissionAngleEnabled { get; set; }

If true, the audio should be attenuated according to the direction of the sound.

public float EmissionAngleFilterAttenuationDb { get; set; }

Attenuation factor used if listener is outside of AudioStreamPlayer3D.EmissionAngleDegrees and AudioStreamPlayer3D.EmissionAngleEnabled is set, in decibels.

public float MaxDb { get; set; }

Sets the absolute maximum of the sound level, in decibels.

public float MaxDistance { get; set; }

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. AudioStreamPlayer3D.MaxDistance works in tandem with AudioStreamPlayer3D.UnitSize. However, unlike AudioStreamPlayer3D.UnitSize whose behavior depends on the AudioStreamPlayer3D.AttenuationModel, AudioStreamPlayer3D.MaxDistance 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.

public int MaxPolyphony { get; set; }

Maximum simultaneous voices in this player. A new Play exceeding the limit replaces the oldest voice. Use a positive value; choose 1 for a single controlled music stream.

public float PanningStrength { get; set; }

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.

public float PitchScale { get; set; }

The pitch and the tempo of the audio, as a multiplier of the audio sample's sample rate.

public AudioServer.PlaybackType PlaybackType { get; set; }

The playback type of the stream player. If set other than to the default value, it will force that playback type.

public bool Playing { get; set; }

If true, audio is playing or is queued to be played (see AudioStreamPlayer3D.Play).

public AudioStream Stream { get; set; }

The AudioStream resource to be played.

public bool StreamPaused { get; set; }

Pauses or resumes existing voices. A pending pause is not retained when no voices exist. In Stream mode, pausing makes IsPlaying() false while HasStreamPlayback() remains true.

public float UnitSize { get; set; }

The factor for the attenuation effect. Higher values make the sound audible over a larger distance.

public float VolumeDb { get; set; }

The base sound level before attenuation, in decibels.

public float VolumeLinear { get; set; }

The base sound level before attenuation, as a linear value. Note: This member modifies AudioStreamPlayer3D.VolumeDb for convenience. The returned value is equivalent to the result of @GlobalScope.db_to_linear on AudioStreamPlayer3D.VolumeDb. Setting this member is equivalent to setting AudioStreamPlayer3D.VolumeDb to the result of @GlobalScope.linear_to_db on a value.

public float GetPlaybackPosition();

Returns the most recently created voice's position in seconds, not the combined time of all voices. It can advance in steps between mixes. For a single stream at speed 1, time since the last mix can refine an estimate; handle pause, seeking and output latency separately.

public AudioStreamPlayback GetStreamPlayback();

Returns the AudioStreamPlayback object associated with this AudioStreamPlayer3D.

public bool HasStreamPlayback();

Checks whether the player retains playback objects, including paused ones. This does not prove audible output: mute, distance or pause can produce silence.

public bool IsPlaying();

In Stream mode, returns true for an actively playing voice. Returns false while paused; use HasStreamPlayback() or StreamPaused to detect retained playback. Do not reject a resume command using this method.

public void Play(float fromPosition = 0f);

Queues the audio to play on the next physics frame, from the given position from_position, in seconds.

public void Seek(float toPosition);

Restarts the player at a position in seconds only while actively playing. Stops previous voices and starts a new one at the position. In Stream mode it does nothing while paused or stopped. To seek while retaining pause, save the flag, call Stop(), Play(position), then restore StreamPaused.

public void Stop();

Stops the audio.

public event Action Finished;

Emitted when an update removes one or more naturally ended voices. Other voices may still be playing. Stop() and voice-limit replacement are not natural completion; looping does not emit this signal each cycle.