classref: Sync with current master branch (f87858a8f)

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

View File

@@ -16,109 +16,127 @@ Adds a phaser audio effect to an audio bus.
Combines the original signal with a copy that is slightly out of phase with the original.
.. rst-class:: classref-introduction-group
Description
-----------
Combines phase-shifted signals with the original signal. The movement of the phase-shifted signals is controlled using a low-frequency oscillator.
.. rst-class:: classref-introduction-group
Tutorials
---------
- :doc:`Audio buses <../tutorials/audio/audio_buses>`
.. rst-class:: classref-reftable-group
Properties
----------
+---------------------------+--------------------------------------------------------------------+------------+
| :ref:`float<class_float>` | :ref:`depth<class_AudioEffectPhaser_property_depth>` | ``1.0`` |
+---------------------------+--------------------------------------------------------------------+------------+
| :ref:`float<class_float>` | :ref:`feedback<class_AudioEffectPhaser_property_feedback>` | ``0.7`` |
+---------------------------+--------------------------------------------------------------------+------------+
| :ref:`float<class_float>` | :ref:`range_max_hz<class_AudioEffectPhaser_property_range_max_hz>` | ``1600.0`` |
+---------------------------+--------------------------------------------------------------------+------------+
| :ref:`float<class_float>` | :ref:`range_min_hz<class_AudioEffectPhaser_property_range_min_hz>` | ``440.0`` |
+---------------------------+--------------------------------------------------------------------+------------+
| :ref:`float<class_float>` | :ref:`rate_hz<class_AudioEffectPhaser_property_rate_hz>` | ``0.5`` |
+---------------------------+--------------------------------------------------------------------+------------+
.. table::
:widths: auto
+---------------------------+--------------------------------------------------------------------+------------+
| :ref:`float<class_float>` | :ref:`depth<class_AudioEffectPhaser_property_depth>` | ``1.0`` |
+---------------------------+--------------------------------------------------------------------+------------+
| :ref:`float<class_float>` | :ref:`feedback<class_AudioEffectPhaser_property_feedback>` | ``0.7`` |
+---------------------------+--------------------------------------------------------------------+------------+
| :ref:`float<class_float>` | :ref:`range_max_hz<class_AudioEffectPhaser_property_range_max_hz>` | ``1600.0`` |
+---------------------------+--------------------------------------------------------------------+------------+
| :ref:`float<class_float>` | :ref:`range_min_hz<class_AudioEffectPhaser_property_range_min_hz>` | ``440.0`` |
+---------------------------+--------------------------------------------------------------------+------------+
| :ref:`float<class_float>` | :ref:`rate_hz<class_AudioEffectPhaser_property_rate_hz>` | ``0.5`` |
+---------------------------+--------------------------------------------------------------------+------------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Property Descriptions
---------------------
.. _class_AudioEffectPhaser_property_depth:
- :ref:`float<class_float>` **depth**
.. rst-class:: classref-property
+-----------+------------------+
| *Default* | ``1.0`` |
+-----------+------------------+
| *Setter* | set_depth(value) |
+-----------+------------------+
| *Getter* | get_depth() |
+-----------+------------------+
:ref:`float<class_float>` **depth** = ``1.0``
.. rst-class:: classref-property-setget
- void **set_depth** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_depth** **(** **)**
Governs how high the filter frequencies sweep. Low value will primarily affect bass frequencies. High value can sweep high into the treble. Value can range from 0.1 to 4.
.. rst-class:: classref-item-separator
----
.. _class_AudioEffectPhaser_property_feedback:
- :ref:`float<class_float>` **feedback**
.. rst-class:: classref-property
+-----------+---------------------+
| *Default* | ``0.7`` |
+-----------+---------------------+
| *Setter* | set_feedback(value) |
+-----------+---------------------+
| *Getter* | get_feedback() |
+-----------+---------------------+
:ref:`float<class_float>` **feedback** = ``0.7``
.. rst-class:: classref-property-setget
- void **set_feedback** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_feedback** **(** **)**
Output percent of modified sound. Value can range from 0.1 to 0.9.
.. rst-class:: classref-item-separator
----
.. _class_AudioEffectPhaser_property_range_max_hz:
- :ref:`float<class_float>` **range_max_hz**
.. rst-class:: classref-property
+-----------+-------------------------+
| *Default* | ``1600.0`` |
+-----------+-------------------------+
| *Setter* | set_range_max_hz(value) |
+-----------+-------------------------+
| *Getter* | get_range_max_hz() |
+-----------+-------------------------+
:ref:`float<class_float>` **range_max_hz** = ``1600.0``
.. rst-class:: classref-property-setget
- void **set_range_max_hz** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_range_max_hz** **(** **)**
Determines the maximum frequency affected by the LFO modulations, in Hz. Value can range from 10 to 10000.
.. rst-class:: classref-item-separator
----
.. _class_AudioEffectPhaser_property_range_min_hz:
- :ref:`float<class_float>` **range_min_hz**
.. rst-class:: classref-property
+-----------+-------------------------+
| *Default* | ``440.0`` |
+-----------+-------------------------+
| *Setter* | set_range_min_hz(value) |
+-----------+-------------------------+
| *Getter* | get_range_min_hz() |
+-----------+-------------------------+
:ref:`float<class_float>` **range_min_hz** = ``440.0``
.. rst-class:: classref-property-setget
- void **set_range_min_hz** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_range_min_hz** **(** **)**
Determines the minimum frequency affected by the LFO modulations, in Hz. Value can range from 10 to 10000.
.. rst-class:: classref-item-separator
----
.. _class_AudioEffectPhaser_property_rate_hz:
- :ref:`float<class_float>` **rate_hz**
.. rst-class:: classref-property
+-----------+--------------------+
| *Default* | ``0.5`` |
+-----------+--------------------+
| *Setter* | set_rate_hz(value) |
+-----------+--------------------+
| *Getter* | get_rate_hz() |
+-----------+--------------------+
:ref:`float<class_float>` **rate_hz** = ``0.5``
.. rst-class:: classref-property-setget
- void **set_rate_hz** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_rate_hz** **(** **)**
Adjusts the rate in Hz at which the effect sweeps up and down across the frequency range.