Class: Envelope

Extends

• Tone

Members

attack :number

Type:

• number

Source:

• Tone.js, line 1187

control :Tone.Signal

Type:

• Tone.Signal

Source:

• Tone.js, line 1201

decay :number

Type:

• number

Source:

• Tone.js, line 1189

input :GainNode

default input of the ToneNode

Type:

• GainNode

Inherited From:

• Tone#input

Source:

• Tone.js, line 111

max :number

Type:

• number

Source:

• Tone.js, line 1198

min :number

Type:

• number

Source:

• Tone.js, line 1196

output :GainNode

default output of the ToneNode

Type:

• GainNode

Inherited From:

• Tone#output

Source:

• Tone.js, line 117

release :number

Type:

• number

Source:

• Tone.js, line 1191

sustain :number

Type:

• number

Source:

• Tone.js, line 1193

Methods

chain()

connect together all of the arguments in series

Parameters:

Type	Argument	Description
AudioParam | Tone	<repeatable>

Inherited From:

• Tone#chain

Source:

• Tone.js, line 168

connect(param)

connect the envelope

if the envelope is connected to a param, the params value will be set to 0 so that it doesn't interfere with the envelope

Parameters:

Name	Type	Description
param	number

Source:

• Tone.js, line 1298

dbToGain(db) → {number}

convert db scale to gain scale (0-1)

Parameters:

Name	Type	Description
db	number

Inherited From:

• Tone#dbToGain

Source:

• Tone.js, line 227

Returns:

Type

number

defaultArg(given, fallback) → {*}

if a the given is undefined, use the fallback

Parameters:

Name	Type	Description
given	*
fallback	*

Inherited From:

• Tone#defaultArg

Source:

• Tone.js, line 190

Returns:

Type

*

disconnect()

disconnect the output

Inherited From:

• Tone#disconnect

Source:

• Tone.js, line 160

dispose()

disconnect and dispose

Source:

• Tone.js, line 1309

equalPowerScale(percent) → {number}

equal power gain scale good for cross-fading

Parameters:

Name	Type	Description
percent	number	(0-1)

Inherited From:

• Tone#equalPowerScale

Source:

• Tone.js, line 201

Returns:

output gain (0-1)

Type

number

expScale(gain) → {number}

Parameters:

Name	Type	Description
gain	number	(0-1)

Inherited From:

• Tone#expScale

Source:

• Tone.js, line 218

Returns:

gain (decibel scale but betwee 0-1)

Type

number

frequencyToNote(freq) → {string}

convert a note name (i.e. A4, C#5, etc to a frequency)

Parameters:

Name	Type	Description
freq	number

Inherited From:

• Tone#frequencyToNote

Source:

• Tone.js, line 394

Returns:

Type

string

frequencyToSeconds(freq) → {number}

convert a frequency into seconds accepts both numbers and strings i.e. 10hz or 10 both equal .1

Parameters:

Name	Type	Description
freq	number | string

Inherited From:

• Tone#frequencyToSeconds

Source:

• Tone.js, line 346

Returns:

Type

number

gainToDb(gain) → {number}

convert gain scale to decibels

Parameters:

Name	Type	Description
gain	number	(0-1)

Inherited From:

• Tone#gainToDb

Source:

• Tone.js, line 236

Returns:

Type

number

interpolate(input, outputMin, outputMax) → {number}

interpolate the input value (0-1) to be between outputMin and outputMax

Parameters:

Name	Type	Description
input	number
outputMin	number
outputMax	number

Inherited From:

• Tone#interpolate

Source:

• Tone.js, line 247

Returns:

Type

number

logScale(gain) → {number}

Parameters:

Name	Type	Description
gain	number	(0-1)

Inherited From:

• Tone#logScale

Source:

• Tone.js, line 210

Returns:

gain (decibel scale but betwee 0-1)

Type

number

noGC()

makes a connection to ensure that the node will not be garbage collected until 'dispose' is explicitly called

use carefully. circumvents JS and WebAudio's normal Garbage Collection behavior

Inherited From:

• Tone#noGC

Source:

• Tone.js, line 527

normalize(input, inputMin, inputMax) → {number}

normalize the input to 0-1 from between inputMin to inputMax

Parameters:

Name	Type	Description
input	number
inputMin	number
inputMax	number

Inherited From:

• Tone#normalize

Source:

• Tone.js, line 258

Returns:

Type

number

notationToSeconds(notation, bpm, timeSignature) → {number}

convert notation format strings to seconds

Parameters:

Name	Type	Argument	Description
notation	string
bpm	number	<optional>
timeSignature	number	<optional>

Inherited From:

• Tone#notationToSeconds

Source:

• Tone.js, line 2460

Returns:

Type

number

noteToFrequency(note) → {number}

convert a note name to frequency (i.e. A4 to 440)

Parameters:

Name	Type	Description
note	string

Inherited From:

• Tone#noteToFrequency

Source:

• Tone.js, line 376

Returns:

Type

number

now() → {number}

Inherited From:

• Tone#now

Source:

• Tone.js, line 285

Returns:

the currentTime from the AudioContext

Type

number

receive(channelName)

recieve the input from the desired channelName to the input gain of 'this' node.

Parameters:

Name	Type	Description
channelName	string

Inherited From:

• Tone#receive

Source:

• Tone.js, line 3599

samplesToSeconds(samples) → {number}

convert a sample count to seconds

Parameters:

Name	Type	Description
samples	number

Inherited From:

• Tone#samplesToSeconds

Source:

• Tone.js, line 294

Returns:

Type

number

secondsToFrequency(seconds) → {number}

convert a number in seconds to a frequency

Parameters:

Name	Type	Description
seconds	number

Inherited From:

• Tone#secondsToFrequency

Source:

• Tone.js, line 355

Returns:

Type

number

send(channelName, amount) → {GainNode}

send signal to a channel name

Parameters:

Name	Type	Description
channelName	string
amount	number

Inherited From:

• Tone#send

Source:

• Tone.js, line 3584

Returns:

Type

GainNode

toFrequency(time) → {number}

convert a time to a frequency

Parameters:

Name	Type	Description
time	Tone.Time

Inherited From:

• Tone#toFrequency

Source:

• Tone.js, line 2547

Returns:

the time in hertz

Type

number

toMaster()

connect 'this' to the master output

Inherited From:

• Tone#toMaster

Source:

• Tone.js, line 498

toSamples(time) → {number}

convert a time into samples

Parameters:

Name	Type	Description
time	Tone.time

Inherited From:

• Tone#toSamples

Source:

• Tone.js, line 304

Returns:

Type

number

toSeconds(time, now) → {number}

convert Tone.Time to seconds

this is a simplified version which only handles numbers and 'now' relative numbers. If the Transport is included this method is overridden to include many other features including notationTime, Frequency, and transportTime

Parameters:

Name	Type	Argument	Description
time	Tone.Time
now	number	<optional>	if passed in, this number will be used for all 'now' relative timings

Inherited From:

• Tone#toSeconds

Source:

• Tone.js, line 322

Returns:

seconds in the same timescale as the AudioContext

Type

number

toSeconds(time, now) → {number}

convert Tone.Time into seconds.

unlike the method which it overrides, this takes into account transporttime and musical notation

Parameters:

Name	Type	Argument	Description
time	Tone.Time
now	number	<optional>	if passed in, this number will be used for all 'now' relative timings

Inherited From:

• Tone#toSeconds

Source:

• Tone.js, line 2569

Returns:

Type

number

triggerAttack(time)

attack->decay->sustain linear ramp

Parameters:

Name	Type	Argument	Description
time	Tone.Time	<optional>

Source:

• Tone.js, line 1213

triggerExponentialAttack(time)

attack->decay->sustain exponential attack and linear decay

Parameters:

Name	Type	Argument	Description
time	Tone.Time	<optional>

Source:

• Tone.js, line 1232

triggerExponentialRelease(time)

triggers the release of the envelope with an exponential ramp

Parameters:

Name	Type	Argument	Description
time	Tone.Time	<optional>

Source:

• Tone.js, line 1271

triggerRelease(time)

triggers the release of the envelope with a linear ramp

Parameters:

Name	Type	Argument	Description
time	Tone.Time	<optional>

Source:

• Tone.js, line 1252