EventDispatcher → Object3D →

AudioListener

The class represents a virtual listener of the all positional and non-positional audio effects in the scene. A three.js application usually creates a single listener. It is a mandatory constructor parameter for audios entities like Audio and PositionalAudio.

In most cases, the listener object is a child of the camera. So the 3D transformation of the camera represents the 3D transformation of the listener.

Constructor

new AudioListener()

Constructs a new audio listener.

Properties

.context : AudioContext (readonly)

The native audio context.

.filter : AudioNode (readonly)

An optional filter.

Defined via AudioListener#setFilter.

Default is null.

.gain : GainNode (readonly)

The gain node used for volume control.

.timeDelta : number (readonly)

Time delta values required for linearRampToValueAtTime() usage.

Default is 0.

Methods

.getFilter() : AudioNode

Returns the current set filter.

Returns: The filter.

.getInput() : GainNode

Returns the listener's input node.

This method is used by other audio nodes to connect to this listener.

Returns: The input node.

.getMasterVolume() : number

Returns the applications master volume.

Returns: The master volume.

.removeFilter() : AudioListener

Removes the current filter from this listener.

Returns: A reference to this listener.

.setFilter( value : AudioNode ) : AudioListener

Sets the given filter to this listener.

value

The filter to set.
Returns: A reference to this listener.

.setMasterVolume( value : number ) : AudioListener

Sets the applications master volume. This volume setting affects all audio nodes in the scene.

value

The master volume to set.
Returns: A reference to this listener.

Source

src/audio/AudioListener.js