AudioListener3D — C# API

class AudioListener3DReckfellSharpInherits Entity3D

Overrides the location sounds are heard from.

Once added to the scene tree and enabled using AudioListener3D.MakeCurrent, this node will override the location sounds are heard from. This can be used to listen from a location different from the Camera3D.

Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.

Constructors1

AudioListener3DConstructor

# AudioListener3D

C#
public AudioListener3D();

Properties1

DopplerTrackingProperty

# DopplerTracking

C#
public AudioListener3D.DopplerTrackingEnum DopplerTracking { get; set; }

If not AudioListener3D.DopplerTrackingEnum.Disabled, this listener will simulate the Doppler effect for objects changed in particular _process methods. Note: The Doppler effect will only be heard on AudioStreamPlayer3Ds if AudioStreamPlayer3D.DopplerTracking is not set to AudioStreamPlayer3D.DopplerTrackingEnum.Disabled.

Methods6

ClearCurrentvoid

# ClearCurrent

C#
public void ClearCurrent();

Disables the listener to use the current camera's listener instead.

GetDopplerTrackingAudioListener3D.DopplerTrackingEnum

# GetDopplerTracking

C#
public AudioListener3D.DopplerTrackingEnum GetDopplerTracking();

Returns AudioListener3D.DopplerTrackingEnum

GetListenerTransformTransform3D

# GetListenerTransform

C#
public Transform3D GetListenerTransform();

Returns the listener's global orthonormalized Transform3D.

Returns Transform3D

IsCurrentbool

# IsCurrent

C#
public bool IsCurrent();

Returns true if the listener was made current using AudioListener3D.MakeCurrent, false otherwise. Note: There may be more than one AudioListener3D marked as "current" in the scene tree, but only the one that was made current last will be used.

Returns bool

MakeCurrentvoid

# MakeCurrent

C#
public void MakeCurrent();

Enables the listener. This will override the current camera's listener.

SetDopplerTrackingvoid

# SetDopplerTracking

C#
public void SetDopplerTracking(AudioListener3D.DopplerTrackingEnum mode);

Parameters
Name	Type	Default
`mode`	`AudioListener3D.DopplerTrackingEnum`	—

AudioListener3D.DopplerTrackingEnum

Value	Description
`Disabled = 0`	Disables Doppler effect simulation (default).
`IdleStep = 1`	Simulate Doppler effect by tracking positions of objects that are changed in `_process`. Changes in the relative velocity of this listener compared to those objects affect how audio is perceived (changing the audio's `AudioStreamPlayer3D.PitchScale`).
`PhysicsStep = 2`	Simulate Doppler effect by tracking positions of objects that are changed in `_physics_process`. Changes in the relative velocity of this listener compared to those objects affect how audio is perceived (changing the audio's `AudioStreamPlayer3D.PitchScale`).