763 lines
30 KiB
Text
763 lines
30 KiB
Text
|
:github_url: hide
|
||
|
|
||
|
.. DO NOT EDIT THIS FILE!!!
|
||
|
.. Generated automatically from Godot engine sources.
|
||
|
.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py.
|
||
|
.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/AudioEffectChorus.xml.
|
||
|
|
||
|
.. _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.
|
||
|
|
||
|
.. rst-class:: classref-introduction-group
|
||
|
|
||
|
Description
|
||
|
-----------
|
||
|
|
||
|
Adds a chorus audio effect. The effect applies a filter with voices to duplicate the audio source and manipulate it through the filter.
|
||
|
|
||
|
.. rst-class:: classref-reftable-group
|
||
|
|
||
|
Properties
|
||
|
----------
|
||
|
|
||
|
.. table::
|
||
|
:widths: auto
|
||
|
|
||
|
+---------------------------+------------------------------------------------------------------------------+------------+
|
||
|
| :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`` |
|
||
|
+---------------------------+------------------------------------------------------------------------------+------------+
|
||
|
|
||
|
.. rst-class:: classref-reftable-group
|
||
|
|
||
|
Methods
|
||
|
-------
|
||
|
|
||
|
.. table::
|
||
|
:widths: auto
|
||
|
|
||
|
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
|
| :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 **)** |
|
||
|
+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
|
|
||
|
.. rst-class:: classref-section-separator
|
||
|
|
||
|
----
|
||
|
|
||
|
.. rst-class:: classref-descriptions-group
|
||
|
|
||
|
Property Descriptions
|
||
|
---------------------
|
||
|
|
||
|
.. _class_AudioEffectChorus_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** **(** **)**
|
||
|
|
||
|
The effect's raw signal.
|
||
|
|
||
|
.. rst-class:: classref-item-separator
|
||
|
|
||
|
----
|
||
|
|
||
|
.. _class_AudioEffectChorus_property_voice/1/cutoff_hz:
|
||
|
|
||
|
.. rst-class:: classref-property
|
||
|
|
||
|
:ref:`float<class_float>` **voice/1/cutoff_hz** = ``8000.0``
|
||
|
|
||
|
.. rst-class:: classref-property-setget
|
||
|
|
||
|
- void **set_voice_cutoff_hz** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` cutoff_hz **)**
|
||
|
- :ref:`float<class_float>` **get_voice_cutoff_hz** **(** :ref:`int<class_int>` voice_idx **)** |const|
|
||
|
|
||
|
The voice's cutoff frequency.
|
||
|
|
||
|
.. rst-class:: classref-item-separator
|
||
|
|
||
|
----
|
||
|
|
||
|
.. _class_AudioEffectChorus_property_voice/1/delay_ms:
|
||
|
|
||
|
.. rst-class:: classref-property
|
||
|
|
||
|
:ref:`float<class_float>` **voice/1/delay_ms** = ``15.0``
|
||
|
|
||
|
.. rst-class:: classref-property-setget
|
||
|
|
||
|
- void **set_voice_delay_ms** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` delay_ms **)**
|
||
|
- :ref:`float<class_float>` **get_voice_delay_ms** **(** :ref:`int<class_int>` voice_idx **)** |const|
|
||
|
|
||
|
The voice's signal delay.
|
||
|
|
||
|
.. rst-class:: classref-item-separator
|
||
|
|
||
|
----
|
||
|
|
||
|
.. _class_AudioEffectChorus_property_voice/1/depth_ms:
|
||
|
|
||
|
.. rst-class:: classref-property
|
||
|
|
||
|
:ref:`float<class_float>` **voice/1/depth_ms** = ``2.0``
|
||
|
|
||
|
.. rst-class:: classref-property-setget
|
||
|
|
||
|
- void **set_voice_depth_ms** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` depth_ms **)**
|
||
|
- :ref:`float<class_float>` **get_voice_depth_ms** **(** :ref:`int<class_int>` voice_idx **)** |const|
|
||
|
|
||
|
The voice filter's depth.
|
||
|
|
||
|
.. rst-class:: classref-item-separator
|
||
|
|
||
|
----
|
||
|
|
||
|
.. _class_AudioEffectChorus_property_voice/1/level_db:
|
||
|
|
||
|
.. rst-class:: classref-property
|
||
|
|
||
|
:ref:`float<class_float>` **voice/1/level_db** = ``0.0``
|
||
|
|
||
|
.. rst-class:: classref-property-setget
|
||
|
|
||
|
- void **set_voice_level_db** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` level_db **)**
|
||
|
- :ref:`float<class_float>` **get_voice_level_db** **(** :ref:`int<class_int>` voice_idx **)** |const|
|
||
|
|
||
|
The voice's volume.
|
||
|
|
||
|
.. rst-class:: classref-item-separator
|
||
|
|
||
|
----
|
||
|
|
||
|
.. _class_AudioEffectChorus_property_voice/1/pan:
|
||
|
|
||
|
.. rst-class:: classref-property
|
||
|
|
||
|
:ref:`float<class_float>` **voice/1/pan** = ``-0.5``
|
||
|
|
||
|
.. rst-class:: classref-property-setget
|
||
|
|
||
|
- void **set_voice_pan** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` pan **)**
|
||
|
- :ref:`float<class_float>` **get_voice_pan** **(** :ref:`int<class_int>` voice_idx **)** |const|
|
||
|
|
||
|
The voice's pan level.
|
||
|
|
||
|
.. rst-class:: classref-item-separator
|
||
|
|
||
|
----
|
||
|
|
||
|
.. _class_AudioEffectChorus_property_voice/1/rate_hz:
|
||
|
|
||
|
.. rst-class:: classref-property
|
||
|
|
||
|
:ref:`float<class_float>` **voice/1/rate_hz** = ``0.8``
|
||
|
|
||
|
.. rst-class:: classref-property-setget
|
||
|
|
||
|
- void **set_voice_rate_hz** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` rate_hz **)**
|
||
|
- :ref:`float<class_float>` **get_voice_rate_hz** **(** :ref:`int<class_int>` voice_idx **)** |const|
|
||
|
|
||
|
The voice's filter rate.
|
||
|
|
||
|
.. rst-class:: classref-item-separator
|
||
|
|
||
|
----
|
||
|
|
||
|
.. _class_AudioEffectChorus_property_voice/2/cutoff_hz:
|
||
|
|
||
|
.. rst-class:: classref-property
|
||
|
|
||
|
:ref:`float<class_float>` **voice/2/cutoff_hz** = ``8000.0``
|
||
|
|
||
|
.. rst-class:: classref-property-setget
|
||
|
|
||
|
- void **set_voice_cutoff_hz** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` cutoff_hz **)**
|
||
|
- :ref:`float<class_float>` **get_voice_cutoff_hz** **(** :ref:`int<class_int>` voice_idx **)** |const|
|
||
|
|
||
|
The voice's cutoff frequency.
|
||
|
|
||
|
.. rst-class:: classref-item-separator
|
||
|
|
||
|
----
|
||
|
|
||
|
.. _class_AudioEffectChorus_property_voice/2/delay_ms:
|
||
|
|
||
|
.. rst-class:: classref-property
|
||
|
|
||
|
:ref:`float<class_float>` **voice/2/delay_ms** = ``20.0``
|
||
|
|
||
|
.. rst-class:: classref-property-setget
|
||
|
|
||
|
- void **set_voice_delay_ms** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` delay_ms **)**
|
||
|
- :ref:`float<class_float>` **get_voice_delay_ms** **(** :ref:`int<class_int>` voice_idx **)** |const|
|
||
|
|
||
|
The voice's signal delay.
|
||
|
|
||
|
.. rst-class:: classref-item-separator
|
||
|
|
||
|
----
|
||
|
|
||
|
.. _class_AudioEffectChorus_property_voice/2/depth_ms:
|
||
|
|
||
|
.. rst-class:: classref-property
|
||
|
|
||
|
:ref:`float<class_float>` **voice/2/depth_ms** = ``3.0``
|
||
|
|
||
|
.. rst-class:: classref-property-setget
|
||
|
|
||
|
- void **set_voice_depth_ms** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` depth_ms **)**
|
||
|
- :ref:`float<class_float>` **get_voice_depth_ms** **(** :ref:`int<class_int>` voice_idx **)** |const|
|
||
|
|
||
|
The voice filter's depth.
|
||
|
|
||
|
.. rst-class:: classref-item-separator
|
||
|
|
||
|
----
|
||
|
|
||
|
.. _class_AudioEffectChorus_property_voice/2/level_db:
|
||
|
|
||
|
.. rst-class:: classref-property
|
||
|
|
||
|
:ref:`float<class_float>` **voice/2/level_db** = ``0.0``
|
||
|
|
||
|
.. rst-class:: classref-property-setget
|
||
|
|
||
|
- void **set_voice_level_db** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` level_db **)**
|
||
|
- :ref:`float<class_float>` **get_voice_level_db** **(** :ref:`int<class_int>` voice_idx **)** |const|
|
||
|
|
||
|
The voice's volume.
|
||
|
|
||
|
.. rst-class:: classref-item-separator
|
||
|
|
||
|
----
|
||
|
|
||
|
.. _class_AudioEffectChorus_property_voice/2/pan:
|
||
|
|
||
|
.. rst-class:: classref-property
|
||
|
|
||
|
:ref:`float<class_float>` **voice/2/pan** = ``0.5``
|
||
|
|
||
|
.. rst-class:: classref-property-setget
|
||
|
|
||
|
- void **set_voice_pan** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` pan **)**
|
||
|
- :ref:`float<class_float>` **get_voice_pan** **(** :ref:`int<class_int>` voice_idx **)** |const|
|
||
|
|
||
|
The voice's pan level.
|
||
|
|
||
|
.. rst-class:: classref-item-separator
|
||
|
|
||
|
----
|
||
|
|
||
|
.. _class_AudioEffectChorus_property_voice/2/rate_hz:
|
||
|
|
||
|
.. rst-class:: classref-property
|
||
|
|
||
|
:ref:`float<class_float>` **voice/2/rate_hz** = ``1.2``
|
||
|
|
||
|
.. rst-class:: classref-property-setget
|
||
|
|
||
|
- void **set_voice_rate_hz** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` rate_hz **)**
|
||
|
- :ref:`float<class_float>` **get_voice_rate_hz** **(** :ref:`int<class_int>` voice_idx **)** |const|
|
||
|
|
||
|
The voice's filter rate.
|
||
|
|
||
|
.. rst-class:: classref-item-separator
|
||
|
|
||
|
----
|
||
|
|
||
|
.. _class_AudioEffectChorus_property_voice/3/cutoff_hz:
|
||
|
|
||
|
.. rst-class:: classref-property
|
||
|
|
||
|
:ref:`float<class_float>` **voice/3/cutoff_hz**
|
||
|
|
||
|
.. rst-class:: classref-property-setget
|
||
|
|
||
|
- void **set_voice_cutoff_hz** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` cutoff_hz **)**
|
||
|
- :ref:`float<class_float>` **get_voice_cutoff_hz** **(** :ref:`int<class_int>` voice_idx **)** |const|
|
||
|
|
||
|
The voice's cutoff frequency.
|
||
|
|
||
|
.. rst-class:: classref-item-separator
|
||
|
|
||
|
----
|
||
|
|
||
|
.. _class_AudioEffectChorus_property_voice/3/delay_ms:
|
||
|
|
||
|
.. rst-class:: classref-property
|
||
|
|
||
|
:ref:`float<class_float>` **voice/3/delay_ms**
|
||
|
|
||
|
.. rst-class:: classref-property-setget
|
||
|
|
||
|
- void **set_voice_delay_ms** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` delay_ms **)**
|
||
|
- :ref:`float<class_float>` **get_voice_delay_ms** **(** :ref:`int<class_int>` voice_idx **)** |const|
|
||
|
|
||
|
The voice's signal delay.
|
||
|
|
||
|
.. rst-class:: classref-item-separator
|
||
|
|
||
|
----
|
||
|
|
||
|
.. _class_AudioEffectChorus_property_voice/3/depth_ms:
|
||
|
|
||
|
.. rst-class:: classref-property
|
||
|
|
||
|
:ref:`float<class_float>` **voice/3/depth_ms**
|
||
|
|
||
|
.. rst-class:: classref-property-setget
|
||
|
|
||
|
- void **set_voice_depth_ms** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` depth_ms **)**
|
||
|
- :ref:`float<class_float>` **get_voice_depth_ms** **(** :ref:`int<class_int>` voice_idx **)** |const|
|
||
|
|
||
|
The voice filter's depth.
|
||
|
|
||
|
.. rst-class:: classref-item-separator
|
||
|
|
||
|
----
|
||
|
|
||
|
.. _class_AudioEffectChorus_property_voice/3/level_db:
|
||
|
|
||
|
.. rst-class:: classref-property
|
||
|
|
||
|
:ref:`float<class_float>` **voice/3/level_db**
|
||
|
|
||
|
.. rst-class:: classref-property-setget
|
||
|
|
||
|
- void **set_voice_level_db** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` level_db **)**
|
||
|
- :ref:`float<class_float>` **get_voice_level_db** **(** :ref:`int<class_int>` voice_idx **)** |const|
|
||
|
|
||
|
The voice's volume.
|
||
|
|
||
|
.. rst-class:: classref-item-separator
|
||
|
|
||
|
----
|
||
|
|
||
|
.. _class_AudioEffectChorus_property_voice/3/pan:
|
||
|
|
||
|
.. rst-class:: classref-property
|
||
|
|
||
|
:ref:`float<class_float>` **voice/3/pan**
|
||
|
|
||
|
.. rst-class:: classref-property-setget
|
||
|
|
||
|
- void **set_voice_pan** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` pan **)**
|
||
|
- :ref:`float<class_float>` **get_voice_pan** **(** :ref:`int<class_int>` voice_idx **)** |const|
|
||
|
|
||
|
The voice's pan level.
|
||
|
|
||
|
.. rst-class:: classref-item-separator
|
||
|
|
||
|
----
|
||
|
|
||
|
.. _class_AudioEffectChorus_property_voice/3/rate_hz:
|
||
|
|
||
|
.. rst-class:: classref-property
|
||
|
|
||
|
:ref:`float<class_float>` **voice/3/rate_hz**
|
||
|
|
||
|
.. rst-class:: classref-property-setget
|
||
|
|
||
|
- void **set_voice_rate_hz** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` rate_hz **)**
|
||
|
- :ref:`float<class_float>` **get_voice_rate_hz** **(** :ref:`int<class_int>` voice_idx **)** |const|
|
||
|
|
||
|
The voice's filter rate.
|
||
|
|
||
|
.. rst-class:: classref-item-separator
|
||
|
|
||
|
----
|
||
|
|
||
|
.. _class_AudioEffectChorus_property_voice/4/cutoff_hz:
|
||
|
|
||
|
.. rst-class:: classref-property
|
||
|
|
||
|
:ref:`float<class_float>` **voice/4/cutoff_hz**
|
||
|
|
||
|
.. rst-class:: classref-property-setget
|
||
|
|
||
|
- void **set_voice_cutoff_hz** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` cutoff_hz **)**
|
||
|
- :ref:`float<class_float>` **get_voice_cutoff_hz** **(** :ref:`int<class_int>` voice_idx **)** |const|
|
||
|
|
||
|
The voice's cutoff frequency.
|
||
|
|
||
|
.. rst-class:: classref-item-separator
|
||
|
|
||
|
----
|
||
|
|
||
|
.. _class_AudioEffectChorus_property_voice/4/delay_ms:
|
||
|
|
||
|
.. rst-class:: classref-property
|
||
|
|
||
|
:ref:`float<class_float>` **voice/4/delay_ms**
|
||
|
|
||
|
.. rst-class:: classref-property-setget
|
||
|
|
||
|
- void **set_voice_delay_ms** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` delay_ms **)**
|
||
|
- :ref:`float<class_float>` **get_voice_delay_ms** **(** :ref:`int<class_int>` voice_idx **)** |const|
|
||
|
|
||
|
The voice's signal delay.
|
||
|
|
||
|
.. rst-class:: classref-item-separator
|
||
|
|
||
|
----
|
||
|
|
||
|
.. _class_AudioEffectChorus_property_voice/4/depth_ms:
|
||
|
|
||
|
.. rst-class:: classref-property
|
||
|
|
||
|
:ref:`float<class_float>` **voice/4/depth_ms**
|
||
|
|
||
|
.. rst-class:: classref-property-setget
|
||
|
|
||
|
- void **set_voice_depth_ms** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` depth_ms **)**
|
||
|
- :ref:`float<class_float>` **get_voice_depth_ms** **(** :ref:`int<class_int>` voice_idx **)** |const|
|
||
|
|
||
|
The voice filter's depth.
|
||
|
|
||
|
.. rst-class:: classref-item-separator
|
||
|
|
||
|
----
|
||
|
|
||
|
.. _class_AudioEffectChorus_property_voice/4/level_db:
|
||
|
|
||
|
.. rst-class:: classref-property
|
||
|
|
||
|
:ref:`float<class_float>` **voice/4/level_db**
|
||
|
|
||
|
.. rst-class:: classref-property-setget
|
||
|
|
||
|
- void **set_voice_level_db** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` level_db **)**
|
||
|
- :ref:`float<class_float>` **get_voice_level_db** **(** :ref:`int<class_int>` voice_idx **)** |const|
|
||
|
|
||
|
The voice's volume.
|
||
|
|
||
|
.. rst-class:: classref-item-separator
|
||
|
|
||
|
----
|
||
|
|
||
|
.. _class_AudioEffectChorus_property_voice/4/pan:
|
||
|
|
||
|
.. rst-class:: classref-property
|
||
|
|
||
|
:ref:`float<class_float>` **voice/4/pan**
|
||
|
|
||
|
.. rst-class:: classref-property-setget
|
||
|
|
||
|
- void **set_voice_pan** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` pan **)**
|
||
|
- :ref:`float<class_float>` **get_voice_pan** **(** :ref:`int<class_int>` voice_idx **)** |const|
|
||
|
|
||
|
The voice's pan level.
|
||
|
|
||
|
.. rst-class:: classref-item-separator
|
||
|
|
||
|
----
|
||
|
|
||
|
.. _class_AudioEffectChorus_property_voice/4/rate_hz:
|
||
|
|
||
|
.. rst-class:: classref-property
|
||
|
|
||
|
:ref:`float<class_float>` **voice/4/rate_hz**
|
||
|
|
||
|
.. rst-class:: classref-property-setget
|
||
|
|
||
|
- void **set_voice_rate_hz** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` rate_hz **)**
|
||
|
- :ref:`float<class_float>` **get_voice_rate_hz** **(** :ref:`int<class_int>` voice_idx **)** |const|
|
||
|
|
||
|
The voice's filter rate.
|
||
|
|
||
|
.. rst-class:: classref-item-separator
|
||
|
|
||
|
----
|
||
|
|
||
|
.. _class_AudioEffectChorus_property_voice_count:
|
||
|
|
||
|
.. rst-class:: classref-property
|
||
|
|
||
|
:ref:`int<class_int>` **voice_count** = ``2``
|
||
|
|
||
|
.. rst-class:: classref-property-setget
|
||
|
|
||
|
- void **set_voice_count** **(** :ref:`int<class_int>` value **)**
|
||
|
- :ref:`int<class_int>` **get_voice_count** **(** **)**
|
||
|
|
||
|
The amount of voices in the effect.
|
||
|
|
||
|
.. rst-class:: classref-item-separator
|
||
|
|
||
|
----
|
||
|
|
||
|
.. _class_AudioEffectChorus_property_wet:
|
||
|
|
||
|
.. rst-class:: classref-property
|
||
|
|
||
|
:ref:`float<class_float>` **wet** = ``0.5``
|
||
|
|
||
|
.. rst-class:: classref-property-setget
|
||
|
|
||
|
- void **set_wet** **(** :ref:`float<class_float>` value **)**
|
||
|
- :ref:`float<class_float>` **get_wet** **(** **)**
|
||
|
|
||
|
The effect's processed signal.
|
||
|
|
||
|
.. rst-class:: classref-section-separator
|
||
|
|
||
|
----
|
||
|
|
||
|
.. rst-class:: classref-descriptions-group
|
||
|
|
||
|
Method Descriptions
|
||
|
-------------------
|
||
|
|
||
|
.. _class_AudioEffectChorus_method_get_voice_cutoff_hz:
|
||
|
|
||
|
.. rst-class:: classref-method
|
||
|
|
||
|
:ref:`float<class_float>` **get_voice_cutoff_hz** **(** :ref:`int<class_int>` voice_idx **)** |const|
|
||
|
|
||
|
.. container:: contribute
|
||
|
|
||
|
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
|
||
|
|
||
|
.. rst-class:: classref-item-separator
|
||
|
|
||
|
----
|
||
|
|
||
|
.. _class_AudioEffectChorus_method_get_voice_delay_ms:
|
||
|
|
||
|
.. rst-class:: classref-method
|
||
|
|
||
|
:ref:`float<class_float>` **get_voice_delay_ms** **(** :ref:`int<class_int>` voice_idx **)** |const|
|
||
|
|
||
|
.. container:: contribute
|
||
|
|
||
|
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
|
||
|
|
||
|
.. rst-class:: classref-item-separator
|
||
|
|
||
|
----
|
||
|
|
||
|
.. _class_AudioEffectChorus_method_get_voice_depth_ms:
|
||
|
|
||
|
.. rst-class:: classref-method
|
||
|
|
||
|
:ref:`float<class_float>` **get_voice_depth_ms** **(** :ref:`int<class_int>` voice_idx **)** |const|
|
||
|
|
||
|
.. container:: contribute
|
||
|
|
||
|
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
|
||
|
|
||
|
.. rst-class:: classref-item-separator
|
||
|
|
||
|
----
|
||
|
|
||
|
.. _class_AudioEffectChorus_method_get_voice_level_db:
|
||
|
|
||
|
.. rst-class:: classref-method
|
||
|
|
||
|
:ref:`float<class_float>` **get_voice_level_db** **(** :ref:`int<class_int>` voice_idx **)** |const|
|
||
|
|
||
|
.. container:: contribute
|
||
|
|
||
|
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
|
||
|
|
||
|
.. rst-class:: classref-item-separator
|
||
|
|
||
|
----
|
||
|
|
||
|
.. _class_AudioEffectChorus_method_get_voice_pan:
|
||
|
|
||
|
.. rst-class:: classref-method
|
||
|
|
||
|
:ref:`float<class_float>` **get_voice_pan** **(** :ref:`int<class_int>` voice_idx **)** |const|
|
||
|
|
||
|
.. container:: contribute
|
||
|
|
||
|
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
|
||
|
|
||
|
.. rst-class:: classref-item-separator
|
||
|
|
||
|
----
|
||
|
|
||
|
.. _class_AudioEffectChorus_method_get_voice_rate_hz:
|
||
|
|
||
|
.. rst-class:: classref-method
|
||
|
|
||
|
:ref:`float<class_float>` **get_voice_rate_hz** **(** :ref:`int<class_int>` voice_idx **)** |const|
|
||
|
|
||
|
.. container:: contribute
|
||
|
|
||
|
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
|
||
|
|
||
|
.. rst-class:: classref-item-separator
|
||
|
|
||
|
----
|
||
|
|
||
|
.. _class_AudioEffectChorus_method_set_voice_cutoff_hz:
|
||
|
|
||
|
.. rst-class:: classref-method
|
||
|
|
||
|
void **set_voice_cutoff_hz** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` cutoff_hz **)**
|
||
|
|
||
|
.. container:: contribute
|
||
|
|
||
|
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
|
||
|
|
||
|
.. rst-class:: classref-item-separator
|
||
|
|
||
|
----
|
||
|
|
||
|
.. _class_AudioEffectChorus_method_set_voice_delay_ms:
|
||
|
|
||
|
.. rst-class:: classref-method
|
||
|
|
||
|
void **set_voice_delay_ms** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` delay_ms **)**
|
||
|
|
||
|
.. container:: contribute
|
||
|
|
||
|
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
|
||
|
|
||
|
.. rst-class:: classref-item-separator
|
||
|
|
||
|
----
|
||
|
|
||
|
.. _class_AudioEffectChorus_method_set_voice_depth_ms:
|
||
|
|
||
|
.. rst-class:: classref-method
|
||
|
|
||
|
void **set_voice_depth_ms** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` depth_ms **)**
|
||
|
|
||
|
.. container:: contribute
|
||
|
|
||
|
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
|
||
|
|
||
|
.. rst-class:: classref-item-separator
|
||
|
|
||
|
----
|
||
|
|
||
|
.. _class_AudioEffectChorus_method_set_voice_level_db:
|
||
|
|
||
|
.. rst-class:: classref-method
|
||
|
|
||
|
void **set_voice_level_db** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` level_db **)**
|
||
|
|
||
|
.. container:: contribute
|
||
|
|
||
|
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
|
||
|
|
||
|
.. rst-class:: classref-item-separator
|
||
|
|
||
|
----
|
||
|
|
||
|
.. _class_AudioEffectChorus_method_set_voice_pan:
|
||
|
|
||
|
.. rst-class:: classref-method
|
||
|
|
||
|
void **set_voice_pan** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` pan **)**
|
||
|
|
||
|
.. container:: contribute
|
||
|
|
||
|
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
|
||
|
|
||
|
.. rst-class:: classref-item-separator
|
||
|
|
||
|
----
|
||
|
|
||
|
.. _class_AudioEffectChorus_method_set_voice_rate_hz:
|
||
|
|
||
|
.. rst-class:: classref-method
|
||
|
|
||
|
void **set_voice_rate_hz** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` rate_hz **)**
|
||
|
|
||
|
.. container:: contribute
|
||
|
|
||
|
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
|
||
|
|
||
|
.. |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.)`
|
||
|
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
|