Optional url: string | AudioBuffer | ToneAudioBufferEither the AudioBuffer or the url from which to load the AudioBuffer
Optional onload: (() => void)The function to invoke when the buffer is loaded.
Optional options: Partial<PlayerOptions>If the file should play as soon as the buffer is loaded.
Readonly contextThe context belonging to the node.
Set this debug flag to log all events that happen in this class.
The fadeIn time of the amplitude envelope.
The fadeOut time of the amplitude envelope.
Sources have no inputs
Readonly nameThe callback to invoke when the source is stopped.
The output node
The volume of the output in decibels.
const source = new Tone.PWMOscillator().toDestination();
source.volume.value = -6;
Static versionThe version number semver
The number of seconds of 1 processing block (128 samples)
console.log(Tone.Destination.blockTime);
The audio buffer belonging to the player.
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.
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.
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".
Indicates if the instance was disposed. 'Disposing' an instance means that all of the Web Audio nodes that were created for the instance are disconnected and freed for garbage collection.
If the buffer is loaded
If the buffer should loop once it's over.
const player = new Tone.Player("https://tonejs.github.io/audio/drum-samples/breakbeat.mp3").toDestination();
player.loop = true;
player.autostart = true;
Mute the output.
const osc = new Tone.Oscillator().toDestination().start();
// mute the output
osc.mute = true;
The number of inputs feeding into the AudioNode. For source nodes, this will be 0.
const node = new Tone.Gain();
console.log(node.numberOfInputs);
The number of outputs of the AudioNode.
const node = new Tone.Gain();
console.log(node.numberOfOutputs);
Normal speed is 1. The pitch will change with the playback rate.
const player = new Tone.Player("https://tonejs.github.io/audio/berklee/femalevoices_aa2_A5.mp3").toDestination();
// play at 1/4 speed
player.playbackRate = 0.25;
// play as soon as the buffer is loaded
player.autostart = true;
If the buffer should be reversed. Note that this sets the underlying ToneAudioBuffer.reverse, so if multiple players are pointing at the same ToneAudioBuffer, they will all be reversed.
const player = new Tone.Player("https://tonejs.github.io/audio/berklee/chime_1.mp3").toDestination();
player.autostart = true;
player.reverse = true;
The duration in seconds of one sample.
Returns the playback state of the source, either "started" or "stopped".
const player = new Tone.Player("https://tonejs.github.io/audio/berklee/ahntone_c3.mp3", () => {
player.start();
console.log(player.state);
}).toDestination();
Connect the output of this node to the rest of the nodes in series.
Rest ...nodes: InputNode[]const player = new Tone.Player("https://tonejs.github.io/audio/drum-samples/handdrum-loop.mp3");
player.autostart = true;
const filter = new Tone.AutoFilter(4).start();
const distortion = new Tone.Distortion(0.5);
// connect the player to the filter, distortion and then to the master output
player.chain(filter, distortion, Tone.Destination);
connect the output of a ToneAudioNode to an AudioParam, AudioNode, or ToneAudioNode
The output to connect to
The output to connect from
The input to connect to
disconnect the output
Optional destination: InputNodeconnect the output of this node to the rest of the nodes in parallel.
Rest ...nodes: InputNode[]const player = new Tone.Player("https://tonejs.github.io/audio/drum-samples/conga-rhythm.mp3");
player.autostart = true;
const pitchShift = new Tone.PitchShift(4).toDestination();
const filter = new Tone.Filter("G5").toDestination();
// connect a node to the pitch shift and filter in parallel
player.fan(pitchShift, filter);
Get the object's attributes.
const osc = new Tone.Oscillator();
console.log(osc.get());
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.
The url of the buffer to load. Filetype support depends on the browser.
Seek to a specific time in the player's buffer. If the source is no longer playing at that time, it will stop.
const player = new Tone.Player("https://tonejs.github.io/audio/berklee/gurgling_theremin_1.mp3", () => {
player.start();
// seek to the offset in 1 second from now
player.seek(0.4, "+1");
}).toDestination();
Set multiple properties at once with an object.
const filter = new Tone.Filter().toDestination();
// set values using an object
filter.set({
frequency: "C6",
type: "highpass"
});
const player = new Tone.Player("https://tonejs.github.io/audio/berklee/Analogsynth_octaves_highmid.mp3").connect(filter);
player.autostart = true;
Set the loop start and end. Will only loop if loop is set to true.
const player = new Tone.Player("https://tonejs.github.io/audio/berklee/malevoices_aa2_F3.mp3").toDestination();
// loop between the given points
player.setLoopPoints(0.2, 0.3);
player.loop = true;
player.autostart = true;
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.
const osc = new Tone.Oscillator().toDestination();
// sync the source so that it plays between 0 and 0.3 on the Transport's timeline
osc.sync().start(0).stop(0.3);
// start the transport.
Tone.Transport.start();
// set it to loop once a second
Tone.Transport.loop = true;
Tone.Transport.loopEnd = 1;
Convert the incoming time to seconds. This is calculated against the current TransportClass bpm
const gain = new Tone.Gain();
setInterval(() => console.log(gain.toSeconds("4n")), 100);
// ramp the tempo to 60 bpm over 30 seconds
Tone.getTransport().bpm.rampTo(60, 30);
Static get
Player is an audio file player with start, loop, and stop functions.
Example