PolySynth < Voice >

PolySynth handles voice creation and allocation for any instruments passed in as the second paramter. PolySynth is not a synthesizer by itself, it merely manages voices of one of the other types of synths, allowing any of the monophonic synthesizers to be polyphonic.

const synth = new Tone.PolySynth().toDestination();
// set the attributes across all the voices using 'set'
synth.set({ detune: -1200 });
// play a chord
synth.triggerAttackRelease(["C4", "E4", "A4"], 1);



new PolySynth (
voice?:VoiceConstructor<Voice > ,

The constructor of the voices

options?:PartialVoiceOptions<Voice >

The options object to set the synth voice

) => PolySynth
new PolySynth (
options?:Partial<PolySynthOptions<Voice > >

The options object to set the synth voice

) => PolySynth


activeVoices #

readonly number

The number of active voices.

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.

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

maxPolyphony #


The polyphony limit.

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();

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

get #

Get the object's attributes.

const osc = new Tone.Oscillator();
get ( ) => VoiceOptions<Voice >

static getDefaults #

Returns all of the default options belonging to the class.

getDefaults ( ) => PolySynthOptions<Synth >

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

releaseAll #

Trigger the release portion of all the currently active voices immediately. Useful for silencing the synth.

releaseAll (
) => this

set #

Set a member/attribute of the voices

const poly = new Tone.PolySynth().toDestination();
// set all of the voices using an options object for the synth type
	envelope: {
		attack: 0.25
poly.triggerAttackRelease("Bb3", 0.2);
set (
options:RecursivePartial<VoiceOptions<Voice > >
) => 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 #

Trigger the attack portion of the note

const synth = new Tone.PolySynth(Tone.FMSynth).toDestination();
// trigger a chord immediately with a velocity of 0.2
synth.triggerAttack(["Ab3", "C4", "F5"], Tone.now(), 0.2);
triggerAttack (
notes:Frequency | Frequency [] ,

The notes to play. Accepts a single Frequency or an array of frequencies.

time?:Time ,

The start time of the note.


The velocity of the note.

) => this

triggerAttackRelease #

Trigger the attack and release after the specified duration

const poly = new Tone.PolySynth(Tone.AMSynth).toDestination();
// can pass in an array of durations as well
poly.triggerAttackRelease(["Eb3", "G4", "Bb4", "D5"], [4, 3, 2, 1]);
triggerAttackRelease (
notes:Frequency | Frequency [] ,

The notes to play. Accepts a single Frequency or an array of frequencies.

duration:Time | Time [] ,

the duration of the note

time?:Time ,

if no time is given, defaults to now


the velocity of the attack (0-1)

) => this

triggerRelease #

Trigger the release of the note. Unlike monophonic instruments, a note (or array of notes) needs to be passed in as the first argument.

const poly = new Tone.PolySynth(Tone.AMSynth).toDestination();
poly.triggerAttack(["Ab3", "C4", "F5"]);
// trigger the release of the given notes.
poly.triggerRelease(["Ab3", "C4"], "+1");
poly.triggerRelease("F5", "+3");
triggerRelease (
notes:Frequency | Frequency [] ,

The notes to play. Accepts a single Frequency or an array of frequencies.


When the release will be triggered.

) => this

unsync #

Unsync the instrument from the Transport

unsync ( ) => this