Files
godot-docs/classes/class_audioeffectlimiter.rst
T

84 lines
4.4 KiB
ReStructuredText

.. 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
-----------------
Member Functions
----------------
+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_ceiling_db<class_AudioEffectLimiter_get_ceiling_db>` **(** **)** const |
+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_soft_clip_db<class_AudioEffectLimiter_get_soft_clip_db>` **(** **)** const |
+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_soft_clip_ratio<class_AudioEffectLimiter_get_soft_clip_ratio>` **(** **)** const |
+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_threshold_db<class_AudioEffectLimiter_get_threshold_db>` **(** **)** const |
+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_ceiling_db<class_AudioEffectLimiter_set_ceiling_db>` **(** :ref:`float<class_float>` ceiling **)** |
+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_soft_clip_db<class_AudioEffectLimiter_set_soft_clip_db>` **(** :ref:`float<class_float>` soft_clip **)** |
+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_soft_clip_ratio<class_AudioEffectLimiter_set_soft_clip_ratio>` **(** :ref:`float<class_float>` soft_clip **)** |
+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_threshold_db<class_AudioEffectLimiter_set_threshold_db>` **(** :ref:`float<class_float>` threshold **)** |
+----------------------------+----------------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
- :ref:`float<class_float>` **ceiling_db**
- :ref:`float<class_float>` **soft_clip_db**
- :ref:`float<class_float>` **soft_clip_ratio**
- :ref:`float<class_float>` **threshold_db**
Member Function Description
---------------------------
.. _class_AudioEffectLimiter_get_ceiling_db:
- :ref:`float<class_float>` **get_ceiling_db** **(** **)** const
.. _class_AudioEffectLimiter_get_soft_clip_db:
- :ref:`float<class_float>` **get_soft_clip_db** **(** **)** const
.. _class_AudioEffectLimiter_get_soft_clip_ratio:
- :ref:`float<class_float>` **get_soft_clip_ratio** **(** **)** const
.. _class_AudioEffectLimiter_get_threshold_db:
- :ref:`float<class_float>` **get_threshold_db** **(** **)** const
.. _class_AudioEffectLimiter_set_ceiling_db:
- void **set_ceiling_db** **(** :ref:`float<class_float>` ceiling **)**
.. _class_AudioEffectLimiter_set_soft_clip_db:
- void **set_soft_clip_db** **(** :ref:`float<class_float>` soft_clip **)**
.. _class_AudioEffectLimiter_set_soft_clip_ratio:
- void **set_soft_clip_ratio** **(** :ref:`float<class_float>` soft_clip **)**
.. _class_AudioEffectLimiter_set_threshold_db:
- void **set_threshold_db** **(** :ref:`float<class_float>` threshold **)**