CompressorEffect

interface CompressorEffect extends AudioEffect, SideChainable { uuid: string label: string enabled: boolean minimized: boolean index: number audioUnit: AnyAudioUnit sideChain: Nullable<SideChainSource> key: 'Compressor' lookahead: boolean automakeup: boolean autoattack: boolean autorelease: boolean inputGain: number threshold: number ratio: number knee: number attack: number release: number makeup: number mix: number remove(): void move(index: number): void }

Dynamic range compressor

Hierarchy


Properties

uuid: string

readonly

Inherited from uuid

Unique id

label: string

Inherited from label

Custom label

enabled: boolean

Inherited from enabled

Enable or bypass the device

minimized: boolean

Inherited from minimized

Collapse the device editor in the studio

index: number

readonly

Inherited from index

Position in the effect chain (0 = first)

audioUnit: AnyAudioUnit

readonly

Inherited from audioUnit

The audio unit this effect belongs to

sideChain: Nullable<SideChainSource>

Inherited from sideChain

External detection source (null = the effect listens to its own input)

key: 'Compressor'

readonly

Overrides key

Always "Compressor"

lookahead: boolean

Look ahead detection (default false)

automakeup: boolean

Automatic makeup gain (default true)

autoattack: boolean

Program dependent attack (default false)

autorelease: boolean

Program dependent release (default false)

inputGain: number

Input gain in dB (-30 to 30, default 0)

threshold: number

Threshold in dB (-60 to 0, default -10)

ratio: number

Ratio (1 to 24, default 2)

knee: number

Knee in dB (0 to 24, default 0)

attack: number

Attack in ms (0 to 100, default 0)

release: number

Release in ms (5 to 1500, default 25)

makeup: number

Makeup gain in dB (-40 to 40, default 0)

mix: number

Dry/wet mix (0.0 to 1.0, default 1.0)

Methods

remove(): void

Inherited from remove

Remove this device from its host

Returns

  • void

move(index: number): void

Inherited from move

Move this effect to another position in its chain

Parameters

  • index (number)

Returns

  • void