The pan
property of the StereoPannerNode
interface is an a-rate AudioParam
representing the amount of panning to apply. The value can range between -1
(full left pan) and 1
(full right pan).
Syntax
var audioCtx = new AudioContext();
var panNode = audioCtx.createStereoPanner();
panNode.pan.value = -0.5;
Returned value
An a-rate AudioParam
containing the panning to apply.
Note: Though the AudioParam
returned is read-only, the value it represents is not.
Example
In our [[../../../../../../../mdn.github.io/webaudio-examples/stereo-panner-node/index|StereoPannerNode example]] (see source code) HTML we have a simple <audio>
element along with a slider <input>
to increase and decrease pan value. In the JavaScript we create a MediaElementAudioSourceNode
and a StereoPannerNode
, and connect the two together using the connect()
method. We then use an oninput
event handler to change the value of the StereoPannerNode.pan
parameter and update the pan value display when the slider is moved.
Moving the slider left and right while the music is playing pans the music across to the left and right speakers of the output, respectively.
var audioCtx = new (window.AudioContext || window.webkitAudioContext)();
var myAudio = document.querySelector('audio');
var panControl = document.querySelector('.panning-control');
var panValue = document.querySelector('.panning-value');
pre.innerHTML = myScript.innerHTML;
// Create a MediaElementAudioSourceNode
// Feed the HTMLMediaElement into it
var source = audioCtx.createMediaElementSource(myAudio);
// Create a stereo panner
var panNode = audioCtx.createStereoPanner();
// Event handler function to increase panning to the right and left
// when the slider is moved
panControl.oninput = function() {
panNode.pan.setValueAtTime(panControl.value, audioCtx.currentTime);
panValue.innerHTML = panControl.value;
}
// connect the MediaElementAudioSourceNode to the panNode
// and the panNode to the destination, so we can play the
// music and adjust the panning using the controls
source.connect(panNode);
panNode.connect(audioCtx.destination);
Specifications
Specification | Status | Comment |
Web Audio APIThe definition of 'pan' in that specification. | Working Draft |
Browser compatibility
The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
Update compatibility data on GitHub
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
pan
|
Chrome
Full support 41 |
Edge
Full support 12 |
Firefox
Full support 37 |
IE
No support No |
Opera
Full support 28 |
Safari
No support No |
WebView Android
Full support 41 |
Chrome Android
Full support 41 |
Firefox Android
Full support 37 |
Opera Android
Full support 28 |
Safari iOS
No support No |
Samsung Internet Android
Full support 4.0 |
Legend
- Full support
- Full support
- No support
- No support
See also
StereoPannerNode.pan by Mozilla Contributors is licensed under CC-BY-SA 2.5.