virtualx-engine/doc/classes/AudioEffectReverb.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectReverb" inherits="AudioEffect" category="Core" version="3.0.alpha.custom_build">
	<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.
	</brief_description>
	<description>
		Simulates rooms of different sizes. Its parameters can be adjusted to simulate the sound of a specific room.
	</description>
	<tutorials>
	</tutorials>
	<demos>
	</demos>
	<methods>
		<method name="get_damping" qualifiers="const">
			<return type="float">
			</return>
			<description>
			</description>
		</method>
		<method name="get_dry" qualifiers="const">
			<return type="float">
			</return>
			<description>
			</description>
		</method>
		<method name="get_hpf" qualifiers="const">
			<return type="float">
			</return>
			<description>
			</description>
		</method>
		<method name="get_predelay_feedback" qualifiers="const">
			<return type="float">
			</return>
			<description>
			</description>
		</method>
		<method name="get_predelay_msec" qualifiers="const">
			<return type="float">
			</return>
			<description>
			</description>
		</method>
		<method name="get_room_size" qualifiers="const">
			<return type="float">
			</return>
			<description>
			</description>
		</method>
		<method name="get_spread" qualifiers="const">
			<return type="float">
			</return>
			<description>
			</description>
		</method>
		<method name="get_wet" qualifiers="const">
			<return type="float">
			</return>
			<description>
			</description>
		</method>
		<method name="set_damping">
			<return type="void">
			</return>
			<argument index="0" name="amount" type="float">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_dry">
			<return type="void">
			</return>
			<argument index="0" name="amount" type="float">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_hpf">
			<return type="void">
			</return>
			<argument index="0" name="amount" type="float">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_predelay_feedback">
			<return type="void">
			</return>
			<argument index="0" name="feedback" type="float">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_predelay_msec">
			<return type="void">
			</return>
			<argument index="0" name="msec" type="float">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_room_size">
			<return type="void">
			</return>
			<argument index="0" name="size" type="float">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_spread">
			<return type="void">
			</return>
			<argument index="0" name="amount" type="float">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_wet">
			<return type="void">
			</return>
			<argument index="0" name="amount" type="float">
			</argument>
			<description>
			</description>
		</method>
	</methods>
	<members>
		<member name="damping" type="float" setter="set_damping" getter="get_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].
		</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_msec" getter="get_predelay_msec">
			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. 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">
			Defines how reflective the imaginary room's walls are. 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>