Class Reverb

Effector's subclass for Reverb.

Hierarchy (View Summary)

Constructors

constructor

Properties

context depth input isActive lfo output paused rate

Accessors

INPUT OUTPUT

Methods

activate add connect deactivate param params preset start state stop toJSON

Constructors

constructor

Properties

Protectedcontext

context: AudioContext

Protecteddepth

depth: GainNode

Protectedinput

input: GainNode

ProtectedisActive

isActive: boolean = true

Protectedlfo

lfo: OscillatorNode

Protectedoutput

output: GainNode

Protectedpaused

paused: boolean = true

Protectedrate

rate: AudioParam

Accessors

INPUT

OUTPUT

Methods

activate

add

  • add(
        impulse: ArrayBuffer | AudioBuffer,
        errorCallback?: (error: Error) => void,
    ): Reverb

    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.

connect

deactivate

param

  • param(params: "state"): boolean

    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.

  • param(params: "buffer"): null | AudioBuffer

    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 null | AudioBuffer

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

  • param(params: "dry"): number

    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.

  • param(params: "wet"): number

    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.

  • param(params: "tone"): number

    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.

  • param(params: ReverbParams): Reverb

    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.

params

preset

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

    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

start

  • start(startTime?: number): void

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

    Parameters

    • OptionalstartTime: number

      This argument is in order to schedule parameter.

    Returns void

state

stop

  • stop(stopTime?: number, releaseTime?: number): 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

toJSON

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods