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

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

import { Frequency, Positive } from "../core/type/Units";
import { Filter, FilterOptions } from "../component/filter/Filter";
import { SourceOptions } from "../source/Source";
import { LFOEffect, LFOEffectOptions } from "./LFOEffect";
export interface AutoFilterOptions extends LFOEffectOptions {
    baseFrequency: Frequency;
    octaves: Positive;
    filter: Omit<FilterOptions, keyof SourceOptions | "frequency" | "detune" | "gain">;
}
/**
 * AutoFilter is a Tone.Filter with a Tone.LFO connected to the filter cutoff frequency.
 * Setting the LFO rate and depth allows for control over the filter modulation rate
 * and depth.
 *
 * @example
 * import { AutoFilter, Oscillator } from "tone";
 * // create an autofilter and start it's LFO
 * const autoFilter = new AutoFilter("4n").toDestination().start();
 * // route an oscillator through the filter and start it
 * const oscillator = new Oscillator().connect(autoFilter).start();
 * @category Effect
 */
export declare class AutoFilter extends LFOEffect<AutoFilterOptions> {
    readonly name: string;
    /**
     * The filter node
     */
    readonly filter: Filter;
    /**
     * The octaves placeholder
     */
    private _octaves;
    /**
     * @param frequency The rate of the LFO.
     * @param baseFrequency The lower value of the LFOs oscillation
     * @param octaves The number of octaves above the baseFrequency
     */
    constructor(frequency?: Frequency, baseFrequency?: Frequency, octaves?: Positive);
    constructor(options?: Partial<AutoFilterOptions>);
    static getDefaults(): AutoFilterOptions;
    /**
     * The minimum value of the filter's cutoff frequency.
     */
    baseFrequency: Frequency;
    /**
     * The maximum value of the filter's cutoff frequency.
     */
    octaves: Positive;
    dispose(): this;
}