Class NoiseSuppressor

This private class is for Noise Suppressor.

Hierarchy

Effector
- NoiseSuppressor

Index

Constructors

Properties

context depth input isActive lfo output paused processor rate threshold

Accessors

Methods

activate connect deactivate param params start state stop toJSON

Constructors

constructor

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

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

`Private` processor

processor: AudioWorkletNode

`Protected` rate

rate: AudioParam

`Private` threshold

threshold: number = 0

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

connect

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

deactivate

deactivate(): NoiseSuppressor
Returns NoiseSuppressor
Overrides Effector.deactivate
- Defined in SoundModule/Effectors/NoiseSuppressor.ts:135

param

param(params): boolean
This method gets or sets parameters for noise suppressor.
Parameters
- params: "state"
  
  This argument is string if getter. Otherwise, setter.
Returns boolean
Return value is parameter for noise suppressor if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/NoiseSuppressor.ts:69
param(params): number
Parameters
- params: "threshold"
Returns number
- Defined in SoundModule/Effectors/NoiseSuppressor.ts:70
param(params): NoiseSuppressor
Parameters
- params: NoiseSuppressorParams
Returns NoiseSuppressor
- Defined in SoundModule/Effectors/NoiseSuppressor.ts:71

params

params(): Required<NoiseSuppressorParams>
Returns Required<NoiseSuppressorParams>
Overrides Effector.params
- Defined in SoundModule/Effectors/NoiseSuppressor.ts:121

start

start(): void
Returns void
Overrides Effector.start
- Defined in SoundModule/Effectors/NoiseSuppressor.ts:30

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(): void
Returns void
Overrides Effector.stop
- Defined in SoundModule/Effectors/NoiseSuppressor.ts:34

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