Tone.AutoPanner

↳ EXTENDS Tone.Effect

Tone.AutoPanner is a Tone.Panner with an LFO connected to the pan amount. More on using autopanners here.

CONSTRUCTOR

new Tone.AutoPanner ( [
frequency
] )
frequency

Rate of left-right oscillation.

optional

DEFAULTS

{
frequency : 1 ,
type : sine ,
depth : 1
}

EXAMPLE

//create an autopanner and start it's LFO
var autoPanner = new Tone.AutoPanner("4n").toMaster().start();
//route an oscillator through the panner and start it
var oscillator = new Tone.Oscillator().connect(autoPanner).start();

Members

∿

.depth

↝ NormalRange #

The amount of panning between left and right. 0 = always center. 1 = full range between left and right.

</>
∿

.frequency

↝ Frequency #

How fast the panner modulates between left and right.

</>
↳ inherited from Tone.AudioNode

.context

↝ Tone.Context READONLY #

Get the audio context belonging to this instance.

</>
↳ inherited from Tone.Effect
∿

.wet

↝ NormalRange #

The wet control is how much of the effected will pass through to the output. 1 = 100% effected signal, 0 = 100% dry signal.

</>

Methods

.unsync ( )

#
↪ returns Tone.AutoPanner

this

Unsync the panner from the transport

</>

.start ( )

#
time

When the LFO will start.

type: Time
default: now
↪ returns Tone.AutoPanner

this

Start the effect.

</>

.stop ( )

#
time

When the LFO will stop.

type: Time
default: now
↪ returns Tone.AutoPanner

this

Stop the effect.

</>

.sync ( )

#
delay

Delay time before starting the effect after the Transport has started.

type: Time
default: 0
↪ returns Tone.AutoPanner

this

Sync the panner to the transport.

</>

.dispose ( )

#
↪ returns Tone.AutoPanner

this

clean up

</>
↳ 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();
</>
↳ 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

</>
docs generated Sep 15 2019