ContextQMD
Back to Content

PannerNode: setPosition() method

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

latest1.4 KB
Original Source

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

[!NOTE] The suggested replacement for this deprecated method is to instead set the positionX, positionY, and positionZ attributes directly.

The setPosition() method of the {{ domxref("PannerNode") }} Interface defines the position of the audio source relative to the listener (represented by an {{domxref("AudioListener")}} object stored in the {{domxref("BaseAudioContext.listener")}} attribute.) The three parameters x, y and z are unitless and describe the source's position in 3D space using the right-hand Cartesian coordinate system.

The setPosition() method's default value of the position is (0, 0, 0).

Syntax

js-nolint
setPosition(x, y, z)

Parameters

  • x
    • : The x position of the panner in 3D space.
  • y
    • : The y position of the panner in 3D space.
  • z
    • : The z position of the panner in 3D space.

Return value

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

Examples

See BaseAudioContext.createPanner() for example code.

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also