Class Reverb

Effector's subclass for Reverb.

Hierarchy (view full)

Effector
- Reverb

Index

Constructors

constructor

new Reverb(context): Reverb
Parameters
- context: AudioContext
  This argument is in order to use Web Audio API.
Returns Reverb
Overrides Effector.constructor
- Defined in SoundModule/Effectors/Reverb.ts:33

Properties

`Protected` context

context: AudioContext

`Private` convolver

convolver: ConvolverNode

`Protected` depth

depth: GainNode

`Private` dry

dry: GainNode

`Protected` input

input: GainNode

`Protected` isActive

isActive: boolean = true

`Protected` lfo

lfo: OscillatorNode

`Private` loadError

loadError: boolean = false

`Protected` output

output: GainNode

`Protected` paused

paused: boolean = true

`Protected` rate

rate: AudioParam

`Private` rirs

rirs: AudioBuffer[] = []

`Private` tone

tone: BiquadFilterNode

`Private` wet

wet: GainNode

Accessors

INPUT

get INPUT(): GainNode
Connector for input.

Returns GainNode
Inherited from Effector.INPUT
- Defined in SoundModule/Effectors/Effector.ts:146

OUTPUT

get OUTPUT(): GainNode
Connector for output.

Returns GainNode
Inherited from Effector.OUTPUT
- Defined in SoundModule/Effectors/Effector.ts:153

Methods

activate

activate(): Reverb
Returns Reverb
Overrides Effector.activate
- Defined in SoundModule/Effectors/Reverb.ts:246

add

add(impulse, errorCallback?): 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.
- Optional errorCallback: ((error) => void)
  This argument is invoked on decode failure.
  - - (error): void
    - Parameters
      error: Error
      Returns void
Returns Reverb
Return value is for method chain.
- Defined in SoundModule/Effectors/Reverb.ts:189

connect

connect(): GainNode
Returns GainNode
Overrides Effector.connect
- Defined in SoundModule/Effectors/Reverb.ts:54

deactivate

deactivate(): Reverb
Returns Reverb
Overrides Effector.deactivate
- Defined in SoundModule/Effectors/Reverb.ts:256

`Private` load

load(params): void
This method retrives ArrayBuffer and creates instance of AudioBuffer.
Parameters
- params: {
      index: number;
      rir: string;
      timeout?: number;
      errorCallback?(event, textStatus): void;
      progressCallback?(event): void;
      successCallback?(event): void;
  }
  - index: number
  - rir: string
  - Optional timeout?: number
  - errorCallback?:function
    - errorCallback(event, textStatus): void
    - Parameters
      event: Error | ProgressEvent<EventTarget>
      textStatus: ReverbErrorText
      Returns void
      Defined in SoundModule/Effectors/Reverb.ts:279
  - progressCallback?:function
    - progressCallback(event): void
    - Parameters
      event: ProgressEvent<EventTarget>
      Returns void
      Defined in SoundModule/Effectors/Reverb.ts:280
  - successCallback?:function
    - successCallback(event): void
    - Parameters
      event: ProgressEvent<EventTarget>
      Returns void
      Defined in SoundModule/Effectors/Reverb.ts:278
Returns void
- Defined in SoundModule/Effectors/Reverb.ts:274

param

param(params): 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.
- Defined in SoundModule/Effectors/Reverb.ts:91
param(params): null | AudioBuffer
Parameters
- params: "buffer"
Returns null | AudioBuffer
- Defined in SoundModule/Effectors/Reverb.ts:92
param(params): number
Parameters
- params: "dry"
Returns number
- Defined in SoundModule/Effectors/Reverb.ts:93
param(params): number
Parameters
- params: "wet"
Returns number
- Defined in SoundModule/Effectors/Reverb.ts:94
param(params): number
Parameters
- params: "tone"
Returns number
- Defined in SoundModule/Effectors/Reverb.ts:95
param(params): Reverb
Parameters
- params: ReverbParams
Returns Reverb
- Defined in SoundModule/Effectors/Reverb.ts:96

params

params(): Required<Omit<ReverbParams, "buffer">>
Returns Required<Omit<ReverbParams, "buffer">>
Overrides Effector.params
- Defined in SoundModule/Effectors/Reverb.ts:236

preset

preset(params): void
This method creates and appends to Reverb presets instance of AudioBuffer by Ajax.
Parameters
- params: {
      rirs: AudioBuffer[] | string[];
      timeout?: number;
      errorCallback?(event, textStatus): void;
      progressCallback?(event): void;
      successCallback?(event): void;
  }
  - rirs: AudioBuffer[] | string[]
  - Optional timeout?: number
  - errorCallback?:function
    - errorCallback(event, textStatus): void
    - Parameters
      event: Error | ProgressEvent<EventTarget>
      textStatus: ReverbErrorText
      Returns void
      Defined in SoundModule/Effectors/Reverb.ts:217
  - progressCallback?:function
    - progressCallback(event): void
    - Parameters
      event: ProgressEvent<EventTarget>
      Returns void
      Defined in SoundModule/Effectors/Reverb.ts:218
  - successCallback?:function
    - successCallback(event): void
    - Parameters
      event: ProgressEvent<EventTarget>
      Returns void
      Defined in SoundModule/Effectors/Reverb.ts:216
Returns void
- Defined in SoundModule/Effectors/Reverb.ts:213

start

start(startTime?): void
This method starts LFO. Namely, this method starts effector.
Parameters
- Optional startTime: number
  This argument is in order to schedule parameter.
Returns void
Inherited from Effector.start
- Defined in SoundModule/Effectors/Effector.ts:44

state

state(): boolean
This method gets effector state. If returns true, effector is active.

Returns boolean
Inherited from Effector.state
- Defined in SoundModule/Effectors/Effector.ts:107

stop

stop(stopTime?, releaseTime?): void
This method stops LFO, then creates instance of OscillatorNode again.
Parameters
- Optional stopTime: number
  This argument is in order to schedule parameter.
- Optional releaseTime: number
  This argument is in order to schedule parameter when it is necessary to consider release time.
Returns void
Inherited from Effector.stop
- Defined in SoundModule/Effectors/Effector.ts:58

toJSON

toJSON(): string
This method gets effector's parameters as JSON.

Returns string
Inherited from Effector.toJSON
- Defined in SoundModule/Effectors/Effector.ts:99

Class Reverb

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Reverb

Properties

Protected context

Private convolver

Protected depth

Private dry

Protected input

Protected isActive

Protected lfo

Private loadError

Protected output

Protected paused

Protected rate

Private rirs

Private tone

Private wet

Accessors

INPUT

Returns GainNode

OUTPUT

Returns GainNode

Methods

activate

Returns Reverb

add

Parameters

Parameters

Returns void

Returns Reverb

connect

Returns GainNode

deactivate

Returns Reverb

Private load

Parameters

index: number

rir: string

Optional timeout?: number

errorCallback?:function

Parameters

Returns void

progressCallback?:function

Parameters

Returns void

successCallback?:function

Parameters

Returns void

Returns void

param

Parameters

Returns boolean

Parameters

Returns null | AudioBuffer

Parameters

Returns number

Parameters

Returns number

Parameters

Returns number

Parameters

Returns Reverb

params

Returns Required<Omit<ReverbParams, "buffer">>

preset

Parameters

rirs: AudioBuffer[] | string[]

Optional timeout?: number

errorCallback?:function

Parameters

Returns void

`Protected` context

`Private` convolver

`Protected` depth

`Private` dry

`Protected` input

`Protected` isActive

`Protected` lfo

`Private` loadError

`Protected` output

`Protected` paused

`Protected` rate

`Private` rirs

`Private` tone

`Private` wet

`Private` load

`Optional` timeout?: number

`Optional` timeout?: number