mirror of
https://github.com/stan220/godot-docs.git
synced 2026-09-08 22:29:18 +00:00
104 lines
3.8 KiB
ReStructuredText
104 lines
3.8 KiB
ReStructuredText
: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>` | -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 |
|
|
+---------------------------+---------------------------------------------------------------------------+------+
|
|
|
|
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**
|
|
|
|
+-----------+-----------------------+
|
|
| *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.
|
|
|