Tone.AMSynth

↳ EXTENDS Tone.Monophonic

AMSynth uses the output of one Tone.Synth to modulate the amplitude of another Tone.Synth. The harmonicity (the ratio between the two signals) affects the timbre of the output signal greatly. Read more about Amplitude Modulation Synthesis on SoundOnSound.

CONSTRUCTOR

new Tone.AMSynth ( [
options
] )
options

the options available for the synth see defaults below

type: Object
optional

DEFAULTS

{
harmonicity : 3 ,
detune : 0 ,
oscillator :
{
type : sine
}
,
envelope :
{
attack : 0.01 ,
decay : 0.01 ,
sustain : 1 ,
release : 0.5
}
,
modulation :
{
type : square
}
,
modulationEnvelope :
{
attack : 0.5 ,
decay : 0 ,
sustain : 1 ,
release : 0.5
}
}

EXAMPLE

var synth = new Tone.AMSynth().toMaster();
synth.triggerAttackRelease("C4", "4n");

Members

.oscillator

↝ Tone.Oscillator #

The carrier’s oscillator

</>
∿

.detune

↝ Cents #

The detune in cents

</>

.envelope

↝ Tone.AmplitudeEnvelope #

The carrier’s envelope

</>
∿

.frequency

↝ Frequency #

The frequency.

</>
∿

.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

</>

.modulationEnvelope

↝ Tone.AmplitudeEnvelope #

The modulator’s envelope

</>
↳ inherited from Tone.AudioNode

.context

↝ Tone.Context READONLY #

Get the audio context belonging to this instance.

</>
↳ inherited from Tone.Instrument
∿

.volume

↝ Decibels #

The volume of the output in decibels.

EXAMPLE

source.volume.value = -6;
</>
↳ inherited from Tone.Monophonic

.portamento

↝ Time #

The glide time between notes.

</>

Methods

.dispose ( )

#
↪ returns Tone.AMSynth

this

clean up

</>
↳ inherited from Tone.AudioNode

.disconnect ( )

#
output

Either the output index to disconnect if the output is an array, or the node to disconnect from.
↪ returns Tone.AudioNode

this

disconnect the output

</>
↳ inherited from Tone.AudioNode

.connect ( )

#
unit
outputNum

optionally which output to connect from

type: number
default: 0
inputNum

optionally which input to connect to

type: number
default: 0
↪ returns Tone.AudioNode

this

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

</>
↳ inherited from Tone.AudioNode

.toMaster ( )

#
↪ returns Tone.AudioNode

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();
</>
↳ inherited from Tone.Instrument

.triggerAttackRelease ( )

#
note

The note to trigger.
duration

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

type: Time
time

When the note should be triggered.

type: Time
default: now
velocity

The velocity the note should be triggered at.

default: 1
↪ returns Tone.Instrument

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");
</>
↳ inherited from Tone.Monophonic

.triggerRelease ( )

#
time

If no time is given, the release happens immediatly

type: Time
default: now
↪ returns Tone.Monophonic

this

Trigger the release portion of the envelope

EXAMPLE

synth.triggerRelease();
</>
↳ inherited from Tone.Monophonic

.triggerAttack ( )

#
note

The note to trigger.
time

When the note should start.

type: Time
default: now
velocity

velocity The velocity scaler determines how “loud” the note will be triggered.

type: number
default: 1
↪ returns Tone.Monophonic

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);
</>
↳ inherited from Tone.Monophonic

.setNote ( )

#
note

The note to change to.
time

The time when the note should be set.

type: Time
default: now
↪ returns Tone.Monophonic

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");
</>
docs generated Sep 15 2019