Tone.Chorus

↳ EXTENDS Tone.StereoEffect

Tone.Chorus is a stereo chorus effect composed of a left and right delay with a Tone.LFO applied to the delayTime of each channel. Inspiration from Tuna.js. Read more on the chorus effect on SoundOnSound.

CONSTRUCTOR

new Tone.Chorus ( [
frequency
] , [
delayTime
] , [
depth
] )
frequency

The frequency of the LFO.

optional
delayTime

The delay of the chorus effect in ms.

optional
depth

The depth of the chorus.

optional

DEFAULTS

{
frequency : 1.5 ,
delayTime : 3.5 ,
depth : 0.7 ,
type : sine ,
spread : 180
}

EXAMPLE

var chorus = new Tone.Chorus(4, 2.5, 0.5);
var synth = new Tone.PolySynth(4, Tone.MonoSynth).connect(chorus);
synth.triggerAttackRelease(["C3","E3","G3"], "8n");

Members

.frequency

Frequency #

The frequency of the LFO which modulates the delayTime.

</>

.delayTime

Milliseconds #

The delayTime in milliseconds of the chorus. A larger delayTime will give a more pronounced effect. Nominal range a delayTime is between 2 and 20ms.

</>

.depth

NormalRange #

The depth of the effect. A depth of 1 makes the delayTime modulate between 0 and 2*delayTime (centered around the delayTime).

</>

.spread

Degrees #

Amount of stereo spread. When set to 0, both LFO’s will be panned centrally. When set to 180, LFO’s will be panned hard left and right respectively.

</>

.type

string #

The oscillator type of the LFO.

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

.wet

NormalRange #

The wet control, i.e. how much of the effected will pass through to the output.

</>

Methods

.dispose ( )

#
↪ returns Tone.Chorus

this

Clean up.

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

.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