godot-docs/classes/class_audioeffectchorus.rst

:github_url: hide

.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the AudioEffectChorus.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_AudioEffectChorus:

AudioEffectChorus
=================

**Inherits:** :ref:`AudioEffect<class_AudioEffect>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`

Adds a chorus audio effect.

Description
-----------

Adds a chorus audio effect. The effect applies a filter with voices to duplicate the audio source and manipulate it through the filter.

Properties
----------

+---------------------------+------------------------------------------------------------------------------+------------+
| :ref:`float<class_float>` | :ref:`dry<class_AudioEffectChorus_property_dry>`                             | ``1.0``    |
+---------------------------+------------------------------------------------------------------------------+------------+
| :ref:`float<class_float>` | :ref:`voice/1/cutoff_hz<class_AudioEffectChorus_property_voice/1/cutoff_hz>` | ``8000.0`` |
+---------------------------+------------------------------------------------------------------------------+------------+
| :ref:`float<class_float>` | :ref:`voice/1/delay_ms<class_AudioEffectChorus_property_voice/1/delay_ms>`   | ``15.0``   |
+---------------------------+------------------------------------------------------------------------------+------------+
| :ref:`float<class_float>` | :ref:`voice/1/depth_ms<class_AudioEffectChorus_property_voice/1/depth_ms>`   | ``2.0``    |
+---------------------------+------------------------------------------------------------------------------+------------+
| :ref:`float<class_float>` | :ref:`voice/1/level_db<class_AudioEffectChorus_property_voice/1/level_db>`   | ``0.0``    |
+---------------------------+------------------------------------------------------------------------------+------------+
| :ref:`float<class_float>` | :ref:`voice/1/pan<class_AudioEffectChorus_property_voice/1/pan>`             | ``-0.5``   |
+---------------------------+------------------------------------------------------------------------------+------------+
| :ref:`float<class_float>` | :ref:`voice/1/rate_hz<class_AudioEffectChorus_property_voice/1/rate_hz>`     | ``0.8``    |
+---------------------------+------------------------------------------------------------------------------+------------+
| :ref:`float<class_float>` | :ref:`voice/2/cutoff_hz<class_AudioEffectChorus_property_voice/2/cutoff_hz>` | ``8000.0`` |
+---------------------------+------------------------------------------------------------------------------+------------+
| :ref:`float<class_float>` | :ref:`voice/2/delay_ms<class_AudioEffectChorus_property_voice/2/delay_ms>`   | ``20.0``   |
+---------------------------+------------------------------------------------------------------------------+------------+
| :ref:`float<class_float>` | :ref:`voice/2/depth_ms<class_AudioEffectChorus_property_voice/2/depth_ms>`   | ``3.0``    |
+---------------------------+------------------------------------------------------------------------------+------------+
| :ref:`float<class_float>` | :ref:`voice/2/level_db<class_AudioEffectChorus_property_voice/2/level_db>`   | ``0.0``    |
+---------------------------+------------------------------------------------------------------------------+------------+
| :ref:`float<class_float>` | :ref:`voice/2/pan<class_AudioEffectChorus_property_voice/2/pan>`             | ``0.5``    |
+---------------------------+------------------------------------------------------------------------------+------------+
| :ref:`float<class_float>` | :ref:`voice/2/rate_hz<class_AudioEffectChorus_property_voice/2/rate_hz>`     | ``1.2``    |
+---------------------------+------------------------------------------------------------------------------+------------+
| :ref:`float<class_float>` | :ref:`voice/3/cutoff_hz<class_AudioEffectChorus_property_voice/3/cutoff_hz>` |            |
+---------------------------+------------------------------------------------------------------------------+------------+
| :ref:`float<class_float>` | :ref:`voice/3/delay_ms<class_AudioEffectChorus_property_voice/3/delay_ms>`   |            |
+---------------------------+------------------------------------------------------------------------------+------------+
| :ref:`float<class_float>` | :ref:`voice/3/depth_ms<class_AudioEffectChorus_property_voice/3/depth_ms>`   |            |
+---------------------------+------------------------------------------------------------------------------+------------+
| :ref:`float<class_float>` | :ref:`voice/3/level_db<class_AudioEffectChorus_property_voice/3/level_db>`   |            |
+---------------------------+------------------------------------------------------------------------------+------------+
| :ref:`float<class_float>` | :ref:`voice/3/pan<class_AudioEffectChorus_property_voice/3/pan>`             |            |
+---------------------------+------------------------------------------------------------------------------+------------+
| :ref:`float<class_float>` | :ref:`voice/3/rate_hz<class_AudioEffectChorus_property_voice/3/rate_hz>`     |            |
+---------------------------+------------------------------------------------------------------------------+------------+
| :ref:`float<class_float>` | :ref:`voice/4/cutoff_hz<class_AudioEffectChorus_property_voice/4/cutoff_hz>` |            |
+---------------------------+------------------------------------------------------------------------------+------------+
| :ref:`float<class_float>` | :ref:`voice/4/delay_ms<class_AudioEffectChorus_property_voice/4/delay_ms>`   |            |
+---------------------------+------------------------------------------------------------------------------+------------+
| :ref:`float<class_float>` | :ref:`voice/4/depth_ms<class_AudioEffectChorus_property_voice/4/depth_ms>`   |            |
+---------------------------+------------------------------------------------------------------------------+------------+
| :ref:`float<class_float>` | :ref:`voice/4/level_db<class_AudioEffectChorus_property_voice/4/level_db>`   |            |
+---------------------------+------------------------------------------------------------------------------+------------+
| :ref:`float<class_float>` | :ref:`voice/4/pan<class_AudioEffectChorus_property_voice/4/pan>`             |            |
+---------------------------+------------------------------------------------------------------------------+------------+
| :ref:`float<class_float>` | :ref:`voice/4/rate_hz<class_AudioEffectChorus_property_voice/4/rate_hz>`     |            |
+---------------------------+------------------------------------------------------------------------------+------------+
| :ref:`int<class_int>`     | :ref:`voice_count<class_AudioEffectChorus_property_voice_count>`             | ``2``      |
+---------------------------+------------------------------------------------------------------------------+------------+
| :ref:`float<class_float>` | :ref:`wet<class_AudioEffectChorus_property_wet>`                             | ``0.5``    |
+---------------------------+------------------------------------------------------------------------------+------------+

Methods
-------

+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_voice_cutoff_hz<class_AudioEffectChorus_method_get_voice_cutoff_hz>` **(** :ref:`int<class_int>` voice_idx **)** |const|                              |
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_voice_delay_ms<class_AudioEffectChorus_method_get_voice_delay_ms>` **(** :ref:`int<class_int>` voice_idx **)** |const|                                |
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_voice_depth_ms<class_AudioEffectChorus_method_get_voice_depth_ms>` **(** :ref:`int<class_int>` voice_idx **)** |const|                                |
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_voice_level_db<class_AudioEffectChorus_method_get_voice_level_db>` **(** :ref:`int<class_int>` voice_idx **)** |const|                                |
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_voice_pan<class_AudioEffectChorus_method_get_voice_pan>` **(** :ref:`int<class_int>` voice_idx **)** |const|                                          |
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_voice_rate_hz<class_AudioEffectChorus_method_get_voice_rate_hz>` **(** :ref:`int<class_int>` voice_idx **)** |const|                                  |
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                      | :ref:`set_voice_cutoff_hz<class_AudioEffectChorus_method_set_voice_cutoff_hz>` **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` cutoff_hz **)** |
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                      | :ref:`set_voice_delay_ms<class_AudioEffectChorus_method_set_voice_delay_ms>` **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` delay_ms **)**    |
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                      | :ref:`set_voice_depth_ms<class_AudioEffectChorus_method_set_voice_depth_ms>` **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` depth_ms **)**    |
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                      | :ref:`set_voice_level_db<class_AudioEffectChorus_method_set_voice_level_db>` **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` level_db **)**    |
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                      | :ref:`set_voice_pan<class_AudioEffectChorus_method_set_voice_pan>` **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` pan **)**                   |
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                      | :ref:`set_voice_rate_hz<class_AudioEffectChorus_method_set_voice_rate_hz>` **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` rate_hz **)**       |
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+

Property Descriptions
---------------------

.. _class_AudioEffectChorus_property_dry:

- :ref:`float<class_float>` **dry**

+-----------+----------------+
| *Default* | ``1.0``        |
+-----------+----------------+
| *Setter*  | set_dry(value) |
+-----------+----------------+
| *Getter*  | get_dry()      |
+-----------+----------------+

The effect's raw signal.

----

.. _class_AudioEffectChorus_property_voice/1/cutoff_hz:

- :ref:`float<class_float>` **voice/1/cutoff_hz**

+-----------+----------------------------+
| *Default* | ``8000.0``                 |
+-----------+----------------------------+
| *Setter*  | set_voice_cutoff_hz(value) |
+-----------+----------------------------+
| *Getter*  | get_voice_cutoff_hz()      |
+-----------+----------------------------+

The voice's cutoff frequency.

----

.. _class_AudioEffectChorus_property_voice/1/delay_ms:

- :ref:`float<class_float>` **voice/1/delay_ms**

+-----------+---------------------------+
| *Default* | ``15.0``                  |
+-----------+---------------------------+
| *Setter*  | set_voice_delay_ms(value) |
+-----------+---------------------------+
| *Getter*  | get_voice_delay_ms()      |
+-----------+---------------------------+

The voice's signal delay.

----

.. _class_AudioEffectChorus_property_voice/1/depth_ms:

- :ref:`float<class_float>` **voice/1/depth_ms**

+-----------+---------------------------+
| *Default* | ``2.0``                   |
+-----------+---------------------------+
| *Setter*  | set_voice_depth_ms(value) |
+-----------+---------------------------+
| *Getter*  | get_voice_depth_ms()      |
+-----------+---------------------------+

The voice filter's depth.

----

.. _class_AudioEffectChorus_property_voice/1/level_db:

- :ref:`float<class_float>` **voice/1/level_db**

+-----------+---------------------------+
| *Default* | ``0.0``                   |
+-----------+---------------------------+
| *Setter*  | set_voice_level_db(value) |
+-----------+---------------------------+
| *Getter*  | get_voice_level_db()      |
+-----------+---------------------------+

The voice's volume.

----

.. _class_AudioEffectChorus_property_voice/1/pan:

- :ref:`float<class_float>` **voice/1/pan**

+-----------+----------------------+
| *Default* | ``-0.5``             |
+-----------+----------------------+
| *Setter*  | set_voice_pan(value) |
+-----------+----------------------+
| *Getter*  | get_voice_pan()      |
+-----------+----------------------+

The voice's pan level.

----

.. _class_AudioEffectChorus_property_voice/1/rate_hz:

- :ref:`float<class_float>` **voice/1/rate_hz**

+-----------+--------------------------+
| *Default* | ``0.8``                  |
+-----------+--------------------------+
| *Setter*  | set_voice_rate_hz(value) |
+-----------+--------------------------+
| *Getter*  | get_voice_rate_hz()      |
+-----------+--------------------------+

The voice's filter rate.

----

.. _class_AudioEffectChorus_property_voice/2/cutoff_hz:

- :ref:`float<class_float>` **voice/2/cutoff_hz**

+-----------+----------------------------+
| *Default* | ``8000.0``                 |
+-----------+----------------------------+
| *Setter*  | set_voice_cutoff_hz(value) |
+-----------+----------------------------+
| *Getter*  | get_voice_cutoff_hz()      |
+-----------+----------------------------+

The voice's cutoff frequency.

----

.. _class_AudioEffectChorus_property_voice/2/delay_ms:

- :ref:`float<class_float>` **voice/2/delay_ms**

+-----------+---------------------------+
| *Default* | ``20.0``                  |
+-----------+---------------------------+
| *Setter*  | set_voice_delay_ms(value) |
+-----------+---------------------------+
| *Getter*  | get_voice_delay_ms()      |
+-----------+---------------------------+

The voice's signal delay.

----

.. _class_AudioEffectChorus_property_voice/2/depth_ms:

- :ref:`float<class_float>` **voice/2/depth_ms**

+-----------+---------------------------+
| *Default* | ``3.0``                   |
+-----------+---------------------------+
| *Setter*  | set_voice_depth_ms(value) |
+-----------+---------------------------+
| *Getter*  | get_voice_depth_ms()      |
+-----------+---------------------------+

The voice filter's depth.

----

.. _class_AudioEffectChorus_property_voice/2/level_db:

- :ref:`float<class_float>` **voice/2/level_db**

+-----------+---------------------------+
| *Default* | ``0.0``                   |
+-----------+---------------------------+
| *Setter*  | set_voice_level_db(value) |
+-----------+---------------------------+
| *Getter*  | get_voice_level_db()      |
+-----------+---------------------------+

The voice's volume.

----

.. _class_AudioEffectChorus_property_voice/2/pan:

- :ref:`float<class_float>` **voice/2/pan**

+-----------+----------------------+
| *Default* | ``0.5``              |
+-----------+----------------------+
| *Setter*  | set_voice_pan(value) |
+-----------+----------------------+
| *Getter*  | get_voice_pan()      |
+-----------+----------------------+

The voice's pan level.

----

.. _class_AudioEffectChorus_property_voice/2/rate_hz:

- :ref:`float<class_float>` **voice/2/rate_hz**

+-----------+--------------------------+
| *Default* | ``1.2``                  |
+-----------+--------------------------+
| *Setter*  | set_voice_rate_hz(value) |
+-----------+--------------------------+
| *Getter*  | get_voice_rate_hz()      |
+-----------+--------------------------+

The voice's filter rate.

----

.. _class_AudioEffectChorus_property_voice/3/cutoff_hz:

- :ref:`float<class_float>` **voice/3/cutoff_hz**

+----------+----------------------------+
| *Setter* | set_voice_cutoff_hz(value) |
+----------+----------------------------+
| *Getter* | get_voice_cutoff_hz()      |
+----------+----------------------------+

The voice's cutoff frequency.

----

.. _class_AudioEffectChorus_property_voice/3/delay_ms:

- :ref:`float<class_float>` **voice/3/delay_ms**

+----------+---------------------------+
| *Setter* | set_voice_delay_ms(value) |
+----------+---------------------------+
| *Getter* | get_voice_delay_ms()      |
+----------+---------------------------+

The voice's signal delay.

----

.. _class_AudioEffectChorus_property_voice/3/depth_ms:

- :ref:`float<class_float>` **voice/3/depth_ms**

+----------+---------------------------+
| *Setter* | set_voice_depth_ms(value) |
+----------+---------------------------+
| *Getter* | get_voice_depth_ms()      |
+----------+---------------------------+

The voice filter's depth.

----

.. _class_AudioEffectChorus_property_voice/3/level_db:

- :ref:`float<class_float>` **voice/3/level_db**

+----------+---------------------------+
| *Setter* | set_voice_level_db(value) |
+----------+---------------------------+
| *Getter* | get_voice_level_db()      |
+----------+---------------------------+

The voice's volume.

----

.. _class_AudioEffectChorus_property_voice/3/pan:

- :ref:`float<class_float>` **voice/3/pan**

+----------+----------------------+
| *Setter* | set_voice_pan(value) |
+----------+----------------------+
| *Getter* | get_voice_pan()      |
+----------+----------------------+

The voice's pan level.

----

.. _class_AudioEffectChorus_property_voice/3/rate_hz:

- :ref:`float<class_float>` **voice/3/rate_hz**

+----------+--------------------------+
| *Setter* | set_voice_rate_hz(value) |
+----------+--------------------------+
| *Getter* | get_voice_rate_hz()      |
+----------+--------------------------+

The voice's filter rate.

----

.. _class_AudioEffectChorus_property_voice/4/cutoff_hz:

- :ref:`float<class_float>` **voice/4/cutoff_hz**

+----------+----------------------------+
| *Setter* | set_voice_cutoff_hz(value) |
+----------+----------------------------+
| *Getter* | get_voice_cutoff_hz()      |
+----------+----------------------------+

The voice's cutoff frequency.

----

.. _class_AudioEffectChorus_property_voice/4/delay_ms:

- :ref:`float<class_float>` **voice/4/delay_ms**

+----------+---------------------------+
| *Setter* | set_voice_delay_ms(value) |
+----------+---------------------------+
| *Getter* | get_voice_delay_ms()      |
+----------+---------------------------+

The voice's signal delay.

----

.. _class_AudioEffectChorus_property_voice/4/depth_ms:

- :ref:`float<class_float>` **voice/4/depth_ms**

+----------+---------------------------+
| *Setter* | set_voice_depth_ms(value) |
+----------+---------------------------+
| *Getter* | get_voice_depth_ms()      |
+----------+---------------------------+

The voice filter's depth.

----

.. _class_AudioEffectChorus_property_voice/4/level_db:

- :ref:`float<class_float>` **voice/4/level_db**

+----------+---------------------------+
| *Setter* | set_voice_level_db(value) |
+----------+---------------------------+
| *Getter* | get_voice_level_db()      |
+----------+---------------------------+

The voice's volume.

----

.. _class_AudioEffectChorus_property_voice/4/pan:

- :ref:`float<class_float>` **voice/4/pan**

+----------+----------------------+
| *Setter* | set_voice_pan(value) |
+----------+----------------------+
| *Getter* | get_voice_pan()      |
+----------+----------------------+

The voice's pan level.

----

.. _class_AudioEffectChorus_property_voice/4/rate_hz:

- :ref:`float<class_float>` **voice/4/rate_hz**

+----------+--------------------------+
| *Setter* | set_voice_rate_hz(value) |
+----------+--------------------------+
| *Getter* | get_voice_rate_hz()      |
+----------+--------------------------+

The voice's filter rate.

----

.. _class_AudioEffectChorus_property_voice_count:

- :ref:`int<class_int>` **voice_count**

+-----------+------------------------+
| *Default* | ``2``                  |
+-----------+------------------------+
| *Setter*  | set_voice_count(value) |
+-----------+------------------------+
| *Getter*  | get_voice_count()      |
+-----------+------------------------+

The amount of voices in the effect.

----

.. _class_AudioEffectChorus_property_wet:

- :ref:`float<class_float>` **wet**

+-----------+----------------+
| *Default* | ``0.5``        |
+-----------+----------------+
| *Setter*  | set_wet(value) |
+-----------+----------------+
| *Getter*  | get_wet()      |
+-----------+----------------+

The effect's processed signal.

Method Descriptions
-------------------

.. _class_AudioEffectChorus_method_get_voice_cutoff_hz:

- :ref:`float<class_float>` **get_voice_cutoff_hz** **(** :ref:`int<class_int>` voice_idx **)** |const|

----

.. _class_AudioEffectChorus_method_get_voice_delay_ms:

- :ref:`float<class_float>` **get_voice_delay_ms** **(** :ref:`int<class_int>` voice_idx **)** |const|

----

.. _class_AudioEffectChorus_method_get_voice_depth_ms:

- :ref:`float<class_float>` **get_voice_depth_ms** **(** :ref:`int<class_int>` voice_idx **)** |const|

----

.. _class_AudioEffectChorus_method_get_voice_level_db:

- :ref:`float<class_float>` **get_voice_level_db** **(** :ref:`int<class_int>` voice_idx **)** |const|

----

.. _class_AudioEffectChorus_method_get_voice_pan:

- :ref:`float<class_float>` **get_voice_pan** **(** :ref:`int<class_int>` voice_idx **)** |const|

----

.. _class_AudioEffectChorus_method_get_voice_rate_hz:

- :ref:`float<class_float>` **get_voice_rate_hz** **(** :ref:`int<class_int>` voice_idx **)** |const|

----

.. _class_AudioEffectChorus_method_set_voice_cutoff_hz:

- void **set_voice_cutoff_hz** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` cutoff_hz **)**

----

.. _class_AudioEffectChorus_method_set_voice_delay_ms:

- void **set_voice_delay_ms** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` delay_ms **)**

----

.. _class_AudioEffectChorus_method_set_voice_depth_ms:

- void **set_voice_depth_ms** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` depth_ms **)**

----

.. _class_AudioEffectChorus_method_set_voice_level_db:

- void **set_voice_level_db** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` level_db **)**

----

.. _class_AudioEffectChorus_method_set_voice_pan:

- void **set_voice_pan** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` pan **)**

----

.. _class_AudioEffectChorus_method_set_voice_rate_hz:

- void **set_voice_rate_hz** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` rate_hz **)**

.. |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.)`