| bypass |
bypass-flag (0 or nonzero) [int]
|
The word bypass followed by a non-zero number will output the dry unchanged input signal straight out the outlet without any processing; followed by a 0, will output the signal effected by omx.peaklim~. |
| ingain |
pre-limiter-gain (dB) [int]
|
The word ingain, followed by a number, sets the gain in dB applied to the signal before limiting. |
| meterData |
|
When metering is on, the word meterData will cause a list of two values to be sent from the rightmost outlet at a rate specified by the meterRate message. These values describe the gain reduction in dB currently applied to the two input signals. |
| meterRate |
data-output-interval (milliseconds) [int]
|
The word meterRate, followed by a number, specifies the interval (in milliseconds) at which the meter data described above will be sent. |
| meters |
metering-flag (0 or 1) [int]
|
The word meters, followed by a 1 or 0, turns the metering output on or off. When metering is on, a list of two values will be sent from the rightmost outlet at a rate specified by the meterRate message. These values describe the gain reduction in dB currently applied to the two input signals. |
| mode |
response-mode-flag (0 or 1) [int]
|
The word mode, followed by a number, sets the limiter response mode as follows: 0 = punchy, 1 = smooth. Punchy response yields extremely short attack and release times, useful for transparent limiting, or to create loudness. However, if over-used, intermodulation distortion may result. Smooth response uses longer attack and release times. The result is still a fast look-ahead limiter, but with less intermodulation distortion and less punch. |
| outgain |
post-limiter-gain (dB) [int]
|
The word outgain, followed by a number, sets the gain in dB applied to the signal after limiting. |
| saveSettings |
|
The word saveSettings causes all parameter values to be sent out the third outlet. |
| threshold |
limiter-threshold (dB) [int]
|
The word threshold, followed by a number, sets the limiter threshold (in dB below full scale). When the input signal level exceeds this threshold, it will be attenuated as necessary to keep the level below the threshold. |
| signal |
|
Audio input, the signal or pair of signals to be peak-limited. |
