classref: Sync with current upstream master branch

This commit is contained in:
Rémi Verschelde
2017-10-11 23:56:28 +02:00
parent 1d617789a4
commit ace47f729c
123 changed files with 2676 additions and 1229 deletions
+15 -8
View File
@@ -14,7 +14,9 @@ AudioEffectReverb
Brief Description
-----------------
Adds a Reverb audio effect to an Audio bus.
Simulates the sound of acoustic environments such as rooms, concert halls, caverns, or an open spaces.
Member Functions
----------------
@@ -56,14 +58,19 @@ Member Functions
Member Variables
----------------
- :ref:`float<class_float>` **damping**
- :ref:`float<class_float>` **dry**
- :ref:`float<class_float>` **hipass**
- :ref:`float<class_float>` **predelay_feedback**
- :ref:`float<class_float>` **predelay_msec**
- :ref:`float<class_float>` **room_size**
- :ref:`float<class_float>` **spread**
- :ref:`float<class_float>` **wet**
- :ref:`float<class_float>` **damping** - Widens or narrows the stereo image of the reverb tail. 1 means fully widens. Value can range from 0 to 1. Default value: [code]1[/code].
- :ref:`float<class_float>` **dry** - Output percent of original sound. At 0, only modified sound is outputted. Value can range from 0 to 1. Default value: [code]1[/code].
- :ref:`float<class_float>` **hipass** - High-pass filter passes signals with a frequency higher than a certain cutoff frequency and attenuates signals with frequencies lower than the cutoff frequency. Value can range from 0 to 1. Default value: [code]0[/code].
- :ref:`float<class_float>` **predelay_feedback** - Output percent of predelay. Value can range from 0 to 1. Default value: [code]1[/code].
- :ref:`float<class_float>` **predelay_msec** - Time between the original signal and the early reflections of the reverb signal. Default value: [code]150ms[/code].
- :ref:`float<class_float>` **room_size** - Dimensions of simulated room. Bigger means more echoes. Value can range from 0 to 1. Default value: [code]0.8[/code].
- :ref:`float<class_float>` **spread** - Defines how reflective the imaginary room's walls are. Value can range from 0 to 1. Default value: [code]1[/code].
- :ref:`float<class_float>` **wet** - Output percent of modified sound. At 0, only original sound is outputted. Value can range from 0 to 1. Default value: [code]0.5[/code].
Description
-----------
Simulates rooms of different sizes. Its parameters can be adjusted to simulate the sound of a specific room.
Member Function Description
---------------------------