PannerNode: setPosition() method

Deprecated: This feature is no longer recommended. Though some browsers might still support it, it may have already been removed from the relevant web standards, may be in the process of being dropped, or may only be kept for compatibility purposes. Avoid using it, and update existing code if possible; see the compatibility table at the bottom of this page to guide your decision. Be aware that this feature may cease to work at any time.

Note: The suggested replacement for this deprecated method is to instead set the positionX, positionY, and positionZ attributes directly.

The setPosition() method of the PannerNode Interface defines the position of the audio source relative to the listener (represented by an AudioListener object stored in the 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
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 (undefined).

Examples

See BaseAudioContext.createPanner() for example code.

Specifications

Specification
Web Audio API
# dom-pannernode-setposition

Browser compatibility

BCD tables only load in the browser

See also