Tone.AutoWah

↳ EXTENDS Tone.Effect

Tone.AutoWah connects a Tone.Follower to a bandpass filter (Tone.Filter). The frequency of the filter is adjusted proportionally to the incoming signal’s amplitude. Inspiration from Tuna.js.

CONSTRUCTOR

new Tone.AutoWah ( [
baseFrequency
] , [
octaves
] , [
sensitivity
] )
baseFrequency

The frequency the filter is set to at the low point of the wah

optional
octaves

The number of octaves above the baseFrequency the filter will sweep to when fully open

optional
sensitivity

The decibel threshold sensitivity for the incoming signal. Normal range of -40 to 0.

optional

DEFAULTS

{
baseFrequency : 100 ,
octaves : 6 ,
sensitivity : 0 ,
Q : 2 ,
gain : 2 ,
follower :
{
attack : 0.3 ,
release : 0.5
}
}

EXAMPLE

var autoWah = new Tone.AutoWah(50, 6, -30).toMaster();
//initialize the synth and connect to autowah
var synth = new Synth.connect(autoWah);
//Q value influences the effect of the wah - default is 2
autoWah.Q.value = 6;
//more audible on higher notes
synth.triggerAttackRelease("C4", "8n")

Members

.Q

Positive #

The quality of the filter.

</>

.baseFrequency

Frequency #

The base frequency from which the sweep will start from.

</>

.gain

Number #

The gain of the filter.

</>

.octaves

Number #

The number of octaves that the filter will sweep above the baseFrequency.

</>

.sensitivity

Decibels #

The sensitivity to control how responsive to the input signal the filter is.

</>
inherited from Tone.AudioNode

.context

Tone.Context READONLY #

Get the audio context belonging to this instance.

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

.numberOfOutputs

Number READONLY #

The number of outputs coming out of the AudioNode.

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

.dispose ( )

#
↪ returns Tone.AutoWah

this

Clean up.

</>
inherited from Tone.AudioNode

.chain ( )

#
nodes
↪ returns Tone.AudioNode

this

Connect the output of this node to the rest of the nodes in series.

EXAMPLE

//connect a node to an effect, panVol and then to the master output
 node.chain(effect, panVol, Tone.Master);
 
</>
inherited from Tone.AudioNode

.connect ( )

#
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

.fan ( )

#
nodes
↪ returns Tone.AudioNode

this

connect the output of this node to the rest of the nodes in parallel.

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