ContextQMD
Back to Content

PannerNode: setOrientation() method

files/en-us/web/api/pannernode/setorientation/index.md

latest1.6 KB
Original Source

{{APIRef("Web Audio API")}}{{Deprecated_Header}}

[!NOTE] The suggested replacement for this deprecated method is to instead set the orientationX, orientationY, and orientationZ attributes directly.

The setOrientation() method of the {{ domxref("PannerNode") }} Interface defines the direction the audio source is playing in.

This can have a big effect if the sound is very directional — controlled by the three cone-related attributes {{domxref("PannerNode.coneInnerAngle")}}, {{domxref("PannerNode.coneOuterAngle")}}, and {{domxref("PannerNode.coneOuterGain")}}. In such a case, a sound pointing away from the listener can be very quiet or even silent.

The three parameters x, y and z are unitless and describe a direction vector in 3D space using the right-hand Cartesian coordinate system. The default value of the direction vector is (1, 0, 0).

Syntax

js-nolint
setOrientation(x, y, z)

Parameters

  • x
    • : The x value of the panner's direction vector in 3D space.
  • y
    • : The y value of the panner's direction vector in 3D space.
  • z
    • : The z value of the panner's direction vector in 3D space.

Return value

None ({{jsxref("undefined")}}).

Examples

See BaseAudioContext.createPanner() for example code.

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also