Tone.Filter

↳ EXTENDS Tone.AudioNode

Tone.Filter is a filter which allows for all of the same native methods as the BiquadFilterNode. Tone.Filter has the added ability to set the filter rolloff at -12 (default), -24 and -48.

CONSTRUCTOR

new Tone.Filter ( [
frequency
] , [
type
] , [
rolloff
] )
frequency

The cutoff frequency of the filter.

optional
type

The type of filter.

type: string
optional
rolloff

The drop in decibels per octave after the cutoff frequency. 3 choices: -12, -24, and -48

type: number
optional

DEFAULTS

{
type : lowpass ,
frequency : 350 ,
rolloff : -12 ,
Q : 1 ,
gain : 0
}

EXAMPLE

var filter = new Tone.Filter(200, "highpass");

Members

.type

↝ string #

The type of the filter. Types: “lowpass”, “highpass”, “bandpass”, “lowshelf”, “highshelf”, “notch”, “allpass”, or “peaking”.

</>
∿

.detune

↝ Cents #

The detune parameter

</>
∿

.frequency

↝ Frequency #

The cutoff frequency of the filter.

</>
∿

.gain

↝ Number #

The gain of the filter, only used in certain filter types

</>

.rolloff

↝ number #

The rolloff of the filter which is the drop in db per octave. Implemented internally by cascading filters. Only accepts the values -12, -24, -48 and -96.

</>
∿

.Q

↝ Positive #

The Q or Quality of the filter

</>
↳ inherited from Tone.AudioNode

.numberOfInputs

↝ Number READONLY #

The number of inputs feeding into the AudioNode. For source nodes, this will be 0.

</>
↳ inherited from Tone.AudioNode

.channelCount

↝ Number READONLY #

channelCount is the number of channels used when up-mixing and down-mixing connections to any inputs to the node. The default value is 2 except for specific nodes where its value is specially determined.

</>
↳ inherited from Tone.AudioNode

.channelCountMode

↝ String READONLY #

channelCountMode determines how channels will be counted when up-mixing and down-mixing connections to any inputs to the node. The default value is “max”. This attribute has no effect for nodes with no inputs.

</>
↳ inherited from Tone.AudioNode

.channelInterpretation

↝ String READONLY #

channelInterpretation determines how individual channels will be treated when up-mixing and down-mixing connections to any inputs to the node. The default value is “speakers”.

</>
↳ inherited from Tone.AudioNode

.context

↝ Tone.Context READONLY #

Get the audio context belonging to this instance.

</>
↳ inherited from Tone.AudioNode

.numberOfOutputs

↝ Number READONLY #

The number of outputs coming out of the AudioNode.

</>

Methods

.dispose ( )

#
↪ returns Tone.Filter

this

Clean up.

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