Web/API/PannerNode/PannerNode

The PannerNode() constructor of the Web Audio API creates a new PannerNode object instance.

Syntax

var myPanner = new PannerNode(context, options);

Parameters

Inherits parameters from the AudioNodeOptions dictionary.

context: A BaseAudioContext representing the audio context you want the node to be associated with.
options Optional: A PannerOptions dictionary object defining the properties you want the PannerNode to have (It also inherits the options defined in the AudioNodeOptions dictionary.):

panningModel

The PannerNode.panningModel you want the PannerNode to have (the default is equalpower.)
distanceModel: The PannerNode.distanceModel you want the PannerNode to have (the default is inverse.)
positionX: The PannerNode.positionX you want the PannerNode to have (the default is 0.)
positionY: The PannerNode.positionY you want the PannerNode to have (the default is 0.)
positionZ: The PannerNode.positionZ you want the PannerNode to have (the default is 0.)
orientationX: The PannerNode.orientationX you want the PannerNode to have (the default is 1.)
orientationY: The PannerNode.orientationY you want the PannerNode to have (the default is 0.)
orientationZ: The PannerNode.orientationZ you want the PannerNode to have (the default is 0.)
refDistance: The PannerNode.refDistance you want the PannerNode to have. The default is 1, and negative values are not allowed.
maxDistance: The PannerNode.maxDistance you want the PannerNode to have. The default is 10000, and non-positive values are not allowed.
rollOffFactor: The PannerNode.rollOffFactor you want the PannerNode to have. The default is 1, and negative values are not allowed.
coneInnerAngle: The PannerNode.coneInnerAngle you want the PannerNode to have (the default is 360.)
coneOuterAngle: The PannerNode.coneOuterAngle you want the PannerNode to have (the default is 360.)
coneOuterGain: The PannerNode.coneOuterGain you want the PannerNode to have. The default is 0, and its value can be in the range 0–1.

Return value

A new PannerNode object instance.

Exceptions

RangeError: The refDistance, maxDistance, or rolloffFactor properties have been given a value that is outside the accepted range.
InvalidStateError: The coneOuterGain property has been given a value outside the accepted range (0–1).

Example

var ctx = new AudioContext();

var options = {
  positionX : 1,
  maxDistance: 5000
}

var myPanner = new PannerNode(ctx, options);

Specifications

Specification	Status	Comment
Web Audio APIThe definition of 'PannerNode()' in that specification.	Working Draft

Browser compatibility

Update compatibility data on GitHub

	Desktop						Mobile
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	Android webview	Chrome for Android	Firefox for Android	Opera for Android	Safari on iOS	Samsung Internet
`PannerNode()` constructor	Chrome Full support 55 Notes' Full support 55 Notes' Notes' Before Chrome 59, the default values were not supported.	Edge Full support 79	Firefox Full support 53	IE No support No	Opera Full support 42	Safari ?	WebView Android Full support 55 Notes' Full support 55 Notes' Notes' Before version 59, the default values were not supported.	Chrome Android Full support 55 Notes' Full support 55 Notes' Notes' Before Chrome 59, the default values were not supported.	Firefox Android Full support 53	Opera Android Full support 42	Safari iOS ?	Samsung Internet Android Full support 6.0 Notes' Full support 6.0 Notes' Notes' Before Samsung Internet 7.0, the default values were not supported.

Legend

Full support: Full support
No support: No support
Compatibility unknown: Compatibility unknown
See implementation notes.': See implementation notes.

PannerNode.PannerNode() by Mozilla Contributors is licensed under CC-BY-SA 2.5.