AudioEffectLimiter¶
Inherits: AudioEffect < Resource < Reference < Object
Category: Core
Brief Description¶
Adds a soft clip Limiter audio effect to an Audio bus.
Properties¶
| float | ceiling_db |
| float | soft_clip_db |
| float | soft_clip_ratio |
| float | threshold_db |
Description¶
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.
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.
Property Descriptions¶
- float ceiling_db
| Setter | set_ceiling_db(value) |
| Getter | get_ceiling_db() |
The waveform’s maximum allowed value. Value can range from -20 to -0.1. Default value: -0.1dB.
- float soft_clip_db
| Setter | set_soft_clip_db(value) |
| Getter | get_soft_clip_db() |
Applies a gain to the limited waves. Value can range from 0 to 6. Default value: 2dB.
- float soft_clip_ratio
| Setter | set_soft_clip_ratio(value) |
| Getter | get_soft_clip_ratio() |
- float threshold_db
| Setter | set_threshold_db(value) |
| Getter | get_threshold_db() |
Threshold from which the limiter begins to be active. Value can range from -30 to 0. Default value: 0dB.