42 lines
2.8 KiB
XML
42 lines
2.8 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="AudioEffectReverb" inherits="AudioEffect" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
|
|
<brief_description>
|
|
Adds a reverberation audio effect to an audio bus.
|
|
Emulates an echo by playing a blurred version of the input audio.
|
|
</brief_description>
|
|
<description>
|
|
A "reverb" effect plays the input audio back continuously, decaying over a period of time. It simulates sounds in different kinds of spaces, ranging from small rooms, to big caverns.
|
|
See also [AudioEffectDelay] for a non-blurry type of echo.
|
|
</description>
|
|
<tutorials>
|
|
<link title="Audio buses">$DOCS_URL/tutorials/audio/audio_buses.html</link>
|
|
<link title="Audio effects">$DOCS_URL/tutorials/audio/audio_effects.html</link>
|
|
<link title="Third Person Shooter (TPS) Demo">https://godotengine.org/asset-library/asset/2710</link>
|
|
</tutorials>
|
|
<members>
|
|
<member name="damping" type="float" setter="set_damping" getter="get_damping" default="0.5">
|
|
Defines how reflective the imaginary room's walls are. The more reflective, the more high frequency content the reverb has. Value can range from 0 to 1.
|
|
</member>
|
|
<member name="dry" type="float" setter="set_dry" getter="get_dry" default="1.0">
|
|
The volume ratio of the original audio. At 0, only the modified audio is outputted. Value can range from 0 to 1.
|
|
</member>
|
|
<member name="hipass" type="float" setter="set_hpf" getter="get_hpf" default="0.0">
|
|
High-pass filter allows frequencies higher than a certain cutoff threshold and attenuates frequencies lower than the cutoff threshold. Value can range from 0 to 1.
|
|
</member>
|
|
<member name="predelay_feedback" type="float" setter="set_predelay_feedback" getter="get_predelay_feedback" default="0.4">
|
|
Gain of early reflection copies. At higher values, early reflection copies are louder and ring out for longer. Value can range from 0 to 1.
|
|
</member>
|
|
<member name="predelay_msec" type="float" setter="set_predelay_msec" getter="get_predelay_msec" default="150.0">
|
|
Time between the original audio and the early reflections of the reverb signal, in milliseconds. Value can range from 20 to 500.
|
|
</member>
|
|
<member name="room_size" type="float" setter="set_room_size" getter="get_room_size" default="0.8">
|
|
Dimensions of simulated room. Bigger means more echoes. Value can range from 0 to 1.
|
|
</member>
|
|
<member name="spread" type="float" setter="set_spread" getter="get_spread" default="1.0">
|
|
Widens or narrows the stereo image of the reverb tail. At 1, it fully widens. Value can range from 0 to 1.
|
|
</member>
|
|
<member name="wet" type="float" setter="set_wet" getter="get_wet" default="0.5">
|
|
The volume ratio of the modified audio. At 0, only the original audio is outputted. Value can range from 0 to 1.
|
|
</member>
|
|
</members>
|
|
</class>
|