Sampler

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.


import { Sampler } from "tone";
const sampler = new Sampler({
	urls: {
		C1: "C1.mp3",
		C2: "C2.mp3",
	},
	baseUrl: "https://tonejs.github.io/examples/audio/casio/",
	onload: () => {
		sampler.triggerAttackRelease(["C1", "E1", "G1", "B1"], 0.5);
	},
});

Hierarchy

Constructor

new Sampler (
samples?:SamplesMap ,

An object of samples mapping either Midi Note Numbers orScientific Pitch Notation to the url of that sample.

onload?:undefined | () => void ,

The callback to invoke when all of the samples are loaded.

baseUrl?:undefined | string

The root URL of all of the samples, which is prepended to all the URLs.

) => Sampler
new Sampler (
samples?:SamplesMap ,

An object of samples mapping either Midi Note Numbers orScientific Pitch Notation to the url of that sample.

options?:Partial<Omit<SamplerOptions , "urls" > >

The remaining options associated with the sampler

) => Sampler
new Sampler (
options?:Partial<SamplerOptions >

The remaining options associated with the sampler

) => Sampler

Properties

attack #

Time

The envelope applied to the beginning of the sample.

Range: 0 to 1

blockTime #

readonly Seconds

The number of seconds of 1 processing block (128 samples)

channelCount #

number

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 #

ChannelCountMode

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.

  • "max" - computedNumberOfChannels is the maximum of the number of channels of all connections to an input. In this mode channelCount is ignored.
  • "clamped-max" - computedNumberOfChannels is determined as for "max" and then clamped to a maximum value of the given channelCount.
  • "explicit" - computedNumberOfChannels is the exact value as specified by the channelCount.

channelInterpretation #

ChannelInterpretation

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".

context #

BaseContext

The context belonging to the node.

curve #

ToneBufferSourceCurve

The shape of the attack/release curve. Either "linear" or "exponential"

debug #

boolean

Set this debug flag to log all events that happen in this class.

disposed #

readonly boolean

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.

input #

undefined

The instrument only has an output

loaded #

readonly boolean

If the buffers are loaded or not

name #

string

numberOfInputs #

readonly number

The number of inputs feeding into the AudioNode. For source nodes, this will be 0.

numberOfOutputs #

readonly number

The number of outputs of the AudioNode.

release #

Time

The envelope applied to the end of the envelope.

Range: 0 to 1

sampleTime #

readonly Seconds

The duration in seconds of one sample.

static version #

string

The version number semver

volume #

Param<"decibels" >

The volume of the output in decibels.


import { AMSynth } from "tone";
const amSynth = new AMSynth().toDestination();
amSynth.volume.value = -6;
amSynth.triggerAttackRelease("G#3", 0.2);

Methods

add #

Add a note to the sampler.

add (
note:Note | MidiNote ,

The buffer's pitch.

url:string | ToneAudioBuffer | AudioBuffer ,

Either the url of the buffer, or a buffer which will be added with the given name.

callback?:undefined | () => void

The callback to invoke when the url is loaded.

) => this

chain #

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);
chain (
...nodes:InputNode []
) => this

connect #

connect the output of a ToneAudioNode to an AudioParam, AudioNode, or ToneAudioNode

connect (
destination:InputNode ,

The output to connect to

outputNum= 0:number ,

The output to connect from

inputNum= 0:number

The input to connect to

) => this

disconnect #

disconnect the output

disconnect (
destination?:InputNode ,
outputNum= 0:number ,
inputNum= 0:number
) => this

dispose #

Clean up

dispose ( ) => this

fan #

connect the output of this node to the rest of the nodes in parallel.

fan (
...nodes:InputNode []
) => this

get #

Get the object's attributes.


import { Oscillator } from "tone";
const osc = new Oscillator();
console.log(osc.get());
// returns {"type" : "sine", "frequency" : 440, ...etc}
get ( ) => SamplerOptions

static getDefaults #

Returns all of the default options belonging to the class.

getDefaults ( ) => SamplerOptions

immediate #

Return the current time of the Context clock without any lookAhead.

immediate ( ) => Seconds

now #

Return the current time of the Context clock plus the lookAhead.

now ( ) => Seconds

releaseAll #

Release all currently active notes.

releaseAll (
time?:Time

When to release the notes.

) => this

set #

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 ( ) => this

sync #

Sync the instrument to the Transport. All subsequent calls of triggerAttack and triggerRelease will be scheduled along the transport.


import { FMSynth, Transport } from "tone";
const fmSynth = new 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
Transport.start();
sync ( ) => this

toDestination #

Connect the output to the context's destination node.

toDestination ( ) => this

toFrequency #

Convert the input to a frequency number

toFrequency (
freq:Frequency
) => Hertz

toMaster # DEPRECATED

Connect the output to the context's destination node. See toDestination

toMaster ( ) => this

toSeconds #

Convert the incoming time to seconds

toSeconds (
time?:Time
) => Seconds

toString #

Convert the class to a string


import { Oscillator } from "tone";
const osc = new Oscillator();
console.log(osc.toString());
toString ( ) => string

toTicks #

Convert the input time into ticks

toTicks (
time?:Time | TimeClass
) => Ticks

triggerAttack #

Start the instrument's note.

triggerAttack (
notes:Frequency | Frequency [] ,

The note to play, or an array of notes.

time?:Time ,

When to play the note

velocity= 1:NormalRange

The velocity to play the sample back.

) => this

triggerAttackRelease #

Invoke the attack phase, then after the duration, invoke the release.

triggerAttackRelease (
notes:Frequency [] | Frequency ,

The note to play and release, or an array of notes.

duration:Time | Time [] ,

The time the note should be held

time?:Time ,

When to start the attack

velocity= 1:NormalRange

The velocity of the attack

) => this

triggerRelease #

Trigger the release phase of the current note.

triggerRelease (
notes:Frequency | Frequency [] ,

The note to release, or an array of notes.

time?:Time

When to release the note.

) => this

unsync #

Unsync the instrument from the Transport

unsync ( ) => this