Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

AudioEffectHardLimiter

Inherits: AudioEffect < Resource < RefCounted < Object

Adds a hard limiter audio effect to an Audio bus.

Description

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.

Tutorials

Properties

float

ceiling_db

-0.3

float

pre_gain_db

0.0

float

release

0.1

Property Descriptions

float ceiling_db = -0.3

  • void set_ceiling_db(value: float)

  • float get_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.

float pre_gain_db = 0.0

  • void set_pre_gain_db(value: float)

  • float get_pre_gain_db()

Gain to apply before limiting, in decibels.

float release = 0.1

  • void set_release(value: float)

  • float get_release()

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

User-contributed notes

Please read the User-contributed notes policy before submitting a comment.