Class: Player

Extends

• Tone.Source

Members

duration :number

the duration of the buffer once it's been loaded

Type:

• number

Source:

• Tone.js, line 4131

input :GainNode

default input of the ToneNode

Type:

• GainNode

Inherited From:

• Tone#input

Source:

• Tone.js, line 110

loop :boolean

if the buffer should loop once it's over

Type:

• boolean

Source:

• Tone.js, line 4137

loopEnd :number

if 'loop' is true, the loop will end at this position

Type:

• number

Source:

• Tone.js, line 4151

loopStart :number

if 'loop' is true, the loop will start at this position

Type:

• number

Source:

• Tone.js, line 4144

output :GainNode

unlike most ToneNodes, Sources only have an output and no input

Type:

• GainNode

Inherited From:

• Tone.Source#output

Source:

• Tone.js, line 2228

retrigger :boolean

enabling retrigger will allow a player to be restarted before the the previous 'start' is done playing

Type:

• boolean

Source:

• Tone.js, line 4166

state :Tone.Source.State

Type:

• Tone.Source.State

Inherited From:

• Tone.Source#state

Source:

• Tone.js, line 2233

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 167

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

dispose()

dispose and disconnect

Source:

• Tone.js, line 4310

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

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

load(url, callback)

makes an xhr reqest for the selected url Load the audio file as an audio buffer. Decodes the audio asynchronously and invokes the callback once the audio buffer loads.

Parameters:

Name	Type	Argument	Description
url	string		the url of the buffer to load. filetype support depends on the browser.
callback	function	<optional>

Source:

• Tone.js, line 4194

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	Description
notation	string
bpm	number	<optional>
timeSignature	number	<optional>

Inherited From:

• Tone#notationToSeconds

Source:

• Tone.js, line 2070

Returns:

Type

number

now() → {number}

Inherited From:

• Tone#now

Source:

• Tone.js, line 284

Returns:

the currentTime from the AudioContext

Type

number

onended()

set a callback function to invoke when the sample is over

Source:

• Tone.js, line 4173

<virtual> pause(time)

Parameters:

Name	Type	Description
time	Tone.Time

Inherited From:

• Tone.Source#pause

Source:

• Tone.js, line 2255

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 3209

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 3194

Returns:

Type

GainNode

setBuffer(buffer)

set the buffer

Parameters:

Name	Type	Description
buffer	AudioBuffer	the buffer which the player will play. note: if you switch the buffer after the player is already started, it will not take effect until the next time the player is started.

Source:

• Tone.js, line 4227

setPlaybackRate(rate, rampTime)

set the rate at which the file plays

Parameters:

Name	Type	Argument	Description
rate	number
rampTime	Tone.Time	<optional>	(optional) the amount of time it takes to reach the rate

Source:

• Tone.js, line 4286

setVolume(value, fadeTime)

Parameters:

Name	Type	Argument	Description
value	number
fadeTime	Tone.Time	<optional>	(optional) time it takes to reach the value

Inherited From:

• Tone.Source#setVolume

Source:

• Tone.js, line 2281

start(startTime, offset, duration)

play the buffer between the desired positions

Parameters:

Name	Type	Argument	Description
startTime	Tone.Time	<optional>
offset	Tone.Time	<optional>
duration	Tone.Time	<optional>

Source:

• Tone.js, line 4239

stop(time)

Stop playback.

Parameters:

Name	Type	Description
time	Tone.Time

Source:

• Tone.js, line 4268

sync(delay)

sync the source to the Transport

Parameters:

Name	Type	Argument	Description
delay	Tone.Time	<optional>	optional delay time before starting the source

Inherited From:

• Tone.Source#sync

Source:

• Tone.js, line 2265

toFrequency(time) → {number}

convert a time to a frequency

Parameters:

Name	Type	Description
time	Tone.Time

Inherited From:

• Tone#toFrequency

Source:

• Tone.js, line 2157

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

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 321

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 2179

Returns:

Type

number

unsync()

unsync the source to the Transport

Inherited From:

• Tone.Source#unsync

Source:

• Tone.js, line 2272