FrequencyEnvelope is an Envelope which ramps between baseFrequency and octaves. It can also have an optional exponent to adjust the curve which it ramps.
const oscillator = new Tone.Oscillator().toDestination().start();
const freqEnv = new Tone.FrequencyEnvelope({
attack: 0.2,
baseFrequency: "C2",
octaves: 4
});
freqEnv.connect(oscillator.frequency);
freqEnv.triggerAttack();
When triggerAttack is called, the attack time is the amount of time it takes for the envelope to reach it's maximum value.
/\
/X \
/XX \
/XXX \
/XXXX \___________
/XXXXX \
/XXXXXX \
/XXXXXXX \
/XXXXXXXX \
The shape of the attack. Can be any of these strings:
const env = new Tone.Envelope(0.4).toDestination();
env.attackCurve = "linear";
env.triggerAttack();
The envelope's minimum output value. This is the value which it starts at.
The number of seconds of 1 processing block (128 samples)
console.log(Tone.Destination.blockTime);
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.
After the attack portion of the envelope, the value will fall over the duration of the decay time to it's sustain value.
/\
/ X\
/ XX\
/ XXX\
/ XXXX\___________
/ XXXXX \
/ XXXXX \
/ XXXXX \
/ XXXXX \
The shape of the decay either "linear" or "exponential"
const env = new Tone.Envelope({
sustain: 0.1,
decay: 0.5
}).toDestination();
env.decayCurve = "linear";
env.triggerAttack();
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 envelope's exponent value.
Envelope has no input
The number of inputs feeding into the AudioNode. For source nodes, this will be 0.
const node = new Tone.Gain();
console.log(node.numberOfInputs);
The number of outputs of the AudioNode.
const node = new Tone.Gain();
console.log(node.numberOfOutputs);
The number of octaves above the baseFrequency that the envelope will scale to.
The output signal of the envelope
After triggerRelease is called, the envelope's value will fall to it's miminum value over the duration of the release time.
/\
/ \
/ \
/ \
/ \___________
/ X\
/ XX\
/ XXX\
/ XXXX\
The shape of the release. See the attack curve types.
const env = new Tone.Envelope({
release: 0.8
}).toDestination();
env.triggerAttack();
// release curve could also be defined by an array
env.releaseCurve = [1, 0.3, 0.4, 0.2, 0.7, 0];
env.triggerRelease(0.2);
The duration in seconds of one sample.
console.log(Tone.Transport.sampleTime);
The sustain value is the value which the envelope rests at after triggerAttack is called, but before triggerRelease is invoked.
/\
/ \
/ \
/ \
/ \___________
/ XXXXXXXXXXX\
/ XXXXXXXXXXX \
/ XXXXXXXXXXX \
/ XXXXXXXXXXX \
Read the current value of the envelope. Useful for synchronizing visual output to the envelope.
The version number semver
Render the envelope curve to an array of the given length. Good for visualizing the envelope curve. Rescales the duration of the envelope to fit the length.
Cancels all scheduled envelope changes after the given time.
Connect the output of this node to the rest of the nodes in series.
const player = new Tone.Player("https://tonejs.github.io/examples/audio/FWDL.mp3");
player.autostart = true;
const filter = new Tone.AutoFilter(4).start();
const distortion = new Tone.Distortion(0.5);
// connect the player to the filter, distortion and then to the master output
player.chain(filter, distortion, Tone.Destination);
Connect the envelope to a destination node.
disconnect the output
connect the output of this node to the rest of the nodes in parallel.
const player = new Tone.Player("https://tonejs.github.io/examples/audio/FWDL.mp3");
player.autostart = true;
const pitchShift = new Tone.PitchShift(4).toDestination();
const filter = new Tone.Filter("G5").toDestination();
// connect a node to the pitch shift and filter in parallel
player.fan(pitchShift, filter);
Get the object's attributes.
const osc = new Tone.Oscillator();
console.log(osc.get());
Returns all of the default options belonging to the class.
Get the scheduled value at the given time. This will return the unconverted (raw) value.
const env = new Tone.Envelope(0.5, 1, 0.4, 2);
env.triggerAttackRelease(2);
setInterval(() => console.log(env.getValueAtTime), 100);
Return the current time of the Context clock without any lookAhead.
setInterval(() => {
console.log(Tone.immediate());
}, 100);
Return the current time of the Context clock plus the lookAhead.
setInterval(() => {
console.log(Tone.now());
}, 100);
Set multiple properties at once with an object.
const filter = new Tone.Filter();
// set values using an object
filter.set({
frequency: 300,
type: "highpass"
});
Connect the output to the context's destination node.
const osc = new Tone.Oscillator("C2").start();
osc.toDestination();
Convert the input to a frequency number
const gain = new Tone.Gain();
console.log(gain.toFrequency("4n"));
Connect the output to the context's destination node. See toDestination
Convert the incoming time to seconds
const gain = new Tone.Gain();
console.log(gain.toSeconds("4n"));
Convert the class to a string
const osc = new Tone.Oscillator();
console.log(osc.toString());
Convert the input time into ticks
const gain = new Tone.Gain();
console.log(gain.toTicks("4n"));
Trigger the attack/decay portion of the ADSR envelope.
const env = new Tone.AmplitudeEnvelope().toDestination();
const osc = new Tone.Oscillator().connect(env).start();
// trigger the attack 0.5 seconds from now with a velocity of 0.2
env.triggerAttack("+0.5", 0.2);
triggerAttackRelease is shorthand for triggerAttack, then waiting some duration, then triggerRelease.
const env = new Tone.AmplitudeEnvelope().toDestination();
const osc = new Tone.Oscillator().connect(env).start();
// trigger the release 0.5 seconds after the attack
env.triggerAttackRelease(0.5);
Triggers the release of the envelope.
const env = new Tone.AmplitudeEnvelope().toDestination();
const osc = new Tone.Oscillator({
type: "sawtooth"
}).connect(env).start();
env.triggerAttack();
// trigger the release half a second after the attack
env.triggerRelease("+0.5");