1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495 |
- :github_url: hide
- .. Generated automatically by doc/tools/makerst.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>`
- **Category:** Core
- Brief Description
- -----------------
- Adds a soft clip Limiter audio effect to an Audio bus.
- Properties
- ----------
- +---------------------------+---------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`ceiling_db<class_AudioEffectLimiter_property_ceiling_db>` |
- +---------------------------+---------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`soft_clip_db<class_AudioEffectLimiter_property_soft_clip_db>` |
- +---------------------------+---------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`soft_clip_ratio<class_AudioEffectLimiter_property_soft_clip_ratio>` |
- +---------------------------+---------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`threshold_db<class_AudioEffectLimiter_property_threshold_db>` |
- +---------------------------+---------------------------------------------------------------------------+
- 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.
- Property Descriptions
- ---------------------
- .. _class_AudioEffectLimiter_property_ceiling_db:
- - :ref:`float<class_float>` **ceiling_db**
- +----------+-----------------------+
- | *Setter* | set_ceiling_db(value) |
- +----------+-----------------------+
- | *Getter* | get_ceiling_db() |
- +----------+-----------------------+
- The waveform's maximum allowed value. Value can range from -20 to -0.1. Default value: ``-0.1dB``.
- ----
- .. _class_AudioEffectLimiter_property_soft_clip_db:
- - :ref:`float<class_float>` **soft_clip_db**
- +----------+-------------------------+
- | *Setter* | set_soft_clip_db(value) |
- +----------+-------------------------+
- | *Getter* | get_soft_clip_db() |
- +----------+-------------------------+
- Applies a gain to the limited waves. Value can range from 0 to 6. Default value: ``2dB``.
- ----
- .. _class_AudioEffectLimiter_property_soft_clip_ratio:
- - :ref:`float<class_float>` **soft_clip_ratio**
- +----------+----------------------------+
- | *Setter* | set_soft_clip_ratio(value) |
- +----------+----------------------------+
- | *Getter* | get_soft_clip_ratio() |
- +----------+----------------------------+
- ----
- .. _class_AudioEffectLimiter_property_threshold_db:
- - :ref:`float<class_float>` **threshold_db**
- +----------+-------------------------+
- | *Setter* | set_threshold_db(value) |
- +----------+-------------------------+
- | *Getter* | get_threshold_db() |
- +----------+-------------------------+
- Threshold from which the limiter begins to be active. Value can range from -30 to 0. Default value: ``0dB``.
|