Class NoiseGate

This private class is for Noise Gate.

Hierarchy (View Summary)

Effector
- NoiseGate

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 NoiseGate(context: AudioContext): NoiseGate
Parameters
- context: AudioContext
  This argument is in order to use Web Audio API.
Returns NoiseGate
Overrides Effector.constructor
- Defined in SoundModule/Effectors/NoiseGate.ts:23

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

connect

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

deactivate

deactivate(): NoiseGate
Returns NoiseGate
Overrides Effector.deactivate
- Defined in SoundModule/Effectors/NoiseGate.ts:134

param

param(params: "state"): boolean
This method gets or sets parameters for noise gate.
Parameters
- params: "state"
  This argument is string if getter. Otherwise, setter.
Returns boolean
Return value is parameter for noise gate if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/NoiseGate.ts:72
param(params: "level"): number
This method gets or sets parameters for noise gate.
Parameters
- params: "level"
  This argument is string if getter. Otherwise, setter.
Returns number
Return value is parameter for noise gate if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/NoiseGate.ts:73
param(params: NoiseGateParams): NoiseGate
This method gets or sets parameters for noise gate.
Parameters
- params: NoiseGateParams
  This argument is string if getter. Otherwise, setter.
Returns NoiseGate
Return value is parameter for noise gate if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/NoiseGate.ts:74

params

params(): Required<NoiseGateParams>
Returns Required<NoiseGateParams>
Overrides Effector.params
- Defined in SoundModule/Effectors/NoiseGate.ts:120

start

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

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

toJSON

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

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