GateEffect

interface GateEffect extends AudioEffect, SideChainable { uuid: string label: string enabled: boolean minimized: boolean index: number audioUnit: AnyAudioUnit sideChain: Nullable<SideChainSource> key: 'Gate' threshold: number return: number attack: number hold: number release: number floor: number inverse: boolean remove(): void move(index: number): void }

Noise gate

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: 'Gate'

readonly

Overrides key

Always "Gate"

threshold: number

Threshold in dB (-80 to 0, default -6)

return: number

Hysteresis in dB (0 to 24, default 0)

attack: number

Attack in ms (0 to 1000, default 1)

hold: number

Hold in ms (0 to 500, default 50)

release: number

Release in ms (1 to 2000, default 100)

floor: number

Closed gain in dB (-72 to 0, default -72)

inverse: boolean

Invert (opens below threshold, default false)

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