Table of Contents

Class AudioEffectHardLimiter

Adds a hard limiter audio effect to an Audio bus.

Inheritance
AudioEffectHardLimiter

Remarks

A limiter is an effect designed to disallow sound from going over a given dB threshold. Hard limiters predict volume peaks, and will smoothly apply gain reduction when a peak crosses the ceiling threshold to prevent clipping and distortion. It preserves the waveform and prevents it from crossing the ceiling threshold. 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.

See Also

Audio buses

Properties

ceiling_db

The waveform's maximum allowed value, in decibels. This value can range from -24.0 to 0.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.

var ceiling_db : float = -0.3

Property Value

float

Remarks

  • void set_ceiling_db(float value)
  • float get_ceiling_db

pre_gain_db

Gain to apply before limiting, in decibels.

var pre_gain_db : float = 0.0

Property Value

float

Remarks

  • void set_pre_gain_db(float value)
  • float get_pre_gain_db

release

Time it takes in seconds for the gain reduction to fully release.

var release : float = 0.1

Property Value

float

Remarks