undertone

Appearance

@liminal-hq/undertone / LimiterOptions

Interface: LimiterOptions ​

Defined in: masterBus.ts:15

Settings for the bus's limiter, which is a fast, high-ratio compressor.

Properties ​

attack? ​

optional attack?: number

Defined in: masterBus.ts:23

Seconds the limiter takes to clamp down on a peak. Default 0.003.

compensate? ​

optional compensate?: boolean

Defined in: masterBus.ts:34

Browsers' dynamics compressors add automatic makeup gain, which would otherwise make the limited mix louder and push peaks back toward full scale. With this on (the default) a gain stage after the compressor takes that makeup back out, so the threshold really is near the ceiling. The compensation is worked out for a hard knee at full-scale input, so it is approximate when knee is above 0. Set false to keep the makeup.

knee? ​

optional knee?: number

Defined in: masterBus.ts:19

dB range over which the reduction eases in. Default 0 (a hard knee).

ratio? ​

optional ratio?: number

Defined in: masterBus.ts:21

Compression ratio; 20 is close to brick-wall. Default 20.

release? ​

optional release?: number

Defined in: masterBus.ts:25

Seconds the limiter takes to let go afterwards. Default 0.1.

threshold? ​

optional threshold?: number

Defined in: masterBus.ts:17

Level in dB above which gain reduction starts. Default -2.