Tone.FrequencyEnvelope
↳ EXTENDS Tone.EnvelopeTone.FrequencyEnvelope is a Tone.ScaledEnvelope, but instead of min and max it’s got a baseFrequency and octaves parameter.
CONSTRUCTOR
new Tone.FrequencyEnvelope ( [DEFAULTS
EXAMPLE
var env = new Tone.FrequencyEnvelope({
"attack" : 0.2,
"baseFrequency" : "C2",
"octaves" : 4
});
scaledEnv.connect(oscillator.frequency);Members
.baseFrequency
↝ Frequency #The envelope’s mininum output value. This is the value which it starts at.
.octaves
↝ Positive #The number of octaves above the baseFrequency that the envelope will scale to.
.context
↝ Tone.Context READONLY #Get the audio context belonging to this instance.
.releaseCurve
↝ String or Array #The shape of the release. See the attack curve types.
EXAMPLE
env.releaseCurve = "linear";.sustain
↝ NormalRange #The sustain value is the value which the envelope rests at after triggerAttack is called, but before triggerRelease is invoked.
.attack
↝ Time #When triggerAttack is called, the attack time is the amount of time it takes for the envelope to reach it’s maximum value.
.value
↝ Number READONLY #Read the current value of the envelope. Useful for syncronizing visual output to the envelope.
.attackCurve
↝ String or Array #The shape of the attack. Can be any of these strings: <ul> <li>linear</li> <li>exponential</li> <li>sine</li> <li>cosine</li> <li>bounce</li> <li>ripple</li> <li>step</li> </ul> Can also be an array which describes the curve. Values in the array are evenly subdivided and linearly interpolated over the duration of the attack.
EXAMPLE
env.attackCurve = "linear";EXAMPLE
//can also be an array
env.attackCurve = [0, 0.2, 0.3, 0.4, 1].decay
↝ Time #After the attack portion of the envelope, the value will fall over the duration of the decay time to it’s sustain value.
.release
↝ Time #After triggerRelease is called, the envelope’s value will fall to it’s miminum value over the duration of the release time.
Methods
.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();.triggerAttackRelease ( )
#The duration of the sustain.
When the attack should be triggered.
The velocity of the envelope.
this
triggerAttackRelease is shorthand for triggerAttack, then waiting some duration, then triggerRelease.
EXAMPLE
//trigger the attack and then the release after 0.6 seconds.
env.triggerAttackRelease(0.6);.cancel ( )
#this
Cancels all scheduled envelope changes after the given time.
.triggerRelease ( )
#When the release portion of the envelope should start.
this
Triggers the release of the envelope.
EXAMPLE
//trigger release immediately
env.triggerRelease();.getValueAtTime ( )
#Get the scheduled value at the given time. This will return the unconverted (raw) value.
.triggerAttack ( )
#When the attack should start.
The velocity of the envelope scales the vales. number between 0-1
this
Trigger the attack/decay portion of the ADSR envelope.
EXAMPLE
//trigger the attack 0.5 seconds from now with a velocity of 0.2
env.triggerAttack("+0.5", 0.2);