UNPKG

998 BTypeScriptView Raw
1import { RecursivePartial } from "../core/util/Interface.js";
2import { ModulationSynth, ModulationSynthOptions } from "./ModulationSynth.js";
3export type AMSynthOptions = ModulationSynthOptions;
4/**
5 * AMSynth uses the output of one Tone.Synth to modulate the
6 * amplitude of another Tone.Synth. The harmonicity (the ratio between
7 * the two signals) affects the timbre of the output signal greatly.
8 * Read more about Amplitude Modulation Synthesis on
9 * [SoundOnSound](https://web.archive.org/web/20160404103653/http://www.soundonsound.com:80/sos/mar00/articles/synthsecrets.htm).
10 *
11 * @example
12 * const synth = new Tone.AMSynth().toDestination();
13 * synth.triggerAttackRelease("C4", "4n");
14 *
15 * @category Instrument
16 */
17export declare class AMSynth extends ModulationSynth<AMSynthOptions> {
18 readonly name: string;
19 /**
20 * Scale the oscillator from -1,1 to 0-1
21 */
22 private _modulationScale;
23 constructor(options?: RecursivePartial<AMSynthOptions>);
24 dispose(): this;
25}