godot-docs/classes/class_audioeffectcompressor.rst

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.

.. _class_AudioEffectCompressor:

AudioEffectCompressor
=====================

**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_attack_us<class_AudioEffectCompressor_get_attack_us>`  **(** **)** const                                   |
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`    | :ref:`get_gain<class_AudioEffectCompressor_get_gain>`  **(** **)** const                                             |
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`    | :ref:`get_mix<class_AudioEffectCompressor_get_mix>`  **(** **)** const                                               |
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`    | :ref:`get_ratio<class_AudioEffectCompressor_get_ratio>`  **(** **)** const                                           |
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`    | :ref:`get_release_ms<class_AudioEffectCompressor_get_release_ms>`  **(** **)** const                                 |
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>`  | :ref:`get_sidechain<class_AudioEffectCompressor_get_sidechain>`  **(** **)** const                                   |
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`    | :ref:`get_treshold<class_AudioEffectCompressor_get_treshold>`  **(** **)** const                                     |
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
| void                         | :ref:`set_attack_us<class_AudioEffectCompressor_set_attack_us>`  **(** :ref:`float<class_float>` attack_us  **)**    |
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
| void                         | :ref:`set_gain<class_AudioEffectCompressor_set_gain>`  **(** :ref:`float<class_float>` gain  **)**                   |
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
| void                         | :ref:`set_mix<class_AudioEffectCompressor_set_mix>`  **(** :ref:`float<class_float>` mix  **)**                      |
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
| void                         | :ref:`set_ratio<class_AudioEffectCompressor_set_ratio>`  **(** :ref:`float<class_float>` ratio  **)**                |
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
| void                         | :ref:`set_release_ms<class_AudioEffectCompressor_set_release_ms>`  **(** :ref:`float<class_float>` release_ms  **)** |
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
| void                         | :ref:`set_sidechain<class_AudioEffectCompressor_set_sidechain>`  **(** :ref:`String<class_string>` sidechain  **)**  |
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
| void                         | :ref:`set_treshold<class_AudioEffectCompressor_set_treshold>`  **(** :ref:`float<class_float>` treshold  **)**       |
+------------------------------+----------------------------------------------------------------------------------------------------------------------+

Member Variables
----------------

- :ref:`float<class_float>` **attack_us**
- :ref:`float<class_float>` **gain**
- :ref:`float<class_float>` **mix**
- :ref:`float<class_float>` **ratio**
- :ref:`float<class_float>` **release_ms**
- :ref:`float<class_float>` **sidechain**
- :ref:`float<class_float>` **treshold**

Member Function Description
---------------------------

.. _class_AudioEffectCompressor_get_attack_us:

- :ref:`float<class_float>`  **get_attack_us**  **(** **)** const

.. _class_AudioEffectCompressor_get_gain:

- :ref:`float<class_float>`  **get_gain**  **(** **)** const

.. _class_AudioEffectCompressor_get_mix:

- :ref:`float<class_float>`  **get_mix**  **(** **)** const

.. _class_AudioEffectCompressor_get_ratio:

- :ref:`float<class_float>`  **get_ratio**  **(** **)** const

.. _class_AudioEffectCompressor_get_release_ms:

- :ref:`float<class_float>`  **get_release_ms**  **(** **)** const

.. _class_AudioEffectCompressor_get_sidechain:

- :ref:`String<class_string>`  **get_sidechain**  **(** **)** const

.. _class_AudioEffectCompressor_get_treshold:

- :ref:`float<class_float>`  **get_treshold**  **(** **)** const

.. _class_AudioEffectCompressor_set_attack_us:

- void  **set_attack_us**  **(** :ref:`float<class_float>` attack_us  **)**

.. _class_AudioEffectCompressor_set_gain:

- void  **set_gain**  **(** :ref:`float<class_float>` gain  **)**

.. _class_AudioEffectCompressor_set_mix:

- void  **set_mix**  **(** :ref:`float<class_float>` mix  **)**

.. _class_AudioEffectCompressor_set_ratio:

- void  **set_ratio**  **(** :ref:`float<class_float>` ratio  **)**

.. _class_AudioEffectCompressor_set_release_ms:

- void  **set_release_ms**  **(** :ref:`float<class_float>` release_ms  **)**

.. _class_AudioEffectCompressor_set_sidechain:

- void  **set_sidechain**  **(** :ref:`String<class_string>` sidechain  **)**

.. _class_AudioEffectCompressor_set_treshold:

- void  **set_treshold**  **(** :ref:`float<class_float>` treshold  **)**