2017-09-13 04:42:36 +08:00
<?xml version="1.0" encoding="UTF-8" ?>
2020-02-01 09:03:48 +08:00
<class name= "AudioEffectLimiter" inherits= "AudioEffect" version= "4.0" >
2017-09-13 04:42:36 +08:00
<brief_description >
2019-06-22 07:04:47 +08:00
Adds a soft-clip limiter audio effect to an Audio bus.
2017-09-13 04:42:36 +08:00
</brief_description>
<description >
2019-06-22 07:04:47 +08:00
A limiter is similar to a compressor, but it's less flexible and designed to disallow sound going over a given dB threshold. Adding one in the Master bus is always recommended to reduce the effects of clipping.
2017-09-17 00:47:19 +08:00
Soft clipping starts to reduce the peaks a little below the threshold level and progressively increases its effect as the input level increases such that the threshold is never exceeded.
2017-09-13 04:42:36 +08:00
</description>
<tutorials >
</tutorials>
<methods >
</methods>
<members >
2019-06-29 18:38:01 +08:00
<member name= "ceiling_db" type= "float" setter= "set_ceiling_db" getter= "get_ceiling_db" default= "-0.1" >
2019-06-29 21:24:23 +08:00
The waveform's maximum allowed value, in decibels. Value can range from -20 to -0.1.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "soft_clip_db" type= "float" setter= "set_soft_clip_db" getter= "get_soft_clip_db" default= "2.0" >
2019-06-29 21:24:23 +08:00
Applies a gain to the limited waves, in decibels. Value can range from 0 to 6.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "soft_clip_ratio" type= "float" setter= "set_soft_clip_ratio" getter= "get_soft_clip_ratio" default= "10.0" >
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "threshold_db" type= "float" setter= "set_threshold_db" getter= "get_threshold_db" default= "0.0" >
2019-06-29 21:24:23 +08:00
Threshold from which the limiter begins to be active, in decibels. Value can range from -30 to 0.
2017-09-13 04:42:36 +08:00
</member>
</members>
<constants >
</constants>
</class>
