Files
godot-docs/classes/class_audioeffectdelay.rst
2017-04-07 22:11:07 +02:00

200 lines
12 KiB
ReStructuredText

.. 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_AudioEffectDelay:
AudioEffectDelay
================
**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_dry<class_AudioEffectDelay_get_dry>` **(** **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_feedback_delay_ms<class_AudioEffectDelay_get_feedback_delay_ms>` **(** **)** const |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_feedback_level_db<class_AudioEffectDelay_get_feedback_level_db>` **(** **)** const |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_feedback_lowpass<class_AudioEffectDelay_get_feedback_lowpass>` **(** **)** const |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_tap1_delay_ms<class_AudioEffectDelay_get_tap1_delay_ms>` **(** **)** const |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_tap1_level_db<class_AudioEffectDelay_get_tap1_level_db>` **(** **)** const |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_tap1_pan<class_AudioEffectDelay_get_tap1_pan>` **(** **)** const |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_tap2_delay_ms<class_AudioEffectDelay_get_tap2_delay_ms>` **(** **)** const |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_tap2_level_db<class_AudioEffectDelay_get_tap2_level_db>` **(** **)** const |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_tap2_pan<class_AudioEffectDelay_get_tap2_pan>` **(** **)** const |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_feedback_active<class_AudioEffectDelay_is_feedback_active>` **(** **)** const |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_tap1_active<class_AudioEffectDelay_is_tap1_active>` **(** **)** const |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_tap2_active<class_AudioEffectDelay_is_tap2_active>` **(** **)** const |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_dry<class_AudioEffectDelay_set_dry>` **(** :ref:`float<class_float>` amount **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_feedback_active<class_AudioEffectDelay_set_feedback_active>` **(** :ref:`bool<class_bool>` amount **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_feedback_delay_ms<class_AudioEffectDelay_set_feedback_delay_ms>` **(** :ref:`float<class_float>` amount **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_feedback_level_db<class_AudioEffectDelay_set_feedback_level_db>` **(** :ref:`float<class_float>` amount **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_feedback_lowpass<class_AudioEffectDelay_set_feedback_lowpass>` **(** :ref:`float<class_float>` amount **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_tap1_active<class_AudioEffectDelay_set_tap1_active>` **(** :ref:`bool<class_bool>` amount **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_tap1_delay_ms<class_AudioEffectDelay_set_tap1_delay_ms>` **(** :ref:`float<class_float>` amount **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_tap1_level_db<class_AudioEffectDelay_set_tap1_level_db>` **(** :ref:`float<class_float>` amount **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_tap1_pan<class_AudioEffectDelay_set_tap1_pan>` **(** :ref:`float<class_float>` amount **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_tap2_active<class_AudioEffectDelay_set_tap2_active>` **(** :ref:`bool<class_bool>` amount **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_tap2_delay_ms<class_AudioEffectDelay_set_tap2_delay_ms>` **(** :ref:`float<class_float>` amount **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_tap2_level_db<class_AudioEffectDelay_set_tap2_level_db>` **(** :ref:`float<class_float>` amount **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_tap2_pan<class_AudioEffectDelay_set_tap2_pan>` **(** :ref:`float<class_float>` amount **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
- :ref:`float<class_float>` **dry**
- :ref:`bool<class_bool>` **feedback/active**
- :ref:`float<class_float>` **feedback/delay_ms**
- :ref:`float<class_float>` **feedback/level_db**
- :ref:`float<class_float>` **feedback/lowpass**
- :ref:`bool<class_bool>` **tap1/active**
- :ref:`float<class_float>` **tap1/delay_ms**
- :ref:`float<class_float>` **tap1/level_db**
- :ref:`float<class_float>` **tap1/pan**
- :ref:`bool<class_bool>` **tap2/active**
- :ref:`float<class_float>` **tap2/delay_ms**
- :ref:`float<class_float>` **tap2/level_db**
- :ref:`float<class_float>` **tap2/pan**
Member Function Description
---------------------------
.. _class_AudioEffectDelay_get_dry:
- :ref:`float<class_float>` **get_dry** **(** **)**
.. _class_AudioEffectDelay_get_feedback_delay_ms:
- :ref:`float<class_float>` **get_feedback_delay_ms** **(** **)** const
.. _class_AudioEffectDelay_get_feedback_level_db:
- :ref:`float<class_float>` **get_feedback_level_db** **(** **)** const
.. _class_AudioEffectDelay_get_feedback_lowpass:
- :ref:`float<class_float>` **get_feedback_lowpass** **(** **)** const
.. _class_AudioEffectDelay_get_tap1_delay_ms:
- :ref:`float<class_float>` **get_tap1_delay_ms** **(** **)** const
.. _class_AudioEffectDelay_get_tap1_level_db:
- :ref:`float<class_float>` **get_tap1_level_db** **(** **)** const
.. _class_AudioEffectDelay_get_tap1_pan:
- :ref:`float<class_float>` **get_tap1_pan** **(** **)** const
.. _class_AudioEffectDelay_get_tap2_delay_ms:
- :ref:`float<class_float>` **get_tap2_delay_ms** **(** **)** const
.. _class_AudioEffectDelay_get_tap2_level_db:
- :ref:`float<class_float>` **get_tap2_level_db** **(** **)** const
.. _class_AudioEffectDelay_get_tap2_pan:
- :ref:`float<class_float>` **get_tap2_pan** **(** **)** const
.. _class_AudioEffectDelay_is_feedback_active:
- :ref:`bool<class_bool>` **is_feedback_active** **(** **)** const
.. _class_AudioEffectDelay_is_tap1_active:
- :ref:`bool<class_bool>` **is_tap1_active** **(** **)** const
.. _class_AudioEffectDelay_is_tap2_active:
- :ref:`bool<class_bool>` **is_tap2_active** **(** **)** const
.. _class_AudioEffectDelay_set_dry:
- void **set_dry** **(** :ref:`float<class_float>` amount **)**
.. _class_AudioEffectDelay_set_feedback_active:
- void **set_feedback_active** **(** :ref:`bool<class_bool>` amount **)**
.. _class_AudioEffectDelay_set_feedback_delay_ms:
- void **set_feedback_delay_ms** **(** :ref:`float<class_float>` amount **)**
.. _class_AudioEffectDelay_set_feedback_level_db:
- void **set_feedback_level_db** **(** :ref:`float<class_float>` amount **)**
.. _class_AudioEffectDelay_set_feedback_lowpass:
- void **set_feedback_lowpass** **(** :ref:`float<class_float>` amount **)**
.. _class_AudioEffectDelay_set_tap1_active:
- void **set_tap1_active** **(** :ref:`bool<class_bool>` amount **)**
.. _class_AudioEffectDelay_set_tap1_delay_ms:
- void **set_tap1_delay_ms** **(** :ref:`float<class_float>` amount **)**
.. _class_AudioEffectDelay_set_tap1_level_db:
- void **set_tap1_level_db** **(** :ref:`float<class_float>` amount **)**
.. _class_AudioEffectDelay_set_tap1_pan:
- void **set_tap1_pan** **(** :ref:`float<class_float>` amount **)**
.. _class_AudioEffectDelay_set_tap2_active:
- void **set_tap2_active** **(** :ref:`bool<class_bool>` amount **)**
.. _class_AudioEffectDelay_set_tap2_delay_ms:
- void **set_tap2_delay_ms** **(** :ref:`float<class_float>` amount **)**
.. _class_AudioEffectDelay_set_tap2_level_db:
- void **set_tap2_level_db** **(** :ref:`float<class_float>` amount **)**
.. _class_AudioEffectDelay_set_tap2_pan:
- void **set_tap2_pan** **(** :ref:`float<class_float>` amount **)**