Class Wah

Effector's subclass for Wah.

Hierarchy (view full)

Effector
- Wah

Index

Constructors

Properties

auto context depth depthRate envelopeFollower input isActive lfo lowpass output paused rate sensitivity

Accessors

Methods

activate connect deactivate param params start state stop toJSON

Constructors

constructor

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

Properties

`Private` auto

auto: boolean = false

`Protected` context

context: AudioContext

`Protected` depth

depth: GainNode

`Private` depthRate

depthRate: number = 0

`Private` envelopeFollower

envelopeFollower: WaveShaperNode

`Protected` input

input: GainNode

`Protected` isActive

isActive: boolean = true

`Protected` lfo

lfo: OscillatorNode

`Private` lowpass

lowpass: BiquadFilterNode

`Protected` output

output: GainNode

`Protected` paused

paused: boolean = true

`Protected` rate

rate: AudioParam

`Private` sensitivity

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

connect

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

deactivate

deactivate(): Wah
Returns Wah
Overrides Effector.deactivate
- Defined in SoundModule/Effectors/Wah.ts:240

param

param(params): boolean
This method gets or sets parameters for wah 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 wah effector if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Wah.ts:118
param(params): boolean
Parameters
- params: "auto"
Returns boolean
- Defined in SoundModule/Effectors/Wah.ts:119
param(params): number
Parameters
- params: "cutoff"
Returns number
- Defined in SoundModule/Effectors/Wah.ts:120
param(params): number
Parameters
- params: "depth"
Returns number
- Defined in SoundModule/Effectors/Wah.ts:121
param(params): number
Parameters
- params: "rate"
Returns number
- Defined in SoundModule/Effectors/Wah.ts:122
param(params): number
Parameters
- params: "resonance"
Returns number
- Defined in SoundModule/Effectors/Wah.ts:123
param(params): Wah
Parameters
- params: WahParams
Returns Wah
- Defined in SoundModule/Effectors/Wah.ts:124

params

params(): Required<WahParams>
Returns Required<WahParams>
Overrides Effector.params
- Defined in SoundModule/Effectors/Wah.ts:222

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
Parameters
- Optional stopTime: number
- Optional releaseTime: number
Returns void
Overrides Effector.stop
- Defined in SoundModule/Effectors/Wah.ts:59

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