Class Equalizer

Effector's subclass for Equalizer.

Hierarchy

Effector
- Equalizer

Index

Constructors

Properties

bass context depth input isActive lfo middle output paused presence rate treble

Accessors

Methods

activate connect deactivate param params start state stop toJSON

Constructors

constructor

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

Properties

`Private` bass

bass: BiquadFilterNode

`Protected` context

context: AudioContext

`Protected` depth

depth: GainNode

`Protected` input

input: GainNode

`Protected` isActive

isActive: boolean = true

`Protected` lfo

lfo: OscillatorNode

`Private` middle

middle: BiquadFilterNode

`Protected` output

output: GainNode

`Protected` paused

paused: boolean = true

`Private` presence

presence: BiquadFilterNode

`Protected` rate

rate: AudioParam

`Private` treble

treble: BiquadFilterNode

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(): Equalizer
Returns Equalizer
Overrides Effector.activate
- Defined in SoundModule/Effectors/Equalizer.ts:174

connect

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

deactivate

deactivate(): Equalizer
Returns Equalizer
Overrides Effector.deactivate
- Defined in SoundModule/Effectors/Equalizer.ts:180

param

param(params): boolean
This method gets or sets parameters for 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 equalizer if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Equalizer.ts:98
param(params): number
Parameters
- params: "bass"
Returns number
- Defined in SoundModule/Effectors/Equalizer.ts:99
param(params): number
Parameters
- params: "middle"
Returns number
- Defined in SoundModule/Effectors/Equalizer.ts:100
param(params): number
Parameters
- params: "treble"
Returns number
- Defined in SoundModule/Effectors/Equalizer.ts:101
param(params): number
Parameters
- params: "presence"
Returns number
- Defined in SoundModule/Effectors/Equalizer.ts:102
param(params): Equalizer
Parameters
- params: EqualizerParams
Returns Equalizer
- Defined in SoundModule/Effectors/Equalizer.ts:103

params

params(): Required<EqualizerParams>
Returns Required<EqualizerParams>
Overrides Effector.params
- Defined in SoundModule/Effectors/Equalizer.ts:163

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

Generated using TypeDoc