godot-docs/classes/class_audioeffectlimiter.rst

:github_url: hide

.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the AudioEffectLimiter.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_AudioEffectLimiter:

AudioEffectLimiter
==================

**Inherits:** :ref:`AudioEffect<class_AudioEffect>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`

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

Description
-----------

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.

Properties
----------

+---------------------------+---------------------------------------------------------------------------+----------+
| :ref:`float<class_float>` | :ref:`ceiling_db<class_AudioEffectLimiter_property_ceiling_db>`           | ``-0.1`` |
+---------------------------+---------------------------------------------------------------------------+----------+
| :ref:`float<class_float>` | :ref:`soft_clip_db<class_AudioEffectLimiter_property_soft_clip_db>`       | ``2.0``  |
+---------------------------+---------------------------------------------------------------------------+----------+
| :ref:`float<class_float>` | :ref:`soft_clip_ratio<class_AudioEffectLimiter_property_soft_clip_ratio>` | ``10.0`` |
+---------------------------+---------------------------------------------------------------------------+----------+
| :ref:`float<class_float>` | :ref:`threshold_db<class_AudioEffectLimiter_property_threshold_db>`       | ``0.0``  |
+---------------------------+---------------------------------------------------------------------------+----------+

Property Descriptions
---------------------

.. _class_AudioEffectLimiter_property_ceiling_db:

- :ref:`float<class_float>` **ceiling_db**

+-----------+-----------------------+
| *Default* | ``-0.1``              |
+-----------+-----------------------+
| *Setter*  | set_ceiling_db(value) |
+-----------+-----------------------+
| *Getter*  | get_ceiling_db()      |
+-----------+-----------------------+

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

----

.. _class_AudioEffectLimiter_property_soft_clip_db:

- :ref:`float<class_float>` **soft_clip_db**

+-----------+-------------------------+
| *Default* | ``2.0``                 |
+-----------+-------------------------+
| *Setter*  | set_soft_clip_db(value) |
+-----------+-------------------------+
| *Getter*  | get_soft_clip_db()      |
+-----------+-------------------------+

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

----

.. _class_AudioEffectLimiter_property_soft_clip_ratio:

- :ref:`float<class_float>` **soft_clip_ratio**

+-----------+----------------------------+
| *Default* | ``10.0``                   |
+-----------+----------------------------+
| *Setter*  | set_soft_clip_ratio(value) |
+-----------+----------------------------+
| *Getter*  | get_soft_clip_ratio()      |
+-----------+----------------------------+

----

.. _class_AudioEffectLimiter_property_threshold_db:

- :ref:`float<class_float>` **threshold_db**

+-----------+-------------------------+
| *Default* | ``0.0``                 |
+-----------+-------------------------+
| *Setter*  | set_threshold_db(value) |
+-----------+-------------------------+
| *Getter*  | get_threshold_db()      |
+-----------+-------------------------+

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

.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`