Tone.Tremolo
↳ EXTENDS Tone.StereoEffectTone.Tremolo modulates the amplitude of an incoming signal using a Tone.LFO. The type, frequency, and depth of the LFO is controllable.
CONSTRUCTOR
new Tone.Tremolo ( [The rate of the effect.
The depth of the effect.
DEFAULTS
EXAMPLE
//create a tremolo and start it's LFO
var tremolo = new Tone.Tremolo(9, 0.75).toMaster().start();
//route an oscillator through the tremolo and start it
var oscillator = new Tone.Oscillator().connect(tremolo).start();Members
.depth
↝ NormalRange #The depth of the effect. A depth of 0, has no effect on the amplitude, and a depth of 1 makes the amplitude modulate fully between 0 and 1.
.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.
.numberOfInputs
↝ Number READONLY #The number of inputs feeding into the AudioNode. For source nodes, this will be 0.
.numberOfOutputs
↝ Number READONLY #The number of outputs coming out of the 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.
.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.
.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”.
.context
↝ Tone.Context READONLY #Get the audio context belonging to this instance.
.wet
↝ NormalRange #The wet control, i.e. how much of the effected will pass through to the output.
Methods
.start ( )
#When the tremolo begins.
this
Start the tremolo.
.stop ( )
#When the tremolo stops.
this
Stop the tremolo.
.sync ( )
#Delay time before starting the effect after the Transport has started.
this
Sync the effect to the transport.
.chain ( )
#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);
.connect ( )
#optionally which output to connect from
optionally which input to connect to
this
connect the output of a ToneNode to an AudioParam, AudioNode, or ToneNode
.disconnect ( )
#Either the output index to disconnect if the output is an array, or the node to disconnect from.
this
disconnect the output
.toMaster ( )
#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();.fan ( )
#this
connect the output of this node to the rest of the nodes in parallel.