Class PreEqualizer

Effector's subclass for Pre-Equalizer.

Hierarchy (view full)

Effector
- PreEqualizer

Index

Constructors

Properties

context depth input isActive lfo output paused rate

Accessors

Methods

activate connect deactivate param params start state stop toJSON

Constructors

constructor

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

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(): Effector
This method activates effector.

Returns Effector
Return value is for method chain.
Inherited from Effector.activate
- Defined in SoundModule/Effectors/Effector.ts:109

connect

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

deactivate

deactivate(): Effector
This method deactivates effector.

Returns Effector
Return value is for method chain.
Inherited from Effector.deactivate
- Defined in SoundModule/Effectors/Effector.ts:125

param

param(params): boolean
This method gets or sets parameters for pre-equalizer. 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 pre-equalizer if getter.
- Defined in SoundModule/Effectors/Preamp.ts:130
param(params): null | Float32Array
Parameters
- params: "curve"
Returns null | Float32Array
- Defined in SoundModule/Effectors/Preamp.ts:131
param(params): OverSampleType
Parameters
- params: "oversample"
Returns OverSampleType
- Defined in SoundModule/Effectors/Preamp.ts:132
param(params): number
Parameters
- params: "gain"
Returns number
- Defined in SoundModule/Effectors/Preamp.ts:133
param(params): number
Parameters
- params: "lead"
Returns number
- Defined in SoundModule/Effectors/Preamp.ts:134
param(params): void
Parameters
- params: PreEqualizerParams
Returns void
- Defined in SoundModule/Effectors/Preamp.ts:135

params

params(): Required<PreEqualizerParams>
Returns Required<PreEqualizerParams>
Overrides Effector.params
- Defined in SoundModule/Effectors/Preamp.ts:215

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