Tone.AutoFilter

↳ EXTENDS Tone.Effect

Tone.AutoFilter is a Tone.Filter with a Tone.LFO connected to the filter cutoff frequency. Setting the LFO rate and depth allows for control over the filter modulation rate and depth.

CONSTRUCTOR

new Tone.AutoFilter ( [
frequency
] , [
baseFrequency
] , [
octaves
] )
frequency

The rate of the LFO.

optional
baseFrequency

The lower value of the LFOs oscillation

optional
octaves

The number of octaves above the baseFrequency

optional

DEFAULTS

{
frequency : 1 ,
type : sine ,
depth : 1 ,
baseFrequency : 200 ,
octaves : 2.6 ,
filter :
{
type : lowpass ,
rolloff : -12 ,
Q : 1
}
}

EXAMPLE

//create an autofilter and start it's LFO
var autoFilter = new Tone.AutoFilter("4n").toMaster().start();
//route an oscillator through the filter and start it
var oscillator = new Tone.Oscillator().connect(autoFilter).start();

Members

.type

↝ string #

Type of oscillator attached to the AutoFilter. Possible values: “sine”, “square”, “triangle”, “sawtooth”.

</>
∿

.depth

↝ NormalRange #

The range of the filter modulating between the min and max frequency. 0 = no modulation. 1 = full modulation.

</>

.filter

↝ Tone.Filter #

The filter node

</>
∿

.frequency

↝ Frequency #

How fast the filter modulates between min and max.

</>

.min

↝ Frequency #

The minimum value of the filter’s cutoff frequency.

</>

.octaves

↝ Positive #

The maximum value of the filter’s cutoff frequency.

</>

.type

↝ string #

Type of oscillator attached to the AutoFilter. Possible values: “sine”, “square”, “triangle”, “sawtooth”.

</>
↳ 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.AutoFilter

this

Unsync the filter from the transport.

</>

.start ( )

#
time

When the LFO will start.

type: Time
default: now
↪ returns Tone.AutoFilter

this

Start the effect.

</>

.stop ( )

#
time

When the LFO will stop.

type: Time
default: now
↪ returns Tone.AutoFilter

this

Stop the effect.

</>

.sync ( )

#
delay

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

type: Time
default: 0
↪ returns Tone.AutoFilter

this

Sync the filter to the transport.

</>

.dispose ( )

#
↪ returns Tone.AutoFilter

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