Tone.Follower

↳ EXTENDS Tone.AudioNode

Tone.Follower is a crude envelope follower which will follow the amplitude of an incoming signal. Take care with small (< 0.02) attack or decay values as follower has some ripple which is exaggerated at these values. Read more about envelope followers (also known as envelope detectors) on Wikipedia.

CONSTRUCTOR

new Tone.Follower ( [
attack
] , [
release
] )
attack

The rate at which the follower rises.

optional
release

The rate at which the folower falls.

type: Time
optional

DEFAULTS

{
attack : 0.05 ,
release : 0.5
}

EXAMPLE

var follower = new Tone.Follower(0.2, 0.4);

Members

.attack

Time #

The attack time.

</>

.release

Time #

The release time.

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

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

</>

Methods

.connect ( )

#

Borrows the connect method from Signal so that the output can be used as a Tone.Signal control signal.

</>

.dispose ( )

#
↪ returns Tone.Follower

this

dispose

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