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:31

Properties

`Protected`context

context: AudioContext

`Protected`depth

depth: GainNode

`Protected`input

input: GainNode

`Protected`isActive

isActive: boolean = true

`Protected`lfo

lfo: OscillatorNode

`Protected`output

output: GainNode

`Protected`paused

paused: boolean = true

`Protected`rate

rate: AudioParam

Accessors

INPUT

get INPUT(): GainNode
Connector for input.

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

OUTPUT

get OUTPUT(): GainNode
Connector for output.

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

Methods

activate

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

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.
- OptionalerrorCallback: ((error: 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:187

connect

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

deactivate

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

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

params

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

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: Error | ProgressEvent<EventTarget>, textStatus: ReverbErrorText): void;
      progressCallback?(event: ProgressEvent<EventTarget>): void;
      successCallback?(event: ProgressEvent<EventTarget>): void;
  }
  - rirs: AudioBuffer[] | string[]
  - Optionaltimeout?: number
  - errorCallback?:function
    - errorCallback(event, textStatus): void
    - Parameters
      event: Error | ProgressEvent<EventTarget>
      textStatus: ReverbErrorText
      Returns void
      Defined in SoundModule/Effectors/Reverb.ts:215
  - progressCallback?:function
    - progressCallback(event): void
    - Parameters
      event: ProgressEvent<EventTarget>
      Returns void
      Defined in SoundModule/Effectors/Reverb.ts:216
  - successCallback?:function
    - successCallback(event): void
    - Parameters
      event: ProgressEvent<EventTarget>
      Returns void
      Defined in SoundModule/Effectors/Reverb.ts:214
Returns void
- Defined in SoundModule/Effectors/Reverb.ts:211

start

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

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:101

stop

stop(stopTime?, releaseTime?): 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
Inherited from Effector.stop
- Defined in SoundModule/Effectors/Effector.ts:54

toJSON

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

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

Class Reverb

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Reverb

Properties

Protectedcontext

Protecteddepth

Protectedinput

ProtectedisActive

Protectedlfo

Protectedoutput

Protectedpaused

Protectedrate

Accessors

INPUT

Returns GainNode

OUTPUT

Returns GainNode

Methods

activate

Returns Reverb

add

Parameters

Parameters

Returns void

Returns Reverb

connect

Returns GainNode

deactivate

Returns Reverb

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[]

Optionaltimeout?: number

errorCallback?:function

Parameters

Returns void

progressCallback?:function

Parameters

Returns void

successCallback?:function

Parameters

Returns void

Returns void

start

Parameters

Returns void

state

Returns boolean

stop

Parameters

Returns void

toJSON

Returns string

Settings

On This Page

`Protected`context

`Protected`depth

`Protected`input

`Protected`isActive

`Protected`lfo

`Protected`output

`Protected`paused

`Protected`rate

`Optional`timeout?: number