Tone.Player↳ EXTENDS Tone.Source
Tone.Player is an audio file player with start, loop, and stop functions.
CONSTRUCTORnew 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.
.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.
.state↝ Tone.State READONLY #
Returns the playback state of the source, either “started” or “stopped”.
.volume↝ Decibels #
The volume of the output in decibels.
.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.
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
.setLoopPoints ( )#
The loop end time
The loop end time
Set the loop start and end. Will only loop if loop is set to 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)
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.
.connect ( )#
optionally which output to connect from
optionally which input to connect to
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.
disconnect the output
.toMaster ( )#
Connect ‘this’ to the master output. Shorthand for this.connect(Tone.Master)
.stop ( )#
Stop the source at the specified time. If no time is given, stop the source now.
.sync ( )#
Sync the source to the Transport so that all subsequent calls to
stop are synced to the TransportTime instead of the AudioContext time.