tone/build/esm/effect/Vibrato.d.ts

A Web Audio framework for making interactive music in the browser.

import { Effect, EffectOptions } from "./Effect.js";
import { ToneOscillatorType } from "../source/oscillator/OscillatorInterface.js";
import { Frequency, NormalRange, Seconds } from "../core/type/Units.js";
import { Signal } from "../signal/Signal.js";
import { Param } from "../core/context/Param.js";
export interface VibratoOptions extends EffectOptions {
    maxDelay: Seconds;
    frequency: Frequency;
    depth: NormalRange;
    type: ToneOscillatorType;
}
/**
 * A Vibrato effect composed of a Tone.Delay and a Tone.LFO. The LFO
 * modulates the delayTime of the delay, causing the pitch to rise and fall.
 * @category Effect
 */
export declare class Vibrato extends Effect<VibratoOptions> {
    readonly name: string;
    /**
     * The delay node used for the vibrato effect
     */
    private _delayNode;
    /**
     * The LFO used to control the vibrato
     */
    private _lfo;
    /**
     * The frequency of the vibrato
     */
    readonly frequency: Signal<"frequency">;
    /**
     * The depth of the vibrato.
     */
    readonly depth: Param<"normalRange">;
    /**
     * @param frequency The frequency of the vibrato.
     * @param depth The amount the pitch is modulated.
     */
    constructor(frequency?: Frequency, depth?: NormalRange);
    constructor(options?: Partial<VibratoOptions>);
    static getDefaults(): VibratoOptions;
    /**
     * Type of oscillator attached to the Vibrato.
     */
    get type(): ToneOscillatorType;
    set type(type: ToneOscillatorType);
    dispose(): this;
}