LFO stands for low frequency oscillator. 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.
import { Filter, LFO, Noise } from "tone";
const filter = new Filter().toDestination();
const noise = new Noise().connect(filter).start();
const lfo = new LFO("4n", 400, 4000).start();
// have it control the filters cutoff
lfo.connect(filter.frequency);The frequency of the oscillation.Typically, LFOs will be in the frequency range of 0.1 to 10 hertz.
The minimum output value of the LFO.
The maximum value of the LFO.
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.
The number of seconds of 1 processing block (128 samples)
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 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 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".
The context belonging to the node.
If the input value is converted using the units
Set this debug flag to log all events that happen in this class.
Indicates if the instance was disposed. 'Disposing' an instance means that all of the Web Audio nodes that were created for the instance are disconnected and freed for garbage collection.
The frequency value of the LFO
The number of inputs feeding into the AudioNode. For source nodes, this will be 0.
The number of outputs of the AudioNode.
The duration in seconds of one sample.
Returns the playback state of the source, either "started" or "stopped".
The type of the oscillator: See Oscillator.type
The version number semver
Connect the output of this node to the rest of the nodes in series.
import { Destination, Filter, Oscillator, Volume } from "tone";
const osc = new Oscillator().start();
const filter = new Filter();
const volume = new Volume(-8);
// connect a node to the filter, volume and then to the master output
osc.chain(filter, volume, Destination);
connect the output of a ToneAudioNode to an AudioParam, AudioNode, or ToneAudioNode
the optional output number
the input number
disconnect the output
connect the output of this node to the rest of the nodes in parallel.
Get the object's attributes.
import { Oscillator } from "tone";
const osc = new Oscillator();
console.log(osc.get());
// returns {"type" : "sine", "frequency" : 440, ...etc}
Returns all of the default options belonging to the class.
Return the current time of the Context clock without any lookAhead.
Return the current time of the Context clock plus the lookAhead.
Set multiple properties at once with an object.
import { Filter } from "tone";
const filter = new Filter();
// set values using an object
filter.set({
frequency: 300,
type: "highpass"
});
Sync the start/stop/pause to the transport and the frequency to the bpm of the transport
import { LFO } from "tone";
const lfo = new LFO("8n");
lfo.sync().start(0);
// the rate of the LFO will always be an eighth note, even as the tempo changes
Connect the output to the context's destination node.
Convert the input to a frequency number
Connect the output to the context's destination node. See toDestination
Convert the incoming time to seconds
Convert the class to a string
import { Oscillator } from "tone";
const osc = new Oscillator();
console.log(osc.toString());
Convert the input time into ticks
unsync the LFO from transport control