AudioEffectLimiter
Adds a soft-clip limiter audio effect to an audio bus.
Adds a soft-clip limiter audio effect to an audio bus.
A "limiter" is an audio effect designed to stop audio signals from exceeding a specified volume threshold level, and usually works by decreasing the volume or soft-clipping the audio. Adding one in the Master bus is always recommended to prevent clipping when the volume goes above 0 dB.
Soft clipping starts to decrease the peaks a little below the volume threshold level and progressively increases its effect as the input volume increases such that the threshold level is never exceeded.
If hard clipping is desired, consider AudioEffectDistortion.ModeEnum.Clip.
Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.
Constructors1
AudioEffectLimiterConstructor
public AudioEffectLimiter();Properties4
CeilingDbProperty
public float CeilingDb { get; set; }The waveform's maximum allowed value, in dB. Value can range from -20 to -0.1.
SoftClipDbProperty
public float SoftClipDb { get; set; }Modifies the volume of the limited waves, in dB. Value can range from 0 to 6.
SoftClipRatioProperty
public float SoftClipRatio { get; set; }This property has no effect on the audio. Use AudioEffectHardLimiter instead, as this Limiter effect is deprecated.
ThresholdDbProperty
public float ThresholdDb { get; set; }The volume threshold level from which the limiter begins to be active, in dB. Value can range from -30 to 0.
Methods8
GetCeilingDbfloat
public float GetCeilingDb();floatGetSoftClipDbfloat
public float GetSoftClipDb();floatGetSoftClipRatiofloat
public float GetSoftClipRatio();floatGetThresholdDbfloat
public float GetThresholdDb();floatSetCeilingDbvoid
public void SetCeilingDb(float ceiling);| Name | Type | Default |
|---|---|---|
ceiling | float | — |
SetSoftClipDbvoid
public void SetSoftClipDb(float softClip);| Name | Type | Default |
|---|---|---|
softClip | float | — |
SetSoftClipRatiovoid
public void SetSoftClipRatio(float softClip);| Name | Type | Default |
|---|---|---|
softClip | float | — |
SetThresholdDbvoid
public void SetThresholdDb(float threshold);| Name | Type | Default |
|---|---|---|
threshold | float | — |