Player is an audio file player with start, loop, and stop functions.
import { Player } from "tone";
const player = new Player("https://tonejs.github.io/examples/audio/FWDL.mp3").toDestination();
// play as soon as the buffer is loaded
player.autostart = true;Either the AudioBuffer or the url from which to load the AudioBuffer
The function to invoke when the buffer is loaded.
If the file should play as soon as the buffer is loaded.
The number of seconds of 1 processing block (128 samples)
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".
The context belonging to the node.
Set this debug flag to log all events that happen in this class.
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 loop is true, the loop will end at this position.
If loop is true, the loop will start at this position.
Mute the output.
import { Oscillator } from "tone";
const osc = new Oscillator().toDestination().start();
// mute the output
osc.mute = true;
The number of inputs feeding into the AudioNode. For source nodes, this will be 0.
The number of outputs of the AudioNode.
The callback to invoke when the source is stopped.
The playback speed. 1 is normal speed. This is not a signal because Safari and iOS currently don't support playbackRate as a signal.
The duration in seconds of one sample.
Returns the playback state of the source, either "started" or "stopped".
import { Player } from "tone";
const player = new Player("https://tonejs.github.io/examples/audio/FWDL.mp3", () => {
player.start();
console.log(player.state);
}).toDestination();
The version number semver
The volume of the output in decibels.
import { PWMOscillator } from "tone";
const source = new PWMOscillator().toDestination();
source.volume.value = -6;
Connect the output of this node to the rest of the nodes in series.
import { Destination, Filter, Oscillator, Volume } from "tone";
const osc = new Oscillator().start();
const filter = new Filter();
const volume = new Volume(-8);
// connect a node to the filter, volume and then to the master output
osc.chain(filter, volume, Destination);
connect the output of a ToneAudioNode to an AudioParam, AudioNode, or ToneAudioNode
The output to connect from
The input to connect to
disconnect the output
connect the output of this node to the rest of the nodes in parallel.
Get the object's attributes.
import { Oscillator } from "tone";
const osc = new Oscillator();
console.log(osc.get());
// returns {"type" : "sine", "frequency" : 440, ...etc}
Returns all of the default options belonging to the class.
Return the current time of the Context clock without any lookAhead.
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.
Return the current time of the Context clock plus the lookAhead.
Stop and then restart the player from the beginning (or offset)
How long the sample should play. If no duration is given, it will default to the full length of the sample (minus any offset)
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
import { Player } from "tone";
const player = new Player("https://tonejs.github.io/examples/audio/FWDL.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.
import { Filter } from "tone";
const filter = new Filter();
// set values using an object
filter.set({
frequency: 300,
type: "highpass"
});
Set the loop start and end. Will only loop if loop is set to true.
import { Player } from "tone";
const player = new Player("https://tonejs.github.io/examples/audio/FWDL.mp3").toDestination();
// loop between the given points
player.setLoopPoints(0.2, 0.3);
player.loop = true;
player.autostart = true;
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.
How long the sample should play. If no duration is given, it will default to the full length of the sample (minus any offset)
Stop the source at the specified time. If no time is given, stop the source now.
import { Oscillator } from "tone";
const source = new Oscillator().toDestination();
source.start();
source.stop("+0.5"); // stops the source 0.5 seconds from now
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.
import { Oscillator, Transport } from "tone";
const osc = new 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.
Transport.start();
// set it to loop once a second
Transport.loop = true;
Transport.loopEnd = 1;
Connect the output to the context's destination node.
Convert the input to a frequency number
Connect the output to the context's destination node. See toDestination
Convert the incoming time to seconds
Convert the class to a string
import { Oscillator } from "tone";
const osc = new Oscillator();
console.log(osc.toString());
Convert the input time into ticks
Unsync the source to the Transport. See Source.sync