Envelope is an ADSR envelope generator. Envelope outputs a signal which can be connected to an AudioParam or Tone.Signal.
/\
/ \
/ \
/ \
/ \___________
/ \
/ \
/ \
/ \
import { Envelope, Gain } from "tone";
// an amplitude envelope
const gainNode = new Gain();
const env = new Envelope({
attack: 0.1,
decay: 0.2,
sustain: 1,
release: 0.8,
});
env.connect(gainNode.gain);The period of time after the attack that it takes for the envelopeto fall to the sustain value. Value must be greater than 0.
The percent of the maximum value that the envelope rests at untilthe release is triggered.
The amount of time after the release is triggered it takes to reach 0.Value must be greater than 0.
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:
import { Envelope } from "tone";
const env = new Envelope();
env.attackCurve = "linear";
import { Envelope } from "tone";
const env = new Envelope();
// can also be an array
env.attackCurve = [0, 0.2, 0.3, 0.4, 1];
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.
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"
import { Envelope } from "tone";
const env = new Envelope();
env.decayCurve = "linear";
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 number of inputs feeding into the AudioNode. For source nodes, this will be 0.
The number of outputs of the AudioNode.
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.
import { Envelope } from "tone";
const env = new Envelope();
env.releaseCurve = "linear";
The duration in seconds of one sample.
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
Cancels all scheduled envelope changes after the given time.
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);
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.
Get the scheduled value at the given time. This will return the unconverted (raw) value.
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"
});
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
Trigger the attack/decay portion of the ADSR envelope.
import { AmplitudeEnvelope, Oscillator } from "tone";
const env = new AmplitudeEnvelope().toDestination();
const osc = new 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.
import { AmplitudeEnvelope, Oscillator } from "tone";
const env = new AmplitudeEnvelope().toDestination();
const osc = new Oscillator().connect(env).start();
// trigger the release 0.5 seconds after the attack
env.triggerAttackRelease(0.5);
Triggers the release of the envelope.
import { AmplitudeEnvelope, Oscillator } from "tone";
const env = new AmplitudeEnvelope().toDestination();
const osc = new Oscillator().connect(env).start();
env.triggerAttack();
// trigger the release half a second after the attack
env.triggerRelease("+0.5");