PannerNode

The PannerNode interface represents the position and behavior of an audio source signal in space. It is an AudioNode audio-processing module describing its position with right-hand Cartesian coordinates, its movement using a velocity vector and its directionality using a directionality cone.

A PannerNode always has exactly one input and one output: the input can be mono or stereo but the output is always stereo (2 channels); you can't have panning effects without at least two audio channels!

The PannerNode brings a spatial position and velocity and a directionality for a given signal.

Number of inputs 1
Number of outputs 1
Channel count mode "clamped-max"
Channel count 2
Channel interpretation "speakers"

Constructor

PannerNode()

Creates a new PannerNode object instance.

Properties

Inherits properties from its parent, AudioNode.

Note: The orientation and position value are set and retrieved using different syntaxes, since they're stored as AudioParam values. Retrieval is done by accessing, for example, PannerNode.positionX. While setting the same property is done with PannerNode.positionX.value. This is why these values are not marked read only, which is how they appear in the WebIDL.

PannerNode.coneInnerAngle

Is a double value describing the angle, in degrees, of a cone inside of which there will be no volume reduction.

PannerNode.coneOuterAngle

A double value describing the angle, in degrees, of a cone outside of which the volume will be reduced by a constant value, defined by the coneOuterGain attribute.

PannerNode.coneOuterGain

A double value describing the amount of volume reduction outside the cone defined by the coneOuterAngle attribute. Its default value is 0, meaning that no sound can be heard.

PannerNode.distanceModel

An enumerated value determining which algorithm to use to reduce the volume of the audio source as it moves away from the listener. Possible values are "linear", "inverse" and "exponential". The default value is "inverse".

PannerNode.maxDistance

A double value representing the maximum distance between the audio source and the listener, after which the volume is not reduced any further.

PannerNode.orientationX

Represents the horizontal position of the audio source's vector in a right-hand cartesian coordinate system. While this AudioParam cannot be directly changed, its value can be altered using its value property. The default is value is 1.

PannerNode.orientationY

Represents the vertical position of the audio source's vector in a right-hand cartesian coordinate system. The default is 0. While this AudioParam cannot be directly changed, its value can be altered using its value property. The default is value is 0.

PannerNode.orientationZ

Represents the longitudinal (back and forth) position of the audio source's vector in a right-hand cartesian coordinate system. The default is 0. While this AudioParam cannot be directly changed, its value can be altered using its value property. The default is value is 0.

PannerNode.panningModel

An enumerated value determining which spatialisation algorithm to use to position the audio in 3D space.

PannerNode.positionX

Represents the horizontal position of the audio in a right-hand cartesian coordinate system. The default is 0. While this AudioParam cannot be directly changed, its value can be altered using its value property. The default is value is 0.

PannerNode.positionY

Represents the vertical position of the audio in a right-hand cartesian coordinate system. The default is 0. While this AudioParam cannot be directly changed, its value can be altered using its value property. The default is value is 0.

PannerNode.positionZ

Represents the longitudinal (back and forth) position of the audio in a right-hand cartesian coordinate system. The default is 0. While this AudioParam cannot be directly changed, its value can be altered using its value property. The default is value is 0.

PannerNode.refDistance

A double value representing the reference distance for reducing volume as the audio source moves further from the listener. For distances greater than this the volume will be reduced based on rolloffFactor and distanceModel.

PannerNode.rolloffFactor

A double value describing how quickly the volume is reduced as the source moves away from the listener. This value is used by all distance models.

Methods

Inherits methods from its parent, AudioNode.

PannerNode.setPosition()

Defines the position of the audio source relative to the listener (represented by an AudioListener object stored in the BaseAudioContext.listener attribute.)

PannerNode.setOrientation()

Defines the direction the audio source is playing in.

PannerNode.setVelocity()

Defines the velocity vector of the audio source — how fast it is moving and in what direction. In a previous version of the specification, the PannerNode had a velocity that could pitch up or down AudioBufferSourceNodes connected downstream. This feature was not clearly specified and had a number of issues, so it was removed from the specification.

Examples

See BaseAudioContext.createPanner() for example code.

Specifications

Specification
Web Audio API
# PannerNode

Browser compatibility

BCD tables only load in the browser

See also