Table of Contents

Class AudioEffectLimiter

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

Inheritance
AudioEffectLimiter

Remarks

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.

See Also

Audio buses

Properties

ceiling_db

The waveform's maximum allowed value, in decibels. Value can range from -20 to -0.1.

var ceiling_db : float = -0.1

Property Value

float

Remarks

  • void set_ceiling_db(float value)
  • float get_ceiling_db

soft_clip_db

Applies a gain to the limited waves, in decibels. Value can range from 0 to 6.

var soft_clip_db : float = 2.0

Property Value

float

Remarks

  • void set_soft_clip_db(float value)
  • float get_soft_clip_db

soft_clip_ratio 

var soft_clip_ratio : float = 10.0

Property Value

float

Remarks

  • void set_soft_clip_ratio(float value)
  • float get_soft_clip_ratio

threshold_db

Threshold from which the limiter begins to be active, in decibels. Value can range from -30 to 0.

var threshold_db : float = 0.0

Property Value

float

Remarks

  • void set_threshold_db(float value)
  • float get_threshold_db