<?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectLimiter" inherits="AudioEffect" api_type="core" deprecated="Use [AudioEffectHardLimiter] instead." xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		Adds a soft-clip limiter audio effect to an audio bus.
	</brief_description>
	<description>
		A "limiter" is an audio effect designed to stop audio signals from exceeding a specified volume threshold level, and usually works by decreasing the volume or soft-clipping the audio. Adding one in the Master bus is always recommended to prevent clipping when the volume goes above 0 dB.
		Soft clipping starts to decrease the peaks a little below the volume threshold level and progressively increases its effect as the input volume increases such that the threshold level is never exceeded.
		If hard clipping is desired, consider [constant AudioEffectDistortion.MODE_CLIP].
	</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>
	</tutorials>
	<members>
		<member name="ceiling_db" type="float" setter="set_ceiling_db" getter="get_ceiling_db" default="-0.1">
			The waveform's maximum allowed value, in dB. Value can range from -20 to -0.1.
		</member>
		<member name="soft_clip_db" type="float" setter="set_soft_clip_db" getter="get_soft_clip_db" default="2.0">
			Modifies the volume of the limited waves, in dB. Value can range from 0 to 6.
		</member>
		<member name="soft_clip_ratio" type="float" setter="set_soft_clip_ratio" getter="get_soft_clip_ratio" default="10.0">
			This property has no effect on the audio. Use [AudioEffectHardLimiter] instead, as this Limiter effect is deprecated.
		</member>
		<member name="threshold_db" type="float" setter="set_threshold_db" getter="get_threshold_db" default="0.0">
			The volume threshold level from which the limiter begins to be active, in dB. Value can range from -30 to 0.
		</member>
	</members>
</class>
