Tone.Player
↳ EXTENDS Tone.SourceTone.Player is an audio file player with start, loop, and stop functions.
CONSTRUCTOR
new Tone.Player (Either the AudioBuffer or the url from which to load the AudioBuffer
The function to invoke when the buffer is loaded. Recommended to use Tone.Buffer.on(‘load’) instead.
DEFAULTS
EXAMPLE
var player = new Tone.Player("./path/to/sample.mp3").toMaster();
//play as soon as the buffer is loaded
player.autostart = true;Members
.autostart
↝ boolean #If the file should play as soon as the buffer is loaded.
EXAMPLE
//will play as soon as it's loaded
var player = new Tone.Player({
"url" : "./path/to/sample.mp3",
"autostart" : true,
}).toMaster();.playbackRate
↝ number #The playback speed. 1 is normal speed. This is not a signal because Safari and iOS currently don’t support playbackRate as a signal.
.retrigger
↝ boolean #Enabling retrigger will allow a player to be restarted before the the previous ‘start’ is done playing. Otherwise, successive calls to Tone.Player.start will only start the sample if it had played all the way through.
.context
↝ Tone.Context READONLY #Get the audio context belonging to this instance.
.mute
↝ boolean #Mute the output.
EXAMPLE
//mute the output
source.mute = true;.volume
↝ Decibels #The volume of the output in decibels.
EXAMPLE
source.volume.value = -6;.state
↝ Tone.State READONLY #Returns the playback state of the source, either “started” or “stopped”.
Methods
.setLoopPoints ( )
#The loop end time
The loop end time
this
Set the loop start and end. Will only loop if loop is set to true.
EXAMPLE
//loop 0.1 seconds of the file.
player.setLoopPoints(0.2, 0.3);
player.loop = true;.start ( )
#When the player should start.
The offset from the beginning of the sample to start at.
How long the sample should play. If no duration is given, it will default to the full length of the sample (minus any offset)
this
Play the buffer at the given startTime. Optionally add an offset and/or duration which will play the buffer from a position within the buffer for the given duration.
.load ( )
#The url of the buffer to load. Filetype support depends on the browser.
The function to invoke once the sample is loaded.
Load the audio file as an audio buffer. Decodes the audio asynchronously and invokes the callback once the audio buffer loads. Note: this does not need to be called if a url was passed in to the constructor. Only use this if you want to manually load a new url.
.seek ( )
#The time to seek to.
The time for the seek event to occur.
this
Seek to a specific time in the player’s buffer. If the source is no longer playing at that time, it will stop. If you seek to a time that
EXAMPLE
source.start(0.2);
source.stop(0.4);.connect ( )
#optionally which output to connect from
optionally which input to connect to
this
connect the output of a ToneNode to an AudioParam, AudioNode, or ToneNode
.disconnect ( )
#Either the output index to disconnect if the output is an array, or the node to disconnect from.
this
disconnect the output
.toMaster ( )
#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();.sync ( )
#this
Sync the source to the Transport so that all subsequent calls to start and stop are synced to the TransportTime instead of the AudioContext time.
EXAMPLE
//sync the source so that it plays between 0 and 0.3 on the Transport's timeline
source.sync().start(0).stop(0.3);
//start the transport.
Tone.Transport.start();
EXAMPLE
//start the transport with an offset and the sync'ed sources
//will start in the correct position
source.sync().start(0.1);
//the source will be invoked with an offset of 0.4
Tone.Transport.start("+0.5", 0.5);.unsync ( )
#this
Unsync the source to the Transport. See Tone.Source.sync
.stop ( )
#When the source should be stopped.
this
Stop the source at the specified time. If no time is given, stop the source now.
EXAMPLE
source.stop(); // stops the source immediately