Synth is composed simply of a {@link OmniOscillator} routed through an {@link AmplitudeEnvelope}.
+----------------+ +-------------------+
| OmniOscillator +>--> AmplitudeEnvelope +>--> Output
+----------------+ +-------------------+
import { Synth } from "tone";
const synth = new Synth().toDestination();
synth.triggerAttackRelease("C4", "8n");The number of seconds of 1 processing block (128 samples)
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.
The instrument only has an output
The number of inputs feeding into the AudioNode. For source nodes, this will be 0.
The number of outputs of the AudioNode.
Invoked when the release has finished and the output is silent.
The glide time between notes.
The duration in seconds of one sample.
The version number semver
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);
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.
Get the level of the output at the given time. Measures the envelope(s) value at the time.
Return the current time of the Context clock without any lookAhead.
Return the current time of the Context clock plus the lookAhead.
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 note at the given time. If no time is given, the note will set immediately.
import { Synth } from "tone";
const synth = new Synth().toDestination();
synth.triggerAttack("C4");
// change to F#6 in one quarter note from now.
synth.setNote("F#6", "+4n");
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();
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
Trigger the attack of the note optionally with a given velocity.
import { Synth } from "tone";
const synth = new Synth().toDestination();
// trigger the note a half second from now at half velocity
synth.triggerAttack("C4", "+0.5", 0.5);
Trigger the attack and then the release after the duration.
import { Synth } from "tone";
const synth = new Synth().toDestination();
// trigger "C4" for the duration of an 8th note
synth.triggerAttackRelease("C4", "8n");
How long the note should be held for beforetriggering the release. This value must be greater than 0.
Trigger the release portion of the envelope
import { Synth } from "tone";
const synth = new Synth().toDestination();
synth.triggerAttack("C4");
// trigger the release a second from now
synth.triggerRelease("+1");
Unsync the instrument from the Transport