Tone.LFO
↳ EXTENDS Tone.AudioNodeLFO stands for low frequency oscillator. Tone.LFO produces an output signal which can be attached to an AudioParam or Tone.Signal in order to modulate that parameter with an oscillator. The LFO can also be synced to the transport to start/stop and change when the tempo changes.
CONSTRUCTOR
new Tone.LFO ( [DEFAULTS
EXAMPLE
var lfo = new Tone.LFO("4n", 400, 4000);
lfo.connect(filter.frequency);Members
.state
↝ Tone.State READONLY #Returns the playback state of the source, either “started” or “stopped”.
.amplitude
↝ Number #The amplitude of the LFO, which controls the output range between the min and max output. For example if the min is -10 and the max is 10, setting the amplitude to 0.5 would make the LFO modulate between -5 and 5.
.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.
.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.
Methods
.start ( )
#Start the LFO.
.stop ( )
#Stop the LFO.
.sync ( )
#this
Sync the start/stop/pause to the transport and the frequency to the bpm of the transport
EXAMPLE
lfo.frequency.value = "8n";
lfo.sync().start(0)
//the rate of the LFO will always be an eighth note,
//even as the tempo changes.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.
.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);