AutoFilter is a Tone.Filter with a Tone.LFO connected to the filter cutoff frequency. Setting the LFO rate and depth allows for control over the filter modulation rate and depth.
import { AutoFilter, Oscillator } from "tone";
// create an autofilter and start it's LFO
const autoFilter = new AutoFilter("4n").toDestination().start();
// route an oscillator through the filter and start it
const oscillator = new Oscillator().connect(autoFilter).start();The minimum value of the filter's cutoff frequency.
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.
Set this debug flag to log all events that happen in this class.
The range of the filter modulating between the min and max frequency. 0 = no modulation. 1 = full modulation.
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.
How fast the filter modulates between min and max.
The number of inputs feeding into the AudioNode. For source nodes, this will be 0.
The number of outputs of the AudioNode.
The maximum value of the filter's cutoff frequency.
The duration in seconds of one sample.
The type of the LFO's oscillator: See Oscillator.type
import { AutoFilter, Noise } from "tone";
const autoFilter = new AutoFilter().start().toDestination();
const noise = new Noise().start().connect(autoFilter);
autoFilter.type = "square";
The version number semver
The wet control is how much of the effected will pass through to the output. 1 = 100% effected signal, 0 = 100% dry signal.
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 output to connect from
The input to connect to
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 filter to the transport. See LFO.sync
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 filter from the transport.