AudioListener
The AudioListener
interface represents the position and orientation of the unique person listening to the audio scene, and is used in audio spatialization. All PannerNode
s spatialize in relation to the AudioListener
stored in the BaseAudioContext.listener
attribute.
It is important to note that there is only one listener per context and that it isn't an AudioNode
.
Instance properties
Note: The position, forward, and up value are set and retrieved using different syntaxes. Retrieval is done by accessing, for example, AudioListener.positionX
, while setting the same property is done with AudioListener.positionX.value
. This is why these values are not marked read only, which is how they appear in the specification's IDL.
AudioListener.positionX
-
Represents the horizontal position of the listener in a right-hand cartesian coordinate system. The default is 0.
AudioListener.positionY
-
Represents the vertical position of the listener in a right-hand cartesian coordinate system. The default is 0.
AudioListener.positionZ
-
Represents the longitudinal (back and forth) position of the listener in a right-hand cartesian coordinate system. The default is 0.
AudioListener.forwardX
-
Represents the horizontal position of the listener's forward direction in the same cartesian coordinate system as the position (
positionX
,positionY
, andpositionZ
) values. The forward and up values are linearly independent of each other. The default is 0. AudioListener.forwardY
-
Represents the vertical position of the listener's forward direction in the same cartesian coordinate system as the position (
positionX
,positionY
, andpositionZ
) values. The forward and up values are linearly independent of each other. The default is 0. AudioListener.forwardZ
-
Represents the longitudinal (back and forth) position of the listener's forward direction in the same cartesian coordinate system as the position (
positionX
,positionY
, andpositionZ
) values. The forward and up values are linearly independent of each other. The default is -1. AudioListener.upX
-
Represents the horizontal position of the top of the listener's head in the same cartesian coordinate system as the position (
positionX
,positionY
, andpositionZ
) values. The forward and up values are linearly independent of each other. The default is 0. AudioListener.upY
-
Represents the vertical position of the top of the listener's head in the same cartesian coordinate system as the position (
positionX
,positionY
, andpositionZ
) values. The forward and up values are linearly independent of each other. The default is 1. AudioListener.upZ
-
Represents the longitudinal (back and forth) position of the top of the listener's head in the same cartesian coordinate system as the position (
positionX
,positionY
, andpositionZ
) values. The forward and up values are linearly independent of each other. The default is 0.
Instance methods
AudioListener.setOrientation()
Deprecated-
Sets the orientation of the listener.
AudioListener.setPosition()
Deprecated-
Sets the position of the listener.
Note: Although these methods are deprecated they are currently the only way to set the orientation and position in Firefox.
Deprecated features
The setOrientation()
and setPosition()
methods have been replaced by setting their property value equivalents. For example setPosition(x, y, z)
can be achieved by setting positionX.value
, positionY.value
, and positionZ.value
respectively.
Example
See BaseAudioContext.createPanner()
for example code.
Specifications
Specification |
---|
Web Audio API # AudioListener |
Browser compatibility
BCD tables only load in the browser