virtualx-engine/doc/classes/AudioEffectCompressor.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectCompressor" inherits="AudioEffect" category="Core" version="3.0-alpha">
	<brief_description>
		Adds a Compressor audio effect to an Audio bus.
		Reduces sounds that exceed a certain threshold level, smooths out the dynamics and increases the overall volume.
	</brief_description>
	<description>
		Dynamic range compressor reduces the level of the sound when the amplitude goes over a certain threshold in Decibels. One of the main uses of a compressor is to increase the dynamic range by clipping as little as possible (when sound goes over 0dB).
		Compressor has many uses in the mix:
		- In the Master bus to compress the whole output (Although a [AudioEffectLimiter] is probably better)
		- In voice channels to ensure they sound as balanced as possible.
		- Sidechained. Sidechained, which can reduce the sound level sidechained with another audio bus for threshold detection.. This technique is very common in video game mixing to download the level of Music/SFX while voices are being heard.
		- Accentuates transients by using a wider attack, making effects sound more punchy.
	</description>
	<tutorials>
	</tutorials>
	<demos>
	</demos>
	<methods>
		<method name="get_attack_us" qualifiers="const">
			<return type="float">
			</return>
			<description>
			</description>
		</method>
		<method name="get_gain" qualifiers="const">
			<return type="float">
			</return>
			<description>
			</description>
		</method>
		<method name="get_mix" qualifiers="const">
			<return type="float">
			</return>
			<description>
			</description>
		</method>
		<method name="get_ratio" qualifiers="const">
			<return type="float">
			</return>
			<description>
			</description>
		</method>
		<method name="get_release_ms" qualifiers="const">
			<return type="float">
			</return>
			<description>
			</description>
		</method>
		<method name="get_sidechain" qualifiers="const">
			<return type="String">
			</return>
			<description>
			</description>
		</method>
		<method name="get_threshold" qualifiers="const">
			<return type="float">
			</return>
			<description>
			</description>
		</method>
		<method name="set_attack_us">
			<return type="void">
			</return>
			<argument index="0" name="attack_us" type="float">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_gain">
			<return type="void">
			</return>
			<argument index="0" name="gain" type="float">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_mix">
			<return type="void">
			</return>
			<argument index="0" name="mix" type="float">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_ratio">
			<return type="void">
			</return>
			<argument index="0" name="ratio" type="float">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_release_ms">
			<return type="void">
			</return>
			<argument index="0" name="release_ms" type="float">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_sidechain">
			<return type="void">
			</return>
			<argument index="0" name="sidechain" type="String">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_threshold">
			<return type="void">
			</return>
			<argument index="0" name="threshold" type="float">
			</argument>
			<description>
			</description>
		</method>
	</methods>
	<members>
		<member name="attack_us" type="float" setter="set_attack_us" getter="get_attack_us">
			Compressor's reaction time when the signal exceeds the threshold. Value can range from 20 to 2000. Default value: [code]20ms[/code].
		</member>
		<member name="gain" type="float" setter="set_gain" getter="get_gain">
			Gain applied to the output signal.
		</member>
		<member name="mix" type="float" setter="set_mix" getter="get_mix">
			Balance between original signal and effect signal. Value can range from 0 (totally dry) to 1 (totally wet). Default value: [code]1[/code].
		</member>
		<member name="ratio" type="float" setter="set_ratio" getter="get_ratio">
			Amount of compression applied to the audio once it passes the threshold level. The higher the ratio the more the loud parts of the audio will be compressed. Value can range from 1 to 48. Default value: [code]4[/code].
		</member>
		<member name="release_ms" type="float" setter="set_release_ms" getter="get_release_ms">
			Compressor's delay time to stop reducing the signal after the signal level falls below the threshold. Value can range from 20 to 2000. Default value: [code]250ms[/code].
		</member>
		<member name="sidechain" type="String" setter="set_sidechain" getter="get_sidechain">
			Reduce the sound level using another audio bus for threshold detection.
		</member>
		<member name="threshold" type="float" setter="set_threshold" getter="get_threshold">
			The level above which compression is applied to the audio. Value can range from -60 to 0. Default value: [code]0[/code].
		</member>
	</members>
	<constants>
	</constants>
</class>