Class Compressor

Effector's subclass for Compressor.

Hierarchy (View Summary)

Effector
- Compressor

Index

Constructors

constructor

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

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

connect

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

deactivate

deactivate(): Compressor
Returns Compressor
Overrides Effector.deactivate
- Defined in SoundModule/Effectors/Compressor.ts:174

param

param(params: "state"): boolean
This method gets or sets parameters for compressor. 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 compressor if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Compressor.ts:64
param(params: "threshold"): number
This method gets or sets parameters for compressor. This method is overloaded for type interface and type check.
Parameters
- params: "threshold"
  This argument is string if getter. Otherwise, setter.
Returns number
Return value is parameter for compressor if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Compressor.ts:65
param(params: "knee"): number
This method gets or sets parameters for compressor. This method is overloaded for type interface and type check.
Parameters
- params: "knee"
  This argument is string if getter. Otherwise, setter.
Returns number
Return value is parameter for compressor if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Compressor.ts:66
param(params: "ratio"): number
This method gets or sets parameters for compressor. This method is overloaded for type interface and type check.
Parameters
- params: "ratio"
  This argument is string if getter. Otherwise, setter.
Returns number
Return value is parameter for compressor if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Compressor.ts:67
param(params: "attack"): number
This method gets or sets parameters for compressor. This method is overloaded for type interface and type check.
Parameters
- params: "attack"
  This argument is string if getter. Otherwise, setter.
Returns number
Return value is parameter for compressor if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Compressor.ts:68
param(params: "release"): number
This method gets or sets parameters for compressor. This method is overloaded for type interface and type check.
Parameters
- params: "release"
  This argument is string if getter. Otherwise, setter.
Returns number
Return value is parameter for compressor if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Compressor.ts:69
param(params: CompressorParams): Compressor
This method gets or sets parameters for compressor. This method is overloaded for type interface and type check.
Parameters
- params: CompressorParams
  This argument is string if getter. Otherwise, setter.
Returns Compressor
Return value is parameter for compressor if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Effectors/Compressor.ts:70

params

params(): Required<CompressorParams>
Returns Required<CompressorParams>
Overrides Effector.params
- Defined in SoundModule/Effectors/Compressor.ts:156

start

start(startTime?: number): 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?: number, releaseTime?: number): 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

Class Compressor

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Compressor

Properties

Protectedcontext

Protecteddepth

Protectedinput

ProtectedisActive

Protectedlfo

Protectedoutput

Protectedpaused

Protectedrate

Accessors

INPUT

Returns GainNode

OUTPUT

Returns GainNode

Methods

activate

Returns Compressor

connect

Returns GainNode

deactivate

Returns Compressor

param

Parameters

Returns boolean

Parameters

Returns number

Parameters

Returns number

Parameters

Returns number

Parameters

Returns number

Parameters

Returns number

Parameters

Returns Compressor

params

Returns Required<CompressorParams>

start

Parameters

Returns void

state

Returns boolean

stop

Parameters

Returns void

toJSON

Returns string

Settings

On This Page

`Protected`context

`Protected`depth

`Protected`input

`Protected`isActive

`Protected`lfo

`Protected`output

`Protected`paused

`Protected`rate