Optionalsamples: SamplesMap
An object of samples mapping either Midi Note Numbers or Scientific Pitch Notation to the url of that sample.
Optionalonload: () => void
The callback to invoke when all of the samples are loaded.
OptionalbaseUrl: string
The root URL of all of the samples, which is prepended to all the URLs.
Optionalsamples: SamplesMap
An object of samples mapping either Midi Note Numbers or Scientific Pitch Notation to the url of that sample.
Optionaloptions: Partial<Omit<SamplerOptions, "urls">>
The remaining options associated with the sampler
Optionaloptions: Partial<SamplerOptions>Protected_List all of the node that must be set to match the ChannelProperties
Protected_The release which is scheduled to the timeline.
The envelope applied to the beginning of the sample.
ReadonlycontextThe context belonging to the node.
The shape of the attack/release curve. Either "linear" or "exponential"
Set this debug flag to log all events that happen in this class.
The instrument only has an output
ReadonlynameThe name of the class
The output nodes. If the object is a sink, it does not have any output and this.output is undefined.
The envelope applied to the end of the envelope.
The volume of the output in decibels.
StaticversionThe version number semver
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 buffers are loaded or not
The duration in seconds of one sample.
Protected_Get a subset of the properties which are in the partial props
Protected_Wrap the given method so that it can be synchronized
Which method to wrap and sync
What position the time argument appears in
Protected_set _sync
Add a note to the sampler.
The buffer's pitch.
Either the url of the buffer, or a buffer which will be added with the given name.
Optionalcallback: () => void
The callback to invoke when the url is loaded.
Connect the output of this node to the rest of the nodes in series.
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
OptionaloutputNum: number
The output to connect from
OptionalinputNum: number
The input to connect to
disconnect the output
Optionaldestination: InputNodeOptionaloutputNum: numberOptionalinputNum: numberClean up
connect the output of this node to the rest of the nodes in parallel.
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.
ProtectedlogPrints the outputs to the console log for debugging purposes.
Prints the contents only if either the object has a property
called debug set to true, or a variable called TONE_DEBUG_CLASS
is set to the name of the class.
Release all currently active notes.
Optionaltime: Time
When to release the notes.
Set multiple properties at once with an object.
Sync the instrument to the Transport. All subsequent calls of triggerAttack and triggerRelease will be scheduled along the transport.
const fmSynth = new Tone.FMSynth().toDestination();
fmSynth.volume.value = -6;
fmSynth.sync();
// schedule 3 notes when the transport first starts
fmSynth.triggerAttackRelease("C4", "8n", 0);
fmSynth.triggerAttackRelease("E4", "8n", "8n");
fmSynth.triggerAttackRelease("G4", "8n", "4n");
// start the transport to hear the notes
Tone.Transport.start();
Convert the incoming time to seconds. This is calculated against the current TransportClass bpm
Optionaltime: TimeConvert the input time into ticks
Optionaltime: Time | TimeClass<number, TimeBaseUnit>Unsync the instrument from the Transport
StaticgetReturns all of the default options belonging to the class.
Pass in an object which maps the note's pitch or midi value to the url, then you can trigger the attack and release of that note like other instruments. By automatically repitching the samples, it is possible to play pitches which were not explicitly included which can save loading time.
For sample or buffer playback where repitching is not necessary, use Player.
Example