Karplus-String string synthesis.

const plucky = new Tone.PluckSynth().toDestination();
plucky.triggerAttack("C4", "+0.5");
plucky.triggerAttack("C3", "+1");
plucky.triggerAttack("C2", "+1.5");
plucky.triggerAttack("C1", "+2");



new PluckSynth ( ) => PluckSynth


attackNoise #


The amount of noise at the attack. Nominal range of [0.1, 20]

Range: 0.1 to 20

blockTime #

readonly Seconds

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


channelCount #


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 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 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 #


The context belonging to the node.

dampening #


The dampening control. i.e. the lowpass filter frequency of the comb filter

Range: 0 to 7000

debug #


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 #


The instrument only has an output

name #


numberOfInputs #

readonly number

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

const node = new Tone.Gain();

numberOfOutputs #

readonly number

The number of outputs of the AudioNode.

const node = new Tone.Gain();

release #


The release time which corresponds to a resonance ramp down to 0

resonance #


The amount of resonance of the pluck. Also correlates to the sustain duration.

sampleTime #

readonly Seconds

The duration in seconds of one sample.


static version #


The version number semver

volume #

Param<"decibels" >

The volume of the output in decibels.

const amSynth = new Tone.AMSynth().toDestination();
amSynth.volume.value = -6;
amSynth.triggerAttackRelease("G#3", 0.2);


chain #

Connect the output of this node to the rest of the nodes in series.

const player = new Tone.Player("");
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);
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.

const player = new Tone.Player("");
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, filter);
fan (
...nodes:InputNode []
) => this

get #

Get the object's attributes.

const osc = new Tone.Oscillator();
get ( ) => PluckSynthOptions

static getDefaults #

Returns all of the default options belonging to the class.

getDefaults ( ) => PluckSynthOptions

immediate #

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

setInterval(() => {
}, 100);
immediate ( ) => Seconds

now #

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

setInterval(() => {
}, 100);
now ( ) => Seconds

set #

Set multiple properties at once with an object.

const filter = new Tone.Filter().toDestination();
// set values using an object
	frequency: "C6",
	type: "highpass"
const player = new Tone.Player("").connect(filter);
player.autostart = true;
set ( ) => this

sync #

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

toDestination #

Connect the output to the context's destination node.

const osc = new Tone.Oscillator("C2").start();
toDestination ( ) => this

toFrequency #

Convert the input to a frequency number

const gain = new Tone.Gain();
toFrequency (
) => Hertz


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

toMaster ( ) => this

toSeconds #

Convert the incoming time to seconds. This is calculated against the current Tone.Transport 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);
toSeconds (
) => Seconds

toString #

Convert the class to a string

const osc = new Tone.Oscillator();
toString ( ) => string

toTicks #

Convert the input time into ticks

const gain = new Tone.Gain();
toTicks (
time?:Time | TimeClass
) => Ticks

triggerAttack #

Start the instrument's note.

triggerAttack (
note:Frequency ,
) => this

triggerAttackRelease #

Trigger the attack and then the release after the duration.

const synth = new Tone.Synth().toDestination();
// trigger "C4" for the duration of an 8th note
synth.triggerAttackRelease("C4", "8n");
triggerAttackRelease (
note:Frequency ,

The note to trigger.

duration:Time ,

How long the note should be held for beforetriggering the release. This value must be greater than 0.

time?:Time ,

When the note should be triggered.


The velocity the note should be triggered at.

) => this

triggerRelease #

Ramp down the resonance to 0 over the duration of the release time.

triggerRelease (
) => this

unsync #

Unsync the instrument from the Transport

unsync ( ) => this