AudioListener
The AudioListener interface represents the position and orientation of the unique person listening to the audio scene, and is used in audio spatialisation. All PannerNodes spatialise in relation to the AudioListener stored in the AudioContext.listener attribute.
It is important to note that there is only one listener per context and that it isn't an AudioNode.
Value members
Concrete methods
Defines the orientation of the listener.
Defines the orientation of the listener.
It consists of two direction vectors:
- The front vector, defined by the three unitless parameters x, y and z, describes the direction of the face of the listener, that is the direction the nose of the person is pointing towards. The front vector's default value is (0, 0, -1).
- The up vector, defined by three unitless parameters xUp, yUp and zUp, describes the direction of the top of the listener's head. The up vector's default value is (0, 1, 0).
Both vectors must be separated by an angle of 90° — in linear analysis terms, they must be linearly independent.
- Value parameters:
- x
The x value of the front vector of the listener.
- xUp
The x value of the up vector of the listener.
- y
The y value of the front vector of the listener.
- yUp
The y value of the up vector of the listener.
- z
The z value of the front vector of the listener.
- zUp
The z value of the up vector of the listener.
Defines the position of the listener.
Defines the position of the listener.
The three parameters x, y and z are unitless and describe the listener's position in 3D space according to the right-hand Cartesian coordinate system. PannerNode objects use this position relative to individual audio sources for spatialisation.
The default value of the position vector is (0, 0, 0).
- Value parameters:
- x
The x position of the listener in 3D space.
- y
The y position of the listener in 3D space.
- z
The z position of the listener in 3D space.
Inherited methods
The EventTarget.addEventListener() method registers the specified listener on the EventTarget it's called on. The event target may be an Element in a document, the Document itself, a Window, or any other object that supports events (such as XMLHttpRequest).
The EventTarget.addEventListener() method registers the specified listener on the EventTarget it's called on. The event target may be an Element in a document, the Document itself, a Window, or any other object that supports events (such as XMLHttpRequest).
This implementation accepts a settings object of type EventListenerOptions.
- Inherited from:
- EventTarget
The EventTarget.addEventListener() method registers the specified listener on the EventTarget it's called on. The event target may be an Element in a document, the Document itself, a Window, or any other object that supports events (such as XMLHttpRequest).
The EventTarget.addEventListener() method registers the specified listener on the EventTarget it's called on. The event target may be an Element in a document, the Document itself, a Window, or any other object that supports events (such as XMLHttpRequest).
- Inherited from:
- EventTarget
Allows us to connect one output of this node to one input of an audio parameter.
Allows us to connect one output of this node to one input of an audio parameter.
- Inherited from:
- AudioNode
Allows us to connect one output of this node to one input of another node.
Allows us to connect one output of this node to one input of another node.
- Inherited from:
- AudioNode
Allows us to disconnect the current node from another one it is already connected to.
Allows us to disconnect the current node from another one it is already connected to.
- Value parameters:
- output
The index describing which output of the AudioNode is going to be disconnected.
- Inherited from:
- AudioNode
Dispatches an Event at the specified EventTarget, invoking the affected EventListeners in the appropriate order. The normal event processing rules (including the capturing and optional bubbling phase) apply to events dispatched manually with dispatchEvent().
Dispatches an Event at the specified EventTarget, invoking the affected EventListeners in the appropriate order. The normal event processing rules (including the capturing and optional bubbling phase) apply to events dispatched manually with dispatchEvent().
- Inherited from:
- EventTarget
Removes the event listener previously registered with EventTarget.addEventListener.
Removes the event listener previously registered with EventTarget.addEventListener.
This implementation accepts a settings object of type EventListenerOptions.
- Inherited from:
- EventTarget
Removes the event listener previously registered with EventTarget.addEventListener.
Removes the event listener previously registered with EventTarget.addEventListener.
- Inherited from:
- EventTarget
Concrete fields
Is a double value representing the amount of pitch shift to use when rendering a doppler effect.
Is a double value representing the amount of pitch shift to use when rendering a doppler effect.
Inherited fields
Represents an integer used to determine how many channels are used when up-mixing and down-mixing connections to any inputs to the node. Its usage and precise definition depend on the value of AudioNode.channelCountMode.
Represents an integer used to determine how many channels are used when up-mixing and down-mixing connections to any inputs to the node. Its usage and precise definition depend on the value of AudioNode.channelCountMode.
- Inherited from:
- AudioNode
Represents an enumerated value describing the way channels must be matched between the node's inputs and outputs.
Represents an enumerated value describing the way channels must be matched between the node's inputs and outputs.
- Inherited from:
- AudioNode
Represents an enumerated value describing the meaning of the channels. This interpretation will define how audio up-mixing and down-mixing will happen.
Represents an enumerated value describing the meaning of the channels. This interpretation will define how audio up-mixing and down-mixing will happen.
The possible values are "speakers" or "discrete".
- Inherited from:
- AudioNode
Returns the associated AudioContext, that is the object representing the processing graph the node is participating in.
Returns the associated AudioContext, that is the object representing the processing graph the node is participating in.
- Inherited from:
- AudioNode
Returns the number of inputs feeding the node. Source nodes are defined as nodes having a numberOfInputs property with a value of 0.
Returns the number of inputs feeding the node. Source nodes are defined as nodes having a numberOfInputs property with a value of 0.
- Inherited from:
- AudioNode
Returns the number of outputs coming out of the node. Destination nodes — like AudioDestinationNode — have a value of 0 for this attribute.
Returns the number of outputs coming out of the node. Destination nodes — like AudioDestinationNode — have a value of 0 for this attribute.
- Inherited from:
- AudioNode