virtualx-engine/doc/classes/AudioEffectDelay.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectDelay" inherits="AudioEffect" version="3.6" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		Adds a delay audio effect to an audio bus. Plays input signal back after a period of time.
		Two tap delay and feedback options.
	</brief_description>
	<description>
		Plays input signal back after a period of time. The delayed signal may be played back multiple times to create the sound of a repeating, decaying echo. Delay effects range from a subtle echo effect to a pronounced blending of previous sounds with new sounds.
	</description>
	<tutorials>
	</tutorials>
	<methods>
	</methods>
	<members>
		<member name="dry" type="float" setter="set_dry" getter="get_dry" default="1.0">
			Output percent of original sound. At 0, only delayed sounds are output. Value can range from 0 to 1.
		</member>
		<member name="feedback/active" type="bool" setter="set_feedback_active" getter="is_feedback_active" default="false">
			If [code]true[/code], feedback is enabled.
		</member>
		<member name="feedback/delay_ms" type="float" setter="set_feedback_delay_ms" getter="get_feedback_delay_ms" default="340.0">
			Feedback delay time in milliseconds.
		</member>
		<member name="feedback/level_db" type="float" setter="set_feedback_level_db" getter="get_feedback_level_db" default="-6.0">
			Sound level for [code]tap1[/code].
		</member>
		<member name="feedback/lowpass" type="float" setter="set_feedback_lowpass" getter="get_feedback_lowpass" default="16000.0">
			Low-pass filter for feedback, in Hz. Frequencies below this value are filtered out of the source signal.
		</member>
		<member name="tap1/active" type="bool" setter="set_tap1_active" getter="is_tap1_active" default="true">
			If [code]true[/code], [code]tap1[/code] will be enabled.
		</member>
		<member name="tap1/delay_ms" type="float" setter="set_tap1_delay_ms" getter="get_tap1_delay_ms" default="250.0">
			[code]tap1[/code] delay time in milliseconds.
		</member>
		<member name="tap1/level_db" type="float" setter="set_tap1_level_db" getter="get_tap1_level_db" default="-6.0">
			Sound level for [code]tap1[/code].
		</member>
		<member name="tap1/pan" type="float" setter="set_tap1_pan" getter="get_tap1_pan" default="0.2">
			Pan position for [code]tap1[/code]. Value can range from -1 (fully left) to 1 (fully right).
		</member>
		<member name="tap2/active" type="bool" setter="set_tap2_active" getter="is_tap2_active" default="true">
			If [code]true[/code], [code]tap2[/code] will be enabled.
		</member>
		<member name="tap2/delay_ms" type="float" setter="set_tap2_delay_ms" getter="get_tap2_delay_ms" default="500.0">
			[b]Tap2[/b] delay time in milliseconds.
		</member>
		<member name="tap2/level_db" type="float" setter="set_tap2_level_db" getter="get_tap2_level_db" default="-12.0">
			Sound level for [code]tap2[/code].
		</member>
		<member name="tap2/pan" type="float" setter="set_tap2_pan" getter="get_tap2_pan" default="-0.4">
			Pan position for [code]tap2[/code]. Value can range from -1 (fully left) to 1 (fully right).
		</member>
	</members>
	<constants>
	</constants>
</class>