Class: Transport

Extends

• Tone

Members

input :GainNode

default input of the ToneNode

Type:

• GainNode

Inherited From:

• Tone#input

Source:

• Tone.js, line 111

loop :boolean

Type:

• boolean

Source:

• Tone.js, line 1718

output :GainNode

default output of the ToneNode

Type:

• GainNode

Inherited From:

• Tone#output

Source:

• Tone.js, line 117

state :TransportState

Type:

• TransportState

Source:

• Tone.js, line 1723

Methods

_processBuffer(event)

called when a buffer is ready

Parameters:

Name	Type	Description
event	AudioProcessingEvent

Source:

• Tone.js, line 1835

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

clearInterval(rmInterval) → {boolean}

clear an interval from the processing array

Parameters:

Name	Type	Description
rmInterval	number	the interval to remove

Source:

• Tone.js, line 1964

Returns:

true if the event was removed

Type

boolean

clearIntervals()

removes all of the intervals that are currently set

Source:

• Tone.js, line 1978

clearTimeline(timelineID) → {boolean}

clear the transportTimeline event from the

Parameters:

Name	Type	Description
timelineID	number

Source:

• Tone.js, line 2071

Returns:

true if it was removed

Type

boolean

clearTimelines()

remove all events from the timeline

Source:

• Tone.js, line 2085

clearTimeout(timeoutID) → {boolean}

clear the timeout based on it's ID

Parameters:

Name	Type	Description
timeoutID	number

Source:

• Tone.js, line 2015

Returns:

true if the timeout was removed

Type

boolean

clearTimeouts()

removes all of the timeouts that are currently set

Source:

• Tone.js, line 2031

To Do:

• (optionally) remove events after a certain time

connect(unit)

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

Parameters:

Name	Type	Description
unit	Tone | AudioParam | AudioNode

Inherited From:

• Tone#connect

Source:

• Tone.js, line 153

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

<virtual> dispose()

a dispose method

Inherited From:

• Tone#dispose

Source:

• Tone.js, line 275

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

getBpm() → {number}

return the current BPM

Source:

• Tone.js, line 2236

Returns:

Type

number

getTimeSignature() → {number}

return the time signature as just the numerator over 4 is assumed. for example 4/4 would return 4 and 6/8 would return 3

Source:

• Tone.js, line 2263

Returns:

Type

number

getTransportTime() → {string}

get the transport time

Source:

• Tone.js, line 2113

Returns:

in transportTime format (measures:beats:sixteenths)

Type

string

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

pause(time)

pause the transport and all sources synced to the transport

Parameters:

Name	Type	Description
time	Tone.Time

Source:

• Tone.js, line 2193

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

setBpm(bpm, rampTime)

set the BPM optionally ramp to the bpm over some time

Parameters:

Name	Type	Argument	Description
bpm	number
rampTime	Tone.Time	<optional>

Source:

• Tone.js, line 2218

setInterval(callback, interval, ctx) → {number}

intervals are recurring events

Parameters:

Name	Type	Description
callback	function
interval	Tone.Time
ctx	Object	the context the function is invoked in

Source:

• Tone.js, line 1952

Returns:

the id of the interval

Type

number

setLoopEnd(endPosition)

set the loop start position

Parameters:

Name	Type	Description
endPosition	Tone.Time

Source:

• Tone.js, line 2281

setLoopPoint(startPosition, endPosition)

shorthand loop setting

Parameters:

Name	Type	Description
startPosition	Tone.Time
endPosition	Tone.Time

Source:

• Tone.js, line 2290

setLoopStart(startPosition)

set the loop start position

Parameters:

Name	Type	Description
startPosition	Tone.Time

Source:

• Tone.js, line 2272

setTimeline(callback, timeout, ctx) → {number}

Timeline events are synced to the transportTimeline of the Transport Unlike Timeout, Timeline events will restart after the Transport has been stopped and restarted.

Parameters:

Name	Type	Description
callback	function
timeout	Tome.Time
ctx	Object	the context in which the funtion is called

Source:

• Tone.js, line 2050

Returns:

the id for clearing the transportTimeline event

Type

number

setTimeout(callback, time, ctx) → {number}

set a timeout to occur after time from now

Parameters:

Name	Type	Description
callback	function
time	Tone.Time
ctx	Object	the context to invoke the callback in

Source:

• Tone.js, line 1994

Returns:

the id of the timeout for clearing timeouts

Type

number

setTimeSignature(numerator, denominator)

set the time signature

Parameters:

Name	Type	Argument	Description
numerator	number
denominator	number	<optional>	defaults to 4

Source:

• Tone.js, line 2251

Example

 this.setTimeSignature(4); //for 4/4
 
 

setTransportTime(progress)

set the transport time, jump to the position right away

Parameters:

Name	Type	Description
progress	Tone.Time

Source:

• Tone.js, line 2127

start(time)

start the transport and all sources synced to the transport

Parameters:

Name	Type	Description
time	Tone.Time

Source:

• Tone.js, line 2141

stop(time)

stop the transport and all sources synced to the transport

Parameters:

Name	Type	Description
time	Tone.Time

Source:

• Tone.js, line 2170

sync(source, delay)

Sync a source to the transport so that

Parameters:

Name	Type	Description
source	Tone.Source	the source to sync to the transport
delay	Tone.Time	(optionally) start the source with a delay from the transport

Source:

• Tone.js, line 2305

syncSignal(signal)

attaches the signal to the tempo control signal so that any changes in the tempo will change the signal in the same ratio

Parameters:

Name	Type	Description
signal	Tone.Signal

Source:

• Tone.js, line 2319

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

toTicks(time) → {number}

turns the time into

Parameters:

Name	Type	Description
time	Tone.Time

Source:

• Tone.js, line 2099

Returns:

Type

number

unsync(source)

remove the source from the list of Synced Sources

Parameters:

Name	Type	Description
source	Tone.Source	[description]

Source:

• Tone.js, line 2328