Tone.js Class: Tone

new Tone()

Tone is the baseclass of all ToneNodes From Tone, children inherit timing and math which is used throughout Tone.js

Source:

Tone.js, line 96

Classes

Add
AutoPanner
BitCrusher
DryWet
Envelope
LFO
Merge
Meter
Microphone
Multiply
Noise
Oscillator
Player
Recorder
Scale
Signal
Source
Split
Transport

Members

<static> context :AudioContext

A static pointer to the audio context

Type:

AudioContext

Source:

Tone.js, line 119

bufferSize :number

the default buffer size

Type:

number

Source:

Tone.js, line 131

context :AudioContext

A static pointer to the audio context

Type:

AudioContext

Source:

Tone.js, line 125

input :GainNode

default input of the ToneNode

Type:

GainNode

Source:

Tone.js, line 102

isFrequency

true if the input is in the format number+hz i.e.: 10hz

Source:

Tone.js, line 1925

isNotation

tests if a string is musical notation i.e.: 4n = quarter note 2m = two measures 8t = eighth-note triplet

Source:

Tone.js, line 1897

isTransportTime

tests if a string is transportTime i.e. : 1:2:0 = 1 measure + two quarter notes + 0 sixteenth notes

Source:

Tone.js, line 1911

output :GainNode

default output of the ToneNode

Type:

GainNode

Source:

Tone.js, line 108

waveShaperResolution :number

the default resolution for WaveShaperNodes

Type:

number

Source:

Tone.js, line 137

Methods

<static> extend(child, parent)

have a child inherit all of Tone's (or a parent's) prototype to inherit the parent's properties, make sure to call Parent.call(this) in the child's constructor

based on closure library's inherit function

Parameters:

Name	Type	Argument	Description
`child`	function
`parent`	function	<optional>	(optional) parent to inherit from if no parent is supplied, the child will inherit from Tone

Source:

Tone.js, line 372

<static> Panner()

a panner is just a dry/wet knob

Source:

Tone.js, line 2626

chain()

connect together all of the arguments in series

Parameters:

Type	Argument	Description
AudioParam \| Tone	<repeatable>

Source:

Tone.js, line 162

connect(unit)

connect the output of a ToneNode to an AudioParam, AudioNode, or ToneNode

Parameters:

Name	Type	Description
`unit`	Tone \| AudioParam \| AudioNode

Source:

Tone.js, line 147

dbToGain(db) → {number}

convert db scale to gain scale (0-1)

Parameters:

Name	Type	Description
`db`	number

Source:

Tone.js, line 226

Returns:

Type: number

defaultArg(given, fallback) → {*}

if a the given is undefined, use the fallback

Parameters:

Name	Type	Description
`given`	*
`fallback`	*

Source:

Tone.js, line 189

Returns:

Type: *

disconnect()

disconnect the output

Source:

Tone.js, line 154

<virtual> dispose()

a dispose method

Source:

Tone.js, line 274

equalPowerScale(percent) → {number}

equal power gain scale good for cross-fading

Parameters:

Name	Type	Description
`percent`	number	(0-1)

Source:

Tone.js, line 200

Returns:

output gain (0-1)

Type: number

expScale(gain) → {number}

Parameters:

Name	Type	Description
`gain`	number	(0-1)

Source:

Tone.js, line 217

Returns:

gain (decibel scale but betwee 0-1)

Type: number

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

Source:

Tone.js, line 343

Returns:

Type: number

gainToDb(gain) → {number}

convert gain scale to decibels

Parameters:

Name	Type	Description
`gain`	number	(0-1)

Source:

Tone.js, line 235

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

Source:

Tone.js, line 246

Returns:

Type: number

logScale(gain) → {number}

Parameters:

Name	Type	Description
`gain`	number	(0-1)

Source:

Tone.js, line 209

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

Source:

Tone.js, line 1216

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

Source:

Tone.js, line 257

Returns:

Type: number

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

convert notation format strings to seconds

Parameters:

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

Source:

Tone.js, line 1940

Returns:

Type: number

now() → {number}

Source:

Tone.js, line 284

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

Source:

Tone.js, line 2826

samplesToSeconds(samples) → {number}

convert a sample count to seconds

Parameters:

Name	Type	Description
`samples`	number

Source:

Tone.js, line 293

Returns:

Type: number

secondsToFrequency(seconds) → {number}

convert a number in seconds to a frequency

Parameters:

Name	Type	Description
`seconds`	number

Source:

Tone.js, line 352

Returns:

Type: number

send(channelName, amount) → {GainNode}

send signal to a channel name

Parameters:

Name	Type	Description
`channelName`	string
`amount`	number

Source:

Tone.js, line 2811

Returns:

Type: GainNode

toFrequency(time) → {number}

convert a time to a frequency

Parameters:

Name	Type	Description
`time`	Tone.Time

Source:

Tone.js, line 2021

Returns:

the time in hertz

Type: number

toMaster()

connect 'this' to the master output

Source:

Tone.js, line 1187

toSamples(time) → {number}

convert a time into samples

Parameters:

Name	Type	Description
`time`	Tone.time

Source:

Tone.js, line 303

Returns:

Type: number

toSeconds(time) → {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	Description
`time`	Tone.Time

Source:

Tone.js, line 319

Returns:

Type: number

toSeconds(time, bpm, timeSignature) → {number}

convert Tone.Time into seconds.

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

Parameters:

Name	Type	Argument
`time`	Tone.Time
`bpm`	number	<optional>
`timeSignature`	number	<optional>

Source:

Tone.js, line 2042

Returns:

Type: number

toTransportTime(seconds, bpm, timeSignature) → {string}

Convert seconds to the closest transportTime in the form measures:quarters:sixteenths

Parameters:

Name	Type	Argument
`seconds`	Tone.Time
`bpm`	number	<optional>
`timeSignature`	number	<optional>

Source:

Tone.js, line 2002

Returns:

Type: string

transportTimeToSeconds(transportTime, bpm, timeSignature) → {number}

convert transportTime into seconds i.e.: 4:2:3 == 4 measures + 2 quarters + 3 sixteenths

Parameters:

Name	Type	Argument
`transportTime`	string
`bpm`	number	<optional>
`timeSignature`	number	<optional>

Source:

Tone.js, line 1972

Returns:

seconds

Type: number