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~.

The word ingain, followed by a number 0-100, sets the gain (-24 to +24 dB) applied to the signal before limiting.

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.

The word meterRate, followed by a number, specifies the interval (in milliseconds) at which the meter data described above will be sent.

The word meters, followed by a 1 or 0, turns the metering output on or off. Whe N 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.

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.

The word outgain, followed by a number (0-100), sets the gain (-24 to +24 dB) applied to the signal after limiting.

The word saveSettings causes all parameter values to be sent out the third outlet.

Audio input, the signal or pair of signals to be compressed.

The word threshold, followed by a number (0-100), sets the limiter threshold (-24 to +24 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.