Struct AudioEffectLimiter

Adds a soft-clip limiter audio effect to an Audio bus.

struct AudioEffectLimiter ;

A limiter is similar to a compressor, but it's less flexible and designed to disallow sound going over a given dB threshold. Adding one in the Master bus is always recommended to reduce the effects of clipping. Soft clipping starts to reduce the peaks a little below the threshold level and progressively increases its effect as the input level increases such that the threshold is never exceeded.

Properties

NameTypeDescription
ceilingDb[get, set] doubleThe waveform's maximum allowed value, in decibels. Value can range from -20 to -0.1.
softClipDb[get, set] doubleApplies a gain to the limited waves, in decibels. Value can range from 0 to 6.
softClipRatio[get, set] double
thresholdDb[get, set] doubleThreshold from which the limiter begins to be active, in decibels. Value can range from -30 to 0.

Methods

NameDescription
getCeilingDb
getSoftClipDb
getSoftClipRatio
getThresholdDb
setCeilingDb
setSoftClipDb
setSoftClipRatio
setThresholdDb