f7f6115f76
- Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
43 lines
2.4 KiB
XML
43 lines
2.4 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="AudioEffectReverb" inherits="AudioEffect" category="Core" version="3.2">
|
|
<brief_description>
|
|
Adds a reverberation audio effect to an Audio bus.
|
|
Simulates the sound of acoustic environments such as rooms, concert halls, caverns, or an open spaces.
|
|
</brief_description>
|
|
<description>
|
|
Simulates rooms of different sizes. Its parameters can be adjusted to simulate the sound of a specific room.
|
|
</description>
|
|
<tutorials>
|
|
</tutorials>
|
|
<methods>
|
|
</methods>
|
|
<members>
|
|
<member name="damping" type="float" setter="set_damping" getter="get_damping">
|
|
Defines how reflective the imaginary room's walls are. Value can range from 0 to 1. Default value: [code]1[/code].
|
|
</member>
|
|
<member name="dry" type="float" setter="set_dry" getter="get_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].
|
|
</member>
|
|
<member name="hipass" type="float" setter="set_hpf" getter="get_hpf">
|
|
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].
|
|
</member>
|
|
<member name="predelay_feedback" type="float" setter="set_predelay_feedback" getter="get_predelay_feedback">
|
|
Output percent of predelay. Value can range from 0 to 1. Default value: [code]1[/code].
|
|
</member>
|
|
<member name="predelay_msec" type="float" setter="set_predelay_msec" getter="get_predelay_msec">
|
|
Time between the original signal and the early reflections of the reverb signal, in milliseconds. Default value: [code]150ms[/code].
|
|
</member>
|
|
<member name="room_size" type="float" setter="set_room_size" getter="get_room_size">
|
|
Dimensions of simulated room. Bigger means more echoes. Value can range from 0 to 1. Default value: [code]0.8[/code].
|
|
</member>
|
|
<member name="spread" type="float" setter="set_spread" getter="get_spread">
|
|
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].
|
|
</member>
|
|
<member name="wet" type="float" setter="set_wet" getter="get_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].
|
|
</member>
|
|
</members>
|
|
<constants>
|
|
</constants>
|
|
</class>
|