Tone.Players

↳ EXTENDS Tone.AudioNode

Tone.Players combines multiple Tone.Player objects.

CONSTRUCTOR

new Tone.Players (
urls
, [
onload
] )
urls

An object mapping a name to a url.

type: Object
onload

The function to invoke when all buffers are loaded.

type: function
optional

DEFAULTS

{
volume : 0 ,
mute : false ,
onload : Tone.noOp ,
fadeIn : 0 ,
fadeOut : 0
}

Members

∿

.volume

↝ Decibels #

The volume of the output in decibels.

EXAMPLE

source.volume.value = -6;
</>

.loaded

↝ Boolean READONLY #

If all the buffers are loaded or not

</>

.state

↝ String READONLY #

The state of the players object. Returns “started” if any of the players are playing.

</>
↳ inherited from Tone.AudioNode

.context

↝ Tone.Context READONLY #

Get the audio context belonging to this instance.

</>
↳ inherited from Tone.AudioNode

.channelCount

↝ Number READONLY #

channelCount is the number of channels used when up-mixing and down-mixing connections to any inputs to the node. The default value is 2 except for specific nodes where its value is specially determined.

</>
↳ inherited from Tone.AudioNode

.numberOfInputs

↝ Number READONLY #

The number of inputs feeding into the AudioNode. For source nodes, this will be 0.

</>
↳ inherited from Tone.AudioNode

.numberOfOutputs

↝ Number READONLY #

The number of outputs coming out of the AudioNode.

</>
↳ inherited from Tone.AudioNode

.channelCountMode

↝ String READONLY #

channelCountMode determines how channels will be counted when up-mixing and down-mixing connections to any inputs to the node. The default value is “max”. This attribute has no effect for nodes with no inputs.

</>
↳ inherited from Tone.AudioNode

.channelInterpretation

↝ String READONLY #

channelInterpretation determines how individual channels will be treated when up-mixing and down-mixing connections to any inputs to the node. The default value is “speakers”.

</>

Methods

.add ( )

#
name

A unique name to give the player

type: String
url

Either the url of the bufer, or a buffer which will be added with the given name.
callback

The callback to invoke when the url is loaded.

optional

Add a player by name and url to the Players

</>

.get ( )

#
name

The players name as defined in the constructor object or add method.

type: String
↪ returns Tone.Player

Get a player by name.

</>

.has ( )

#
name

The key or index of the buffer.
↪ returns Boolean

True if the buffers object has a buffer by that name.

</>

.stopAll ( )

#
time

The time to stop all of the players.

type: Time
↪ returns Tone.Players

this

Stop all of the players at the given time

</>

.dispose ( )

#
↪ returns Tone.Players

this

Dispose and disconnect.

</>
↳ inherited from Tone.AudioNode

.connect ( )

#
unit
outputNum

optionally which output to connect from

type: number
default: 0
inputNum

optionally which input to connect to

type: number
default: 0
↪ returns Tone.AudioNode

this

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

</>
↳ inherited from Tone.AudioNode

.disconnect ( )

#
output

Either the output index to disconnect if the output is an array, or the node to disconnect from.
↪ returns Tone.AudioNode

this

disconnect the output

</>
↳ inherited from Tone.AudioNode

.toMaster ( )

#
↪ returns Tone.AudioNode

this

Connect ‘this’ to the master output. Shorthand for this.connect(Tone.Master)

EXAMPLE

//connect an oscillator to the master output
var osc = new Tone.Oscillator().toMaster();
</>
docs generated Sep 15 2019