PannerNode: positionY property
The positionY
property of the PannerNode
interface specifies the Y coordinate of the audio source's position in 3D Cartesian
coordinates, corresponding to the vertical axis (top-bottom). The complete
vector is defined by the position of the audio source, given as
(positionX
, positionY
, positionZ
), and the orientation
of the audio source (that is, the direction in which it's facing), given as
(orientationX
,
orientationY
,
orientationZ
).
Depending on the directionality of the sound (as specified using the attributes
coneInnerAngle
,
coneOuterAngle
, and
codeOuterGain
), the orientation of the
sound may alter the perceived volume of the sound as it's being played. If the sound
is pointing toward the listener, it will be louder than if the sound is pointed away
from the listener.
The AudioParam
contained by this property is read only; however, you
can still change the value of the parameter by assigning a new value to its
AudioParam.value
property.
Value
An AudioParam
whose value
is the Y coordinate of the audio
source's position, in 3D Cartesian coordinates.
Examples
The following example starts an oscillator and pans it above the listener after 1 second, below the listener after 2 seconds, and back to the center after 3 seconds. Note that in this case, the change will mainly affect the timbre of the oscillator, as it's a simple mono wave.
const context = new AudioContext();
const osc = new OscillatorNode(context);
const panner = new PannerNode(context);
panner.panningModel = "HRTF";
panner.positionY.setValueAtTime(1, context.currentTime + 1);
panner.positionY.setValueAtTime(-1, context.currentTime + 2);
panner.positionY.setValueAtTime(0, context.currentTime + 3);
osc.connect(panner).connect(context.destination);
osc.start(0);
Specifications
Specification |
---|
Web Audio API # dom-pannernode-positiony |
Browser compatibility
BCD tables only load in the browser