godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-05 22:09:56 +03:00
Code Issues Packages Projects Releases Wiki Activity

classref: Sync with current master branch (f87858a8f)

Browse Source
This commit is contained in:
Yuri Sizov
2022-12-05 20:38:58 +03:00
parent 913ff5e602
commit a7745c4cc4
843 changed files with 158186 additions and 80821 deletions
Download Patch File Download Diff File Expand all files Collapse all files

288
classes/class_audioeffectdelay.rst
View File

@@ -16,253 +16,279 @@ Adds a delay audio effect to an audio bus. Plays input signal back after a perio
Two tap delay and feedback options.
.. rst-class:: classref-introduction-group
Description
-----------
Plays input signal back after a period of time. The delayed signal may be played back multiple times to create the sound of a repeating, decaying echo. Delay effects range from a subtle echo effect to a pronounced blending of previous sounds with new sounds.
.. rst-class:: classref-introduction-group
Tutorials
---------
- :doc:`Audio buses <../tutorials/audio/audio_buses>`
.. rst-class:: classref-reftable-group
Properties
----------
+---------------------------+-----------------------------------------------------------------------------+-------------+
| :ref:`float<class_float>` | :ref:`dry<class_AudioEffectDelay_property_dry>` | ``1.0`` |
+---------------------------+-----------------------------------------------------------------------------+-------------+
| :ref:`bool<class_bool>` | :ref:`feedback_active<class_AudioEffectDelay_property_feedback_active>` | ``false`` |
+---------------------------+-----------------------------------------------------------------------------+-------------+
| :ref:`float<class_float>` | :ref:`feedback_delay_ms<class_AudioEffectDelay_property_feedback_delay_ms>` | ``340.0`` |
+---------------------------+-----------------------------------------------------------------------------+-------------+
| :ref:`float<class_float>` | :ref:`feedback_level_db<class_AudioEffectDelay_property_feedback_level_db>` | ``-6.0`` |
+---------------------------+-----------------------------------------------------------------------------+-------------+
| :ref:`float<class_float>` | :ref:`feedback_lowpass<class_AudioEffectDelay_property_feedback_lowpass>` | ``16000.0`` |
+---------------------------+-----------------------------------------------------------------------------+-------------+
| :ref:`bool<class_bool>` | :ref:`tap1_active<class_AudioEffectDelay_property_tap1_active>` | ``true`` |
+---------------------------+-----------------------------------------------------------------------------+-------------+
| :ref:`float<class_float>` | :ref:`tap1_delay_ms<class_AudioEffectDelay_property_tap1_delay_ms>` | ``250.0`` |
+---------------------------+-----------------------------------------------------------------------------+-------------+
| :ref:`float<class_float>` | :ref:`tap1_level_db<class_AudioEffectDelay_property_tap1_level_db>` | ``-6.0`` |
+---------------------------+-----------------------------------------------------------------------------+-------------+
| :ref:`float<class_float>` | :ref:`tap1_pan<class_AudioEffectDelay_property_tap1_pan>` | ``0.2`` |
+---------------------------+-----------------------------------------------------------------------------+-------------+
| :ref:`bool<class_bool>` | :ref:`tap2_active<class_AudioEffectDelay_property_tap2_active>` | ``true`` |
+---------------------------+-----------------------------------------------------------------------------+-------------+
| :ref:`float<class_float>` | :ref:`tap2_delay_ms<class_AudioEffectDelay_property_tap2_delay_ms>` | ``500.0`` |
+---------------------------+-----------------------------------------------------------------------------+-------------+
| :ref:`float<class_float>` | :ref:`tap2_level_db<class_AudioEffectDelay_property_tap2_level_db>` | ``-12.0`` |
+---------------------------+-----------------------------------------------------------------------------+-------------+
| :ref:`float<class_float>` | :ref:`tap2_pan<class_AudioEffectDelay_property_tap2_pan>` | ``-0.4`` |
+---------------------------+-----------------------------------------------------------------------------+-------------+
.. table::
:widths: auto
+---------------------------+-----------------------------------------------------------------------------+-------------+
| :ref:`float<class_float>` | :ref:`dry<class_AudioEffectDelay_property_dry>` | ``1.0`` |
+---------------------------+-----------------------------------------------------------------------------+-------------+
| :ref:`bool<class_bool>` | :ref:`feedback_active<class_AudioEffectDelay_property_feedback_active>` | ``false`` |
+---------------------------+-----------------------------------------------------------------------------+-------------+
| :ref:`float<class_float>` | :ref:`feedback_delay_ms<class_AudioEffectDelay_property_feedback_delay_ms>` | ``340.0`` |
+---------------------------+-----------------------------------------------------------------------------+-------------+
| :ref:`float<class_float>` | :ref:`feedback_level_db<class_AudioEffectDelay_property_feedback_level_db>` | ``-6.0`` |
+---------------------------+-----------------------------------------------------------------------------+-------------+
| :ref:`float<class_float>` | :ref:`feedback_lowpass<class_AudioEffectDelay_property_feedback_lowpass>` | ``16000.0`` |
+---------------------------+-----------------------------------------------------------------------------+-------------+
| :ref:`bool<class_bool>` | :ref:`tap1_active<class_AudioEffectDelay_property_tap1_active>` | ``true`` |
+---------------------------+-----------------------------------------------------------------------------+-------------+
| :ref:`float<class_float>` | :ref:`tap1_delay_ms<class_AudioEffectDelay_property_tap1_delay_ms>` | ``250.0`` |
+---------------------------+-----------------------------------------------------------------------------+-------------+
| :ref:`float<class_float>` | :ref:`tap1_level_db<class_AudioEffectDelay_property_tap1_level_db>` | ``-6.0`` |
+---------------------------+-----------------------------------------------------------------------------+-------------+
| :ref:`float<class_float>` | :ref:`tap1_pan<class_AudioEffectDelay_property_tap1_pan>` | ``0.2`` |
+---------------------------+-----------------------------------------------------------------------------+-------------+
| :ref:`bool<class_bool>` | :ref:`tap2_active<class_AudioEffectDelay_property_tap2_active>` | ``true`` |
+---------------------------+-----------------------------------------------------------------------------+-------------+
| :ref:`float<class_float>` | :ref:`tap2_delay_ms<class_AudioEffectDelay_property_tap2_delay_ms>` | ``500.0`` |
+---------------------------+-----------------------------------------------------------------------------+-------------+
| :ref:`float<class_float>` | :ref:`tap2_level_db<class_AudioEffectDelay_property_tap2_level_db>` | ``-12.0`` |
+---------------------------+-----------------------------------------------------------------------------+-------------+
| :ref:`float<class_float>` | :ref:`tap2_pan<class_AudioEffectDelay_property_tap2_pan>` | ``-0.4`` |
+---------------------------+-----------------------------------------------------------------------------+-------------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Property Descriptions
---------------------
.. _class_AudioEffectDelay_property_dry:
- :ref:`float<class_float>` **dry**
.. rst-class:: classref-property
+-----------+----------------+
| *Default* | ``1.0`` |
+-----------+----------------+
| *Setter* | set_dry(value) |
+-----------+----------------+
| *Getter* | get_dry() |
+-----------+----------------+
:ref:`float<class_float>` **dry** = ``1.0``
.. rst-class:: classref-property-setget
- void **set_dry** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_dry** **(** **)**
Output percent of original sound. At 0, only delayed sounds are output. Value can range from 0 to 1.
.. rst-class:: classref-item-separator
----
.. _class_AudioEffectDelay_property_feedback_active:
- :ref:`bool<class_bool>` **feedback_active**
.. rst-class:: classref-property
+-----------+----------------------------+
| *Default* | ``false`` |
+-----------+----------------------------+
| *Setter* | set_feedback_active(value) |
+-----------+----------------------------+
| *Getter* | is_feedback_active() |
+-----------+----------------------------+
:ref:`bool<class_bool>` **feedback_active** = ``false``
.. rst-class:: classref-property-setget
- void **set_feedback_active** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_feedback_active** **(** **)**
If ``true``, feedback is enabled.
.. rst-class:: classref-item-separator
----
.. _class_AudioEffectDelay_property_feedback_delay_ms:
- :ref:`float<class_float>` **feedback_delay_ms**
.. rst-class:: classref-property
+-----------+------------------------------+
| *Default* | ``340.0`` |
+-----------+------------------------------+
| *Setter* | set_feedback_delay_ms(value) |
+-----------+------------------------------+
| *Getter* | get_feedback_delay_ms() |
+-----------+------------------------------+
:ref:`float<class_float>` **feedback_delay_ms** = ``340.0``
.. rst-class:: classref-property-setget
- void **set_feedback_delay_ms** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_feedback_delay_ms** **(** **)**
Feedback delay time in milliseconds.
.. rst-class:: classref-item-separator
----
.. _class_AudioEffectDelay_property_feedback_level_db:
- :ref:`float<class_float>` **feedback_level_db**
.. rst-class:: classref-property
+-----------+------------------------------+
| *Default* | ``-6.0`` |
+-----------+------------------------------+
| *Setter* | set_feedback_level_db(value) |
+-----------+------------------------------+
| *Getter* | get_feedback_level_db() |
+-----------+------------------------------+
:ref:`float<class_float>` **feedback_level_db** = ``-6.0``
.. rst-class:: classref-property-setget
- void **set_feedback_level_db** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_feedback_level_db** **(** **)**
Sound level for ``tap1``.
.. rst-class:: classref-item-separator
----
.. _class_AudioEffectDelay_property_feedback_lowpass:
- :ref:`float<class_float>` **feedback_lowpass**
.. rst-class:: classref-property
+-----------+-----------------------------+
| *Default* | ``16000.0`` |
+-----------+-----------------------------+
| *Setter* | set_feedback_lowpass(value) |
+-----------+-----------------------------+
| *Getter* | get_feedback_lowpass() |
+-----------+-----------------------------+
:ref:`float<class_float>` **feedback_lowpass** = ``16000.0``
.. rst-class:: classref-property-setget
- void **set_feedback_lowpass** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_feedback_lowpass** **(** **)**
Low-pass filter for feedback, in Hz. Frequencies below this value are filtered out of the source signal.
.. rst-class:: classref-item-separator
----
.. _class_AudioEffectDelay_property_tap1_active:
- :ref:`bool<class_bool>` **tap1_active**
.. rst-class:: classref-property
+-----------+------------------------+
| *Default* | ``true`` |
+-----------+------------------------+
| *Setter* | set_tap1_active(value) |
+-----------+------------------------+
| *Getter* | is_tap1_active() |
+-----------+------------------------+
:ref:`bool<class_bool>` **tap1_active** = ``true``
.. rst-class:: classref-property-setget
- void **set_tap1_active** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_tap1_active** **(** **)**
If ``true``, ``tap1`` will be enabled.
.. rst-class:: classref-item-separator
----
.. _class_AudioEffectDelay_property_tap1_delay_ms:
- :ref:`float<class_float>` **tap1_delay_ms**
.. rst-class:: classref-property
+-----------+--------------------------+
| *Default* | ``250.0`` |
+-----------+--------------------------+
| *Setter* | set_tap1_delay_ms(value) |
+-----------+--------------------------+
| *Getter* | get_tap1_delay_ms() |
+-----------+--------------------------+
:ref:`float<class_float>` **tap1_delay_ms** = ``250.0``
.. rst-class:: classref-property-setget
- void **set_tap1_delay_ms** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_tap1_delay_ms** **(** **)**
``tap1`` delay time in milliseconds.
.. rst-class:: classref-item-separator
----
.. _class_AudioEffectDelay_property_tap1_level_db:
- :ref:`float<class_float>` **tap1_level_db**
.. rst-class:: classref-property
+-----------+--------------------------+
| *Default* | ``-6.0`` |
+-----------+--------------------------+
| *Setter* | set_tap1_level_db(value) |
+-----------+--------------------------+
| *Getter* | get_tap1_level_db() |
+-----------+--------------------------+
:ref:`float<class_float>` **tap1_level_db** = ``-6.0``
.. rst-class:: classref-property-setget
- void **set_tap1_level_db** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_tap1_level_db** **(** **)**
Sound level for ``tap1``.
.. rst-class:: classref-item-separator
----
.. _class_AudioEffectDelay_property_tap1_pan:
- :ref:`float<class_float>` **tap1_pan**
.. rst-class:: classref-property
+-----------+---------------------+
| *Default* | ``0.2`` |
+-----------+---------------------+
| *Setter* | set_tap1_pan(value) |
+-----------+---------------------+
| *Getter* | get_tap1_pan() |
+-----------+---------------------+
:ref:`float<class_float>` **tap1_pan** = ``0.2``
.. rst-class:: classref-property-setget
- void **set_tap1_pan** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_tap1_pan** **(** **)**
Pan position for ``tap1``. Value can range from -1 (fully left) to 1 (fully right).
.. rst-class:: classref-item-separator
----
.. _class_AudioEffectDelay_property_tap2_active:
- :ref:`bool<class_bool>` **tap2_active**
.. rst-class:: classref-property
+-----------+------------------------+
| *Default* | ``true`` |
+-----------+------------------------+
| *Setter* | set_tap2_active(value) |
+-----------+------------------------+
| *Getter* | is_tap2_active() |
+-----------+------------------------+
:ref:`bool<class_bool>` **tap2_active** = ``true``
.. rst-class:: classref-property-setget
- void **set_tap2_active** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_tap2_active** **(** **)**
If ``true``, ``tap2`` will be enabled.
.. rst-class:: classref-item-separator
----
.. _class_AudioEffectDelay_property_tap2_delay_ms:
- :ref:`float<class_float>` **tap2_delay_ms**
.. rst-class:: classref-property
+-----------+--------------------------+
| *Default* | ``500.0`` |
+-----------+--------------------------+
| *Setter* | set_tap2_delay_ms(value) |
+-----------+--------------------------+
| *Getter* | get_tap2_delay_ms() |
+-----------+--------------------------+
:ref:`float<class_float>` **tap2_delay_ms** = ``500.0``
.. rst-class:: classref-property-setget
- void **set_tap2_delay_ms** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_tap2_delay_ms** **(** **)**
**Tap2** delay time in milliseconds.
.. rst-class:: classref-item-separator
----
.. _class_AudioEffectDelay_property_tap2_level_db:
- :ref:`float<class_float>` **tap2_level_db**
.. rst-class:: classref-property
+-----------+--------------------------+
| *Default* | ``-12.0`` |
+-----------+--------------------------+
| *Setter* | set_tap2_level_db(value) |
+-----------+--------------------------+
| *Getter* | get_tap2_level_db() |
+-----------+--------------------------+
:ref:`float<class_float>` **tap2_level_db** = ``-12.0``
.. rst-class:: classref-property-setget
- void **set_tap2_level_db** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_tap2_level_db** **(** **)**
Sound level for ``tap2``.
.. rst-class:: classref-item-separator
----
.. _class_AudioEffectDelay_property_tap2_pan:
- :ref:`float<class_float>` **tap2_pan**
.. rst-class:: classref-property
+-----------+---------------------+
| *Default* | ``-0.4`` |
+-----------+---------------------+
| *Setter* | set_tap2_pan(value) |
+-----------+---------------------+
| *Getter* | get_tap2_pan() |
+-----------+---------------------+
:ref:`float<class_float>` **tap2_pan** = ``-0.4``
.. rst-class:: classref-property-setget
- void **set_tap2_pan** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_tap2_pan** **(** **)**
Pan position for ``tap2``. Value can range from -1 (fully left) to 1 (fully right).