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 thePannerNode
to have (It also inherits the options defined in the AudioNodeOptions dictionary.):panningModel
: ThePannerNode.panningModel
you want thePannerNode
to have (the default isequalpower
.)distanceModel
: ThePannerNode.distanceModel
you want thePannerNode
to have (the default isinverse
.)positionX
: ThePannerNode.positionX
you want thePannerNode
to have (the default is0
.)positionY
: ThePannerNode.positionY
you want thePannerNode
to have (the default is0
.)positionZ
: ThePannerNode.positionZ
you want thePannerNode
to have (the default is0
.)orientationX
: ThePannerNode.orientationX
you want thePannerNode
to have (the default is1
.)orientationY
: ThePannerNode.orientationY
you want thePannerNode
to have (the default is0
.)orientationZ
: ThePannerNode.orientationZ
you want thePannerNode
to have (the default is0
.)refDistance
: ThePannerNode.refDistance
you want thePannerNode
to have. The default is1
, and negative values are not allowed.maxDistance
: ThePannerNode.maxDistance
you want thePannerNode
to have. The default is10000
, and non-positive values are not allowed.rollOffFactor
: ThePannerNode.rollOffFactor
you want thePannerNode
to have. The default is1
, and negative values are not allowed.coneInnerAngle
: ThePannerNode.coneInnerAngle
you want thePannerNode
to have (the default is360
.)coneOuterAngle
: ThePannerNode.coneOuterAngle
you want thePannerNode
to have (the default is360
.)coneOuterGain
: ThePannerNode.coneOuterGain
you want thePannerNode
to have. The default is0
, and its value can be in the range 0–1.
Return value
A new PannerNode
object instance.
Exceptions
RangeError
- The
refDistance
,maxDistance
, orrolloffFactor
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 API The definition of 'PannerNode()' in that specification. |
Working Draft |
Browser compatibility
BCD tables only load in the browser