27 lines
1.9 KiB
XML
27 lines
1.9 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="AudioEffectHardLimiter" inherits="AudioEffect" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
|
|
<brief_description>
|
|
Adds a limiter audio effect to an audio bus.
|
|
Prevents audio signals from exceeding a specified volume level.
|
|
</brief_description>
|
|
<description>
|
|
A "limiter" disallows audio signals from exceeding a given volume threshold level in dB. Hard limiters predict volume peaks, and will smoothly apply gain reduction when a peak crosses the ceiling threshold level to prevent clipping. It preserves the waveform and prevents it from crossing the ceiling threshold level. Adding one in the Master bus is recommended as a safety measure to prevent sudden volume peaks from occurring, and to prevent distortion caused by clipping, when the volume exceeds 0 dB.
|
|
If 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.3">
|
|
The waveform's maximum allowed value, in dB. This value can range from -24 to 0.
|
|
The default value of -0.3 prevents potential inter-sample peaks (ISP) from crossing over 0 dB, which can cause slight distortion on some older hardware.
|
|
</member>
|
|
<member name="pre_gain_db" type="float" setter="set_pre_gain_db" getter="get_pre_gain_db" default="0.0">
|
|
Gain before limiting, in dB. Value can range from -24 to 24.
|
|
</member>
|
|
<member name="release" type="float" setter="set_release" getter="get_release" default="0.1">
|
|
Time it takes in seconds for the gain reduction to fully release. Value can range from 0.01 to 3.
|
|
</member>
|
|
</members>
|
|
</class>
|