Tone.Panner3D

↳ EXTENDS Tone.AudioNode

A spatialized panner node which supports equalpower or HRTF panning. Tries to normalize the API across various browsers. See Tone.Listener

CONSTRUCTOR

new Tone.Panner3D (
positionX
,
positionY
,
positionZ
)
positionX

The initial x position.

type: Number
positionY

The initial y position.

type: Number
positionZ

The initial z position.

type: Number

DEFAULTS

{
positionX : 0 ,
positionY : 0 ,
positionZ : 0 ,
orientationX : 0 ,
orientationY : 0 ,
orientationZ : 0 ,
panningModel : equalpower ,
maxDistance : 10000 ,
distanceModel : inverse ,
coneOuterGain : 0 ,
coneOuterAngle : 360 ,
coneInnerAngle : 360 ,
refDistance : 1 ,
rolloffFactor : 1
}

Members

.rolloffFactor

↝ Number #

Describes how quickly the volume is reduced as source moves away from listener.

</>

.coneOuterAngle

↝ Degrees #

The angle, in degrees, outside of which the volume will be reduced to a constant value of coneOuterGain

</>

.coneOuterGain

↝ Gain #

The gain outside of the coneOuterAngle

</>

.coneInnerAngle

↝ Degrees #

The angle, in degrees, inside of which there will be no volume reduction

</>

.distanceModel

↝ String #

The distance model used by, “linear”, “inverse”, or “exponential”.

</>

.maxDistance

↝ Positive #

The maximum distance between source and listener, after which the volume will not be reduced any further.

</>

.orientationX

↝ Number #

The x orientation of the panner object.

</>

.orientationY

↝ Number #

The y orientation of the panner object.

</>

.orientationZ

↝ Number #

The z orientation of the panner object.

</>

.panningModel

↝ String #

The panning model. Either “equalpower” or “HRTF”.

</>

.positionX

↝ Number #

The x position of the panner object.

</>

.positionY

↝ Number #

The y position of the panner object.

</>

.positionZ

↝ Number #

The z position of the panner object.

</>

.refDistance

↝ Number #

A reference distance for reducing volume as source move further from the listener

</>
↳ inherited from Tone.AudioNode

.context

↝ Tone.Context READONLY #

Get the audio context belonging to this instance.

</>

Methods

.dispose ( )

#
↪ returns Tone.Panner3D

this

Clean up.

</>

.setOrientation ( )

#
x
type: Number
y
type: Number
z
type: Number
↪ returns Tone.Panner3D

this

Sets the orientation of the source in 3d space.

</>

.setPosition ( )

#
x
type: Number
y
type: Number
z
type: Number
↪ returns Tone.Panner3D

this

Sets the position of the source in 3d space.

</>
↳ inherited from Tone.AudioNode

.connect ( )

#
unit
outputNum

optionally which output to connect from

type: number
default: 0
inputNum

optionally which input to connect to

type: number
default: 0
↪ returns Tone.AudioNode

this

connect the output of a ToneNode to an AudioParam, AudioNode, or ToneNode

</>
↳ inherited from Tone.AudioNode

.disconnect ( )

#
output

Either the output index to disconnect if the output is an array, or the node to disconnect from.
↪ returns Tone.AudioNode

this

disconnect the output

</>
↳ inherited from Tone.AudioNode

.toMaster ( )

#
↪ returns Tone.AudioNode

this

Connect ‘this’ to the master output. Shorthand for this.connect(Tone.Master)

EXAMPLE

//connect an oscillator to the master output
var osc = new Tone.Oscillator().toMaster();
</>
docs generated Sep 15 2019