PannerNode

package js.html.audio

extends AudioNode › EventTarget

Available on js

A PannerNode always has exactly one input and one output: the input can be mono or stereo but the output is always stereo (2 channels); you can't have panning effects without at least two audio channels!

Documentation PannerNode by Mozilla Contributors, licensed under CC-BY-SA 2.5.

See also:

• https://developer.mozilla.org/en-US/docs/Web/API/PannerNode

Constructor

new(context:BaseAudioContext, ?options:Null<PannerOptions>)

Throws:

null	DOMError

Variables

coneInnerAngle:Float

Is a double value describing the angle, in degrees, of a cone inside of which there will be no volume reduction.

coneOuterAngle:Float

A double value describing the angle, in degrees, of a cone outside of which the volume will be reduced by a constant value, defined by the coneOuterGain attribute.

coneOuterGain:Float

A double value describing the amount of volume reduction outside the cone defined by the coneOuterAngle attribute. Its default value is 0, meaning that no sound can be heard.

distanceModel:DistanceModelType

An enumerated value determining which algorithm to use to reduce the volume of the audio source as it moves away from the listener.

maxDistance:Float

A double value representing the maximum distance between the audio source and the listener, after which the volume is not reduced any further.

read onlyorientationX:AudioParam

Represents the horizontal position of the audio source's vector in a right-hand cartesian coordinate sytem. While this AudioParam cannot be directly changed, its value can be altered using its AudioParam.value property. The default is value is 1.

read onlyorientationY:AudioParam

Represents the vertical position of the audio source's vector in a right-hand cartesian coordinate sytem. The default is 0. While this AudioParam cannot be directly changed, its value can be altered using its AudioParam.value property. The default is value is 0.

read onlyorientationZ:AudioParam

Represents the longitudinal (back and forth) position of the audio source's vector in a right-hand cartesian coordinate sytem. The default is 0. While this AudioParam cannot be directly changed, its value can be altered using its AudioParam.value property. The default is value is 0.

panningModel:PanningModelType

An enumerated value determining which spatialisation algorithm to use to position the audio in 3D space.

read onlypositionX:AudioParam

Represents the horizontal position of the audio in a right-hand cartesian coordinate sytem. The default is 0. While this AudioParam cannot be directly changed, its value can be altered using its AudioParam.value property. The default is value is 0.

read onlypositionY:AudioParam

Represents the vertical position of the audio in a right-hand cartesian coordinate sytem. The default is 0. While this AudioParam cannot be directly changed, its value can be altered using its AudioParam.value property. The default is value is 0.

read onlypositionZ:AudioParam

Represents the longitudinal (back and forth) position of the audio in a right-hand cartesian coordinate sytem. The default is 0. While this AudioParam cannot be directly changed, its value can be altered using its AudioParam.value property. The default is value is 0.

refDistance:Float

A double value representing the reference distance for reducing volume as the audio source moves further from the listener.

rolloffFactor:Float

A double value describing how quickly the volume is reduced as the source moves away from the listener. This value is used by all distance models.

Methods

setOrientation(x:Float, y:Float, z:Float):Void

Defines the direction the audio source is playing in.

setPosition(x:Float, y:Float, z:Float):Void

Defines the position of the audio source relative to the listener (represented by an AudioListener object stored in the AudioContext.listener attribute.)