mirror of
https://github.com/godotengine/godot-docs.git
synced 2025-12-31 17:49:03 +03:00
302 lines
11 KiB
ReStructuredText
302 lines
11 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. DO NOT EDIT THIS FILE!!!
|
|
.. Generated automatically from Godot engine sources.
|
|
.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py.
|
|
.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/AudioEffectDelay.xml.
|
|
|
|
.. _class_AudioEffectDelay:
|
|
|
|
AudioEffectDelay
|
|
================
|
|
|
|
**Inherits:** :ref:`AudioEffect<class_AudioEffect>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
|
|
|
|
Adds a delay audio effect to an audio bus. Plays input signal back after a period of time.
|
|
|
|
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
|
|
----------
|
|
|
|
.. 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:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
: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:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
: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:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
: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:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
: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 feedback.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_AudioEffectDelay_property_feedback_lowpass:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
: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:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
: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``, the first tap will be enabled.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_AudioEffectDelay_property_tap1_delay_ms:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
: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** **(** **)**
|
|
|
|
First tap delay time in milliseconds.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_AudioEffectDelay_property_tap1_level_db:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
: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 the first tap.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_AudioEffectDelay_property_tap1_pan:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
: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 the first tap. Value can range from -1 (fully left) to 1 (fully right).
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_AudioEffectDelay_property_tap2_active:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
: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``, the second tap will be enabled.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_AudioEffectDelay_property_tap2_delay_ms:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
: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** **(** **)**
|
|
|
|
Second tap delay time in milliseconds.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_AudioEffectDelay_property_tap2_level_db:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
: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 the second tap.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_AudioEffectDelay_property_tap2_pan:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
: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 the second tap. Value can range from -1 (fully left) to 1 (fully right).
|
|
|
|
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
|
|
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
|
|
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
|
|
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
|
|
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
|
|
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
|
|
.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
|