XSound - v4.2.0
    Preparing search index...

    Interface Reverb

    Effector's subclass for Reverb.

    interface Reverb {
        context: AudioContext;
        depth: GainNode;
        input: GainNode;
        isActive: boolean;
        lfo: OscillatorNode;
        output: GainNode;
        paused: boolean;
        rate: AudioParam;
        get INPUT(): GainNode;
        get OUTPUT(): GainNode;
        activate(): Reverb;
        add(
            impulse: ArrayBuffer | AudioBuffer,
            errorCallback?: (error: Error) => void,
        ): Reverb;
        connect(): GainNode;
        deactivate(): Reverb;
        param(params: "state"): boolean;
        param(params: "buffer"): AudioBuffer | null;
        param(params: "dry"): number;
        param(params: "wet"): number;
        param(params: "tone"): number;
        param(params: ReverbParams): Reverb;
        params(): Required<Omit<ReverbParams, "buffer">>;
        preset(
            params: {
                rirs: string[] | AudioBuffer[];
                timeout?: number;
                errorCallback?(
                    event: Error | ProgressEvent<EventTarget>,
                    textStatus: ReverbErrorText,
                ): void;
                progressCallback?(event: ProgressEvent): void;
                successCallback?(event: ProgressEvent): void;
            },
        ): void;
        start(startTime?: number): void;
        state(): boolean;
        stop(stopTime?: number, releaseTime?: number): void;
        toJSON(): string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    context depth input isActive lfo output paused rate

    Accessors

    INPUT OUTPUT

    Methods

    activate add connect deactivate param params preset start state stop toJSON

    Properties

    context: AudioContext
    depth: GainNode
    input: GainNode
    isActive: boolean = true
    lfo: OscillatorNode
    output: GainNode
    paused: boolean = true
    rate: AudioParam

    Accessors

    Methods

    • This method sets instance of AudioBuffer to ConvolverNode.

      Parameters

      • impulse: ArrayBuffer | AudioBuffer

        This argument is in order to convolve impulse response. This argument is instance of AudioBuffer or ArrayBuffer for impulse response.

      • OptionalerrorCallback: (error: Error) => void

        This argument is invoked on decode failure.

      Returns Reverb

      Return value is for method chain.

    • This method gets or sets parameters for reverb effector. This method is overloaded for type interface and type check.

      Parameters

      • params: "state"

        This argument is string if getter. Otherwise, setter.

      Returns boolean

      Return value is parameter for reverb effector if getter. Otherwise, return value is for method chain.

    • This method gets or sets parameters for reverb effector. This method is overloaded for type interface and type check.

      Parameters

      • params: "buffer"

        This argument is string if getter. Otherwise, setter.

      Returns AudioBuffer | null

      Return value is parameter for reverb effector if getter. Otherwise, return value is for method chain.

    • This method gets or sets parameters for reverb effector. This method is overloaded for type interface and type check.

      Parameters

      • params: "dry"

        This argument is string if getter. Otherwise, setter.

      Returns number

      Return value is parameter for reverb effector if getter. Otherwise, return value is for method chain.

    • This method gets or sets parameters for reverb effector. This method is overloaded for type interface and type check.

      Parameters

      • params: "wet"

        This argument is string if getter. Otherwise, setter.

      Returns number

      Return value is parameter for reverb effector if getter. Otherwise, return value is for method chain.

    • This method gets or sets parameters for reverb effector. This method is overloaded for type interface and type check.

      Parameters

      • params: "tone"

        This argument is string if getter. Otherwise, setter.

      Returns number

      Return value is parameter for reverb effector if getter. Otherwise, return value is for method chain.

    • This method gets or sets parameters for reverb effector. This method is overloaded for type interface and type check.

      Parameters

      • params: ReverbParams

        This argument is string if getter. Otherwise, setter.

      Returns Reverb

      Return value is parameter for reverb effector if getter. Otherwise, return value is for method chain.

    • This method creates and appends to Reverb presets instance of AudioBuffer by Ajax.

      Parameters

      • params: {
            rirs: string[] | AudioBuffer[];
            timeout?: number;
            errorCallback?(
                event: Error | ProgressEvent<EventTarget>,
                textStatus: ReverbErrorText,
            ): void;
            progressCallback?(event: ProgressEvent): void;
            successCallback?(event: ProgressEvent): void;
        }

      Returns void

    • This method starts LFO. Namely, this method starts effector.

      Parameters

      • OptionalstartTime: number

        This argument is in order to schedule parameter.

      Returns void

    • This method stops LFO, then creates instance of OscillatorNode again.

      Parameters

      • OptionalstopTime: number

        This argument is in order to schedule parameter.

      • OptionalreleaseTime: number

        This argument is in order to schedule parameter when it is necessary to consider release time.

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods