Tone.FMSynth
↳ EXTENDS Tone.MonophonicFMSynth is composed of two Tone.Synths where one Tone.Synth modulates the frequency of a second Tone.Synth. A lot of spectral content can be explored using the modulationIndex parameter. Read more about frequency modulation synthesis on Sound On Sound: Part 1, Part 2.
CONSTRUCTOR
new Tone.FMSynth ( [the options available for the synth see defaults below
DEFAULTS
EXAMPLE
var fmSynth = new Tone.FMSynth().toMaster();
fmSynth.triggerAttackRelease("C5", "4n");Members
.harmonicity
↝ Positive #Harmonicity is the ratio between the two voices. A harmonicity of 1 is no change. Harmonicity = 2 means a change of an octave.
EXAMPLE
//pitch voice1 an octave below voice0
synth.harmonicity.value = 0.5;.modulation
↝ Tone.Oscillator #The modulator’s oscillator which is applied to the amplitude of the oscillator
.modulationIndex
↝ Positive #The modulation index which essentially the depth or amount of the modulation. It is the ratio of the frequency of the modulating signal (mf) to the amplitude of the modulating signal (ma) – as in ma/mf.
.context
↝ Tone.Context READONLY #Get the audio context belonging to this instance.
.volume
↝ Decibels #The volume of the output in decibels.
EXAMPLE
source.volume.value = -6;Methods
.disconnect ( )
#Either the output index to disconnect if the output is an array, or the node to disconnect from.
this
disconnect the output
.connect ( )
#optionally which output to connect from
optionally which input to connect to
this
connect the output of a ToneNode to an AudioParam, AudioNode, or ToneNode
.toMaster ( )
#this
Connect ‘this’ to the master output. Shorthand for this.connect(Tone.Master)
EXAMPLE
//connect an oscillator to the master output
var osc = new Tone.Oscillator().toMaster();.triggerAttackRelease ( )
#The note to trigger.
How long the note should be held for before triggering the release. This value must be greater than 0.
When the note should be triggered.
The velocity the note should be triggered at.
this
Trigger the attack and then the release after the duration.
EXAMPLE
//trigger "C4" for the duration of an 8th note
synth.triggerAttackRelease("C4", "8n");.triggerRelease ( )
#If no time is given, the release happens immediatly
this
Trigger the release portion of the envelope
EXAMPLE
synth.triggerRelease();.triggerAttack ( )
#The note to trigger.
When the note should start.
velocity The velocity scaler determines how “loud” the note will be triggered.
this
Trigger the attack of the note optionally with a given velocity.
EXAMPLE
synth.triggerAttack("C4");
EXAMPLE
//trigger the note a half second from now at half velocity
synth.triggerAttack("C4", "+0.5", 0.5);.setNote ( )
#The note to change to.
The time when the note should be set.
this
Set the note at the given time. If no time is given, the note will set immediately.
EXAMPLE
//change to F#6 in one quarter note from now.
synth.setNote("F#6", "+4n");EXAMPLE
//change to Bb4 right now
synth.setNote("Bb4");