AudioStreamPlayer3D Properties

Areas in which this sound plays.

Dampens audio using a low-pass filter above this frequency, in Hz. To disable the dampening effect entirely, set this to 20500 as this frequency is above the human hearing limit.

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

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

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

The bus on which this audio is playing.

The override to the default MultiplayerAPI. Set to null to use the default SceneTree one.

Decides in which step the Doppler effect should be calculated.

The angle in which the audio reaches cameras undampened.

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

Dampens audio if camera is outside of EmissionAngleDegrees and EmissionAngleEnabled is set by this factor, in decibels.

When a scene is instanced from a file, its topmost node contains the filename from which it was loaded.

The SpatialGizmo for this node. Used for example in [!:Godot.EditorSpatialGizmo] as custom visualization and editing handles in Editor.

World space (global) Transform of this node.

Sets the absolute maximum of the soundlevel, in decibels.

Sets the distance from which the OutOfRangeMode takes effect. Has no effect if set to 0.

The MultiplayerAPI instance associated with this node. Either the CustomMultiplayer, or the default SceneTree one (if inside tree).

The name of the node. This name is unique among the siblings (other child nodes from the same parent). When set to an existing name, the node will be automatically renamed.

Note: Auto-generated names might include the @ character, which is reserved for unique names when using AddChild(Node, Boolean). When setting the name manually, any @ will be removed.

Decides if audio should pause when source is outside of MaxDistance range.

The node owner. A node can have any other node as owner (as long as it is a valid parent, grandparent, etc. ascending in the tree). When saving a node (using PackedScene), all the nodes it owns will be saved with it. This allows for the creation of complex SceneTrees, with instancing and subinstancing.

Pause mode. How the node will behave if the SceneTree is paused.

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

If true, audio is playing.

The node's priority in the execution order of the enabled processing callbacks (i.e. , and their internal counterparts). Nodes whose process priority value is lower will have their processing callbacks executed first.

Rotation part of the local transformation in radians, specified in terms of YXZ-Euler angles in the format (X angle, Y angle, Z angle).

Note: In the mathematical sense, rotation is a matrix and not a vector. The three Euler angles, which are the three independent parameters of the Euler-angle parametrization of the rotation matrix, are stored in a Vector3 data structure not because the rotation is a vector, but only because Vector3 exists as a convenient data-structure to store 3 floating-point numbers. Therefore, applying affine operations on the rotation "vector" is not meaningful.

Rotation part of the local transformation in degrees, specified in terms of YXZ-Euler angles in the format (X angle, Y angle, Z angle).

Scale part of the local transformation.

The AudioStream resource to be played.

If true, the playback is paused. You can resume it by setting StreamPaused to false.

Local space Transform of this node, with respect to the parent node.

Local translation of this node.

The base sound level unaffected by dampening, in decibels.

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

If true, this node is drawn. The node is only visible if all of its antecedents are visible as well (in other words, IsVisibleInTree must return true).