godot-docs/classes/class_audioeffectchorus.rst

.. Generated automatically by doc/tools/makerst.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>`

**Category:** Core

Brief Description
-----------------

Adds a chorus audio effect.

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

  .. _class_AudioEffectChorus_dry:

- :ref:`float<class_float>` **dry** - The effect's raw signal.

  .. _class_AudioEffectChorus_voice/1/cutoff_hz:

- :ref:`float<class_float>` **voice/1/cutoff_hz** - The voice's cutoff frequency.

  .. _class_AudioEffectChorus_voice/1/delay_ms:

- :ref:`float<class_float>` **voice/1/delay_ms** - The voice's signal delay.

  .. _class_AudioEffectChorus_voice/1/depth_ms:

- :ref:`float<class_float>` **voice/1/depth_ms** - The voice filter's depth.

  .. _class_AudioEffectChorus_voice/1/level_db:

- :ref:`float<class_float>` **voice/1/level_db** - The voice's volume.

  .. _class_AudioEffectChorus_voice/1/pan:

- :ref:`float<class_float>` **voice/1/pan** - The voice's pan level.

  .. _class_AudioEffectChorus_voice/1/rate_hz:

- :ref:`float<class_float>` **voice/1/rate_hz** - The voice's filter rate.

  .. _class_AudioEffectChorus_voice/2/cutoff_hz:

- :ref:`float<class_float>` **voice/2/cutoff_hz** - The voice's cutoff frequency.

  .. _class_AudioEffectChorus_voice/2/delay_ms:

- :ref:`float<class_float>` **voice/2/delay_ms** - The voice's signal delay.

  .. _class_AudioEffectChorus_voice/2/depth_ms:

- :ref:`float<class_float>` **voice/2/depth_ms** - The voice filter's depth.

  .. _class_AudioEffectChorus_voice/2/level_db:

- :ref:`float<class_float>` **voice/2/level_db** - The voice's volume.

  .. _class_AudioEffectChorus_voice/2/pan:

- :ref:`float<class_float>` **voice/2/pan** - The voice's pan level.

  .. _class_AudioEffectChorus_voice/2/rate_hz:

- :ref:`float<class_float>` **voice/2/rate_hz** - The voice's filter rate.

  .. _class_AudioEffectChorus_voice/3/cutoff_hz:

- :ref:`float<class_float>` **voice/3/cutoff_hz** - The voice's cutoff frequency.

  .. _class_AudioEffectChorus_voice/3/delay_ms:

- :ref:`float<class_float>` **voice/3/delay_ms** - The voice's signal delay.

  .. _class_AudioEffectChorus_voice/3/depth_ms:

- :ref:`float<class_float>` **voice/3/depth_ms** - The voice filter's depth.

  .. _class_AudioEffectChorus_voice/3/level_db:

- :ref:`float<class_float>` **voice/3/level_db** - The voice's volume.

  .. _class_AudioEffectChorus_voice/3/pan:

- :ref:`float<class_float>` **voice/3/pan** - The voice's pan level.

  .. _class_AudioEffectChorus_voice/3/rate_hz:

- :ref:`float<class_float>` **voice/3/rate_hz** - The voice's filter rate.

  .. _class_AudioEffectChorus_voice/4/cutoff_hz:

- :ref:`float<class_float>` **voice/4/cutoff_hz** - The voice's cutoff frequency.

  .. _class_AudioEffectChorus_voice/4/delay_ms:

- :ref:`float<class_float>` **voice/4/delay_ms** - The voice's signal delay.

  .. _class_AudioEffectChorus_voice/4/depth_ms:

- :ref:`float<class_float>` **voice/4/depth_ms** - The voice filter's depth.

  .. _class_AudioEffectChorus_voice/4/level_db:

- :ref:`float<class_float>` **voice/4/level_db** - The voice's volume.

  .. _class_AudioEffectChorus_voice/4/pan:

- :ref:`float<class_float>` **voice/4/pan** - The voice's pan level.

  .. _class_AudioEffectChorus_voice/4/rate_hz:

- :ref:`float<class_float>` **voice/4/rate_hz** - The voice's filter rate.

  .. _class_AudioEffectChorus_voice_count:

- :ref:`int<class_int>` **voice_count** - The amount of voices in the effect.

  .. _class_AudioEffectChorus_wet:

- :ref:`float<class_float>` **wet** - The effect's processed signal.


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

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