PannerNode.orientationY

The orientationY property of the PannerNode interface indicates the Y (vertical) component of the direction the audio source is facing, in 3D Cartesian coordinate space.

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.

Syntax

var orientationY = PannerNode.orientationY;

PannerNode.orientationY.value = newOrientationY;

Value

An AudioParam whose value is the Y component of the direction the audio source is facing, in 3D Cartesian coordinate space.

Example

See PannerNode.orientationX for example code that demonstrates the effect on volume of changing the PannerNode orientation parameters in combination with coneInnerAngle and coneOuterAngle.

Specifications

Specification
Web Audio API
# dom-pannernode-orientationy

Browser compatibility

BCD tables only load in the browser

See also