The PannerNode()
constructor of the Web Audio API creates a new PannerNode
object instance.
PannerNode()
Syntax
new PannerNode(context, options);
Parameters
- 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:-
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. -
channelCount
: Represents an integer used to determine how many channels are used when up-mixing and down-mixing connections to any inputs to the node. (SeeAudioNode.channelCount
for more information.) Its usage and precise definition depend on the value ofchannelCountMode
. -
channelCountMode
: Represents an enumerated value describing the way channels must be matched between the node's inputs and outputs. (SeeAudioNode.channelCountMode
for more information including default values.) -
channelInterpretation
: 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"
. (SeeAudioNode.channelCountMode
for more information including default values.)
-
Return value
A new PannerNode
object instance.
Exceptions
-
RangeError
DOMException
-
Thrown if the
refDistance
,maxDistance
, orrolloffFactor
properties have been given a value that is outside the accepted range. -
InvalidStateError
DOMException
-
Thrown if the
coneOuterGain
property has been given a value outside the accepted range (0–1).
Examples
var ctx = new AudioContext(); var options = { positionX : 1, maxDistance: 5000 } var myPanner = new PannerNode(ctx, options);
Specifications
Specification |
---|
Web Audio API # dom-pannernode-pannernode |
Browser compatibility
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | |
PannerNode |
55
Before Chrome 59, the default values were not supported.
|
79
|
53
|
No
|
42
|
14.1
|
55
Before version 59, the default values were not supported.
|
55
Before Chrome 59, the default values were not supported.
|
53
|
42
|
14.5
|
6.0
Before Samsung Internet 7.0, the default values were not supported.
|
© 2005–2021 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/PannerNode/PannerNode