PannerNode

@native @JSType
trait PannerNode extends AudioNode

The PannerNode interface represents the position and behavior of an audio source signal in space. It is an AudioNode audio-processing module describing its position with right-hand Cartesian coordinates, its movement using a velocity vector and its directionality using a directionality cone.

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 need stereo sound for panning effects!

The PannerNode brings a spatial position and velocity and a directionality for a given signal.

  • Number of inputs: 1
  • Number of outputs: 1
  • Channel count mode: "clamped-max"
  • Channel count: 2
  • Channel interpretation: "speakers"
trait AudioNode
class Object
trait Any
class Object
trait Matchable
class Any

Value members

Concrete methods

def setOrientation(x: Double, y: Double, z: Double): Unit

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 PannerNode.coneInnerAngle, PannerNode.coneOuterAngle, and PannerNode.coneOuterGain. In such a case, a sound pointing away from the listener can be very quiet or even silent.

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 PannerNode.coneInnerAngle, PannerNode.coneOuterAngle, and 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).

Value 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.

def setPosition(x: Double, y: Double, z: Double): Unit

Defines the position of the audio source relative to the listener (represented by an AudioListener object stored in the AudioContext.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.

Defines the position of the audio source relative to the listener (represented by an AudioListener object stored in the AudioContext.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).

Value 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.

def setVelocity(x: Double, y: Double, z: Double): Unit

Defines the velocity vector of the audio source — how fast it is moving and in what direction.

Defines the velocity vector of the audio source — how fast it is moving and in what direction.

The velocity relative to the listener is used to control the pitch change needed to conform with the Doppler effect due to the relative speed.

As the vector controls both the direction of travel and its velocity, the three parameters x, y and z are expressed in meters per second.

The default value of the velocity vector is (0, 0, 0).

Value parameters:
x

The x value of the panner's velocity vector.

y

The y value of the panner's velocity vector.

z

The z value of the panner's velocity vector.

Inherited methods

def addEventListener[T <: Event](`type`: String, listener: Function1[T, _], options: EventListenerOptions): Unit

The EventTarget.addEventListener() method registers the specified listener on the EventTarget it's called on. The event target may be an Element in a document, the Document itself, a Window, or any other object that supports events (such as XMLHttpRequest).

The EventTarget.addEventListener() method registers the specified listener on the EventTarget it's called on. The event target may be an Element in a document, the Document itself, a Window, or any other object that supports events (such as XMLHttpRequest).

This implementation accepts a settings object of type EventListenerOptions.

Inherited from:
EventTarget
def addEventListener[T <: Event](`type`: String, listener: Function1[T, _], useCapture: Boolean): Unit

The EventTarget.addEventListener() method registers the specified listener on the EventTarget it's called on. The event target may be an Element in a document, the Document itself, a Window, or any other object that supports events (such as XMLHttpRequest).

The EventTarget.addEventListener() method registers the specified listener on the EventTarget it's called on. The event target may be an Element in a document, the Document itself, a Window, or any other object that supports events (such as XMLHttpRequest).

Inherited from:
EventTarget
def connect(audioParam: AudioParam): Unit

Allows us to connect one output of this node to one input of an audio parameter.

Allows us to connect one output of this node to one input of an audio parameter.

Inherited from:
AudioNode
def connect(audioNode: AudioNode): Unit

Allows us to connect one output of this node to one input of another node.

Allows us to connect one output of this node to one input of another node.

Inherited from:
AudioNode
def disconnect(output: AudioNode): Unit

Allows us to disconnect the current node from another one it is already connected to.

Allows us to disconnect the current node from another one it is already connected to.

Value parameters:
output

The index describing which output of the AudioNode is going to be disconnected.

Inherited from:
AudioNode
def dispatchEvent(evt: Event): Boolean

Dispatches an Event at the specified EventTarget, invoking the affected EventListeners in the appropriate order. The normal event processing rules (including the capturing and optional bubbling phase) apply to events dispatched manually with dispatchEvent().

Dispatches an Event at the specified EventTarget, invoking the affected EventListeners in the appropriate order. The normal event processing rules (including the capturing and optional bubbling phase) apply to events dispatched manually with dispatchEvent().

Inherited from:
EventTarget
def hasOwnProperty(v: String): Boolean
Inherited from:
Object
def isPrototypeOf(v: Object): Boolean
Inherited from:
Object
def propertyIsEnumerable(v: String): Boolean
Inherited from:
Object
def removeEventListener[T <: Event](`type`: String, listener: Function1[T, _], options: EventListenerOptions): Unit

Removes the event listener previously registered with EventTarget.addEventListener.

Removes the event listener previously registered with EventTarget.addEventListener.

This implementation accepts a settings object of type EventListenerOptions.

Inherited from:
EventTarget
def removeEventListener[T <: Event](`type`: String, listener: Function1[T, _], useCapture: Boolean): Unit

Removes the event listener previously registered with EventTarget.addEventListener.

Removes the event listener previously registered with EventTarget.addEventListener.

Inherited from:
EventTarget
def toLocaleString(): String
Inherited from:
Object
def valueOf(): Any
Inherited from:
Object

Concrete fields

var coneInnerAngle: Double

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

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

var coneOuterAngle: Double

Is 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.

Is 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.

var coneOuterGain: Double

Is a double value describing the amount of volume reduction outside the cone defined by the coneOuterAngle attribute.

Is 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.

var distanceModel: String

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

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

var maxDistance: Double

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

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

var panningModel: String

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

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

var refDistance: Double

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

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

var rolloffFactor: Double

Is 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.

Is 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.

Inherited fields

var channelCount: Int

Represents an integer used to determine how many channels are used when up-mixing and down-mixing connections to any inputs to the node. Its usage and precise definition depend on the value of AudioNode.channelCountMode.

Represents an integer used to determine how many channels are used when up-mixing and down-mixing connections to any inputs to the node. Its usage and precise definition depend on the value of AudioNode.channelCountMode.

Inherited from:
AudioNode

Represents an enumerated value describing the way channels must be matched between the node's inputs and outputs.

Represents an enumerated value describing the way channels must be matched between the node's inputs and outputs.

Inherited from:
AudioNode

Represents an enumerated value describing the meaning of the channels. This interpretation will define how audio up-mixing and down-mixing will happen.

Represents an enumerated value describing the meaning of the channels. This interpretation will define how audio up-mixing and down-mixing will happen.

The possible values are "speakers" or "discrete".

Inherited from:
AudioNode

Returns the associated AudioContext, that is the object representing the processing graph the node is participating in.

Returns the associated AudioContext, that is the object representing the processing graph the node is participating in.

Inherited from:
AudioNode

Returns the number of inputs feeding the node. Source nodes are defined as nodes having a numberOfInputs property with a value of 0.

Returns the number of inputs feeding the node. Source nodes are defined as nodes having a numberOfInputs property with a value of 0.

Inherited from:
AudioNode

Returns the number of outputs coming out of the node. Destination nodes — like AudioDestinationNode — have a value of 0 for this attribute.

Returns the number of outputs coming out of the node. Destination nodes — like AudioDestinationNode — have a value of 0 for this attribute.

Inherited from:
AudioNode