Tone.js Class: Transport

new Transport()

oscillator-based transport allows for simple musical timing supports tempo curves and time changes

Source:

Tone.js, line 1286

Extends

Tone

Members

input :GainNode

default input of the ToneNode

Type:

GainNode

Inherited From:

Tone#input

Source:

Tone.js, line 110

loop :boolean

Type:

boolean

Source:

Tone.js, line 1300

output :GainNode

default output of the ToneNode

Type:

GainNode

Inherited From:

Tone#output

Source:

Tone.js, line 116

state :TransportState

Type:

TransportState

Source:

Tone.js, line 1305

Methods

_processBuffer(event)

called when a buffer is ready

Parameters:

Name	Type	Description
`event`	AudioProcessingEvent

Source:

Tone.js, line 1417

chain()

connect together all of the arguments in series

Parameters:

Type	Argument	Description
AudioParam \| Tone	<repeatable>

Inherited From:

Tone#chain

Source:

Tone.js, line 167

clearInterval(rmInterval) → {boolean}

clear an interval from the processing array

Parameters:

Name	Type	Description
`rmInterval`	number	the interval to remove

Source:

Tone.js, line 1546

Returns:

true if the event was removed

Type: boolean

clearIntervals()

removes all of the intervals that are currently set

Source:

Tone.js, line 1560

clearTimeline(timelineID) → {boolean}

clear the transportTimeline event from the

Parameters:

Name	Type	Description
`timelineID`	number

Source:

Tone.js, line 1653

Returns:

true if it was removed

Type: boolean

clearTimelines()

remove all events from the timeline

Source:

Tone.js, line 1667

clearTimeout(timeoutID) → {boolean}

clear the timeout based on it's ID

Parameters:

Name	Type	Description
`timeoutID`	number

Source:

Tone.js, line 1597

Returns:

true if the timeout was removed

Type: boolean

clearTimeouts()

removes all of the timeouts that are currently set

Source:

Tone.js, line 1613

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 152

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 226

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 189

Returns:

Type: *

disconnect()

disconnect the output

Inherited From:

Tone#disconnect

Source:

Tone.js, line 159

<virtual> dispose()

a dispose method

Inherited From:

Tone#dispose

Source:

Tone.js, line 274

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 200

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 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

Inherited From:

Tone#frequencyToSeconds

Source:

Tone.js, line 345

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 235

Returns:

Type: number

getBpm() → {number}

return the current BPM

Source:

Tone.js, line 1802

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 1829

Returns:

Type: number

getTransportTime() → {string}

get the transport time

Source:

Tone.js, line 1695

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 246

Returns:

Type: number

logScale(gain) → {number}

Parameters:

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

Inherited From:

Tone#logScale

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

Inherited From:

Tone#noGC

Source:

Tone.js, line 483

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 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>

Inherited From:

Tone#notationToSeconds

Source:

Tone.js, line 2004

Returns:

Type: number

now() → {number}

Inherited From:

Tone#now

Source:

Tone.js, line 284

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 1764

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 3147

samplesToSeconds(samples) → {number}

convert a sample count to seconds

Parameters:

Name	Type	Description
`samples`	number

Inherited From:

Tone#samplesToSeconds

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

Inherited From:

Tone#secondsToFrequency

Source:

Tone.js, line 354

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 3132

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 1784

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 1534

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 1847

setLoopPoint(startPosition, endPosition)

shorthand loop setting

Parameters:

Name	Type	Description
`startPosition`	Tone.Time
`endPosition`	Tone.Time

Source:

Tone.js, line 1856

setLoopStart(startPosition)

set the loop start position

Parameters:

Name	Type	Description
`startPosition`	Tone.Time

Source:

Tone.js, line 1838

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 1632

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 1576

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 1817

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 1709

start(time)

start the transport and all sources synced to the transport

Parameters:

Name	Type	Description
`time`	Tone.Time

Source:

Tone.js, line 1723

stop(time)

stop the transport and all sources synced to the transport

Parameters:

Name	Type	Description
`time`	Tone.Time

Source:

Tone.js, line 1746

toFrequency(time) → {number}

convert a time to a frequency

Parameters:

Name	Type	Description
`time`	Tone.Time

Inherited From:

Tone#toFrequency

Source:

Tone.js, line 2091

Returns:

the time in hertz

Type: number

toMaster()

connect 'this' to the master output

Inherited From:

Tone#toMaster

Source:

Tone.js, line 454

toSamples(time) → {number}

convert a time into samples

Parameters:

Name	Type	Description
`time`	Tone.time

Inherited From:

Tone#toSamples

Source:

Tone.js, line 303

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