@liminal-hq/undertone / FmVoiceDefinition

Interface: FmVoiceDefinition

Defined in: instruments.ts:19

Tone.js FMSynth-shaped definition of an FM instrument. Every field is optional.

Properties

envelope?

optional envelope?: EnvelopeDefinition

Defined in: instruments.ts:29

The amplitude envelope.

---

harmonicity?

optional harmonicity?: number

Defined in: instruments.ts:21

Modulator frequency ÷ carrier frequency (Tone's harmonicity).

---

level?

optional level?: number

Defined in: instruments.ts:33

Peak amplitude (0-1), as .gain().

---

modulation?

optional modulation?: object

Defined in: instruments.ts:27

The modulator's waveform (Tone's modulation.type).

type?

optional type?: OscType | ShapedWaveType

---

modulationEnvelope?

optional modulationEnvelope?: EnvelopeDefinition

Defined in: instruments.ts:31

The modulator-depth envelope (Tone's modulationEnvelope).

---

modulationIndex?

optional modulationIndex?: number

Defined in: instruments.ts:23

Tone's modulationIndex: peak deviation as a multiple of the carrier frequency. Omit for no FM.

---

oscillator?

optional oscillator?: object

Defined in: instruments.ts:25

The carrier's waveform (Tone's oscillator.type).

type?

optional type?: OscType | ShapedWaveType

---

pan?

optional pan?: number

Defined in: instruments.ts:35

Stereo position, -1 to 1.