AudioEffectHardLimiter
Adds a limiter audio effect to an audio bus. Prevents audio signals from exceeding a specified volume level.
Adds a limiter audio effect to an audio bus. Prevents audio signals from exceeding a specified volume level.
A "limiter" disallows audio signals from exceeding a given volume threshold level in dB. Hard limiters predict volume peaks, and will smoothly apply gain reduction when a peak crosses the ceiling threshold level to prevent clipping. It preserves the waveform and prevents it from crossing the ceiling threshold level. Adding one in the Master bus is recommended as a safety measure to prevent sudden volume peaks from occurring, and to prevent distortion caused by clipping, when the volume exceeds 0 dB.
If clipping is desired, consider AudioEffectDistortion.ModeEnum.Clip.
Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.
Constructors1
AudioEffectHardLimiterConstructor
public AudioEffectHardLimiter();Properties3
CeilingDbProperty
public float CeilingDb { get; set; }The waveform's maximum allowed value, in dB. This value can range from -24 to 0. The default value of -0.3 prevents potential inter-sample peaks (ISP) from crossing over 0 dB, which can cause slight distortion on some older hardware.
PreGainDbProperty
public float PreGainDb { get; set; }Gain before limiting, in dB. Value can range from -24 to 24.
ReleaseProperty
public float Release { get; set; }Time it takes in seconds for the gain reduction to fully release. Value can range from 0.01 to 3.
Methods6
GetCeilingDbfloat
public float GetCeilingDb();floatGetPreGainDbfloat
public float GetPreGainDb();floatGetReleasefloat
public float GetRelease();floatSetCeilingDbvoid
public void SetCeilingDb(float ceiling);| Name | Type | Default |
|---|---|---|
ceiling | float | — |
SetPreGainDbvoid
public void SetPreGainDb(float preGain);| Name | Type | Default |
|---|---|---|
preGain | float | — |
SetReleasevoid
public void SetRelease(float release);| Name | Type | Default |
|---|---|---|
release | float | — |