<?xml version="1.0" encoding="utf-8" standalone="yes"?>

<?xml-stylesheet href="./_c74_ref.xsl" type="text/xsl"?>

<!--This is an automatically generated file. DO NOT EDIT THIS FILE DIRECTLY. Rather, use the _ref.xml files found in the 'edits' folder.-->
<c74object name="omx.peaklim~" module="msp" category="MSP Dynamics">
	<digest>
		OctiMax Peak Limiter
	</digest>
	<description>
		<o>omx.peaklim~</o> is a peak-limiter which allows for the specified control of signal amplitude.
	</description>
	<!--METADATA-->
	<metadatalist>
		<metadata name="author">
			Cycling '74
		</metadata>
		<metadata name="tag">
			MSP
		</metadata>
		<metadata name="tag">
			MSP Dynamics
		</metadata>
	</metadatalist>
	<!--INLETS-->
	<inletlist>
		<inlet id="0" type="signal">
			<digest>
				(signal) Left Input Channel
			</digest>
			<description>
				TEXT_HERE
			</description>
		</inlet>
		<inlet id="1" type="signal">
			<digest>
				(signal) Right Input Channel
			</digest>
			<description>
				TEXT_HERE
			</description>
		</inlet>
	</inletlist>
	<!--OUTLETS-->
	<outletlist>
		<outlet id="0" type="signal">
			<digest>
				(signal) Left Output Channel
			</digest>
			<description>
				TEXT_HERE
			</description>
		</outlet>
		<outlet id="1" type="signal">
			<digest>
				(signal) Right Output Channel
			</digest>
			<description>
				TEXT_HERE
			</description>
		</outlet>
		<outlet id="2" type="list">
			<digest>
				(list) Parameter Output
			</digest>
			<description>
				TEXT_HERE
			</description>
		</outlet>
		<outlet id="3" type="list">
			<digest>
				(list) Meter Output
			</digest>
			<description>
				TEXT_HERE
			</description>
		</outlet>
	</outletlist>
	<!--ARGUMENTS-->
	<objarglist>
		<objarg id="0" name="OBJARG_NAME" type="OBJARG_TYPE" optional="0">
			<digest>
				TEXT_HERE
			</digest>
			<description>
				TEXT_HERE
			</description>
		</objarg>
	</objarglist>
	<!--MESSAGES-->
	<methodlist>
		<method name="bypass">
			<arglist>
				<arg name="bypass-flag" optional="0" type="int" />
			</arglist>
			<digest>
				Bypass processing and output the unprocessed signal
			</digest>
			<description>
				The word <m>bypass</m> 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 <o>omx.peaklim~</o>.
			</description>
		</method>
		<method name="ingain">
			<arglist>
				<arg name="pre-limiter-gain" optional="0" units="db" type="float" />
			</arglist>
			<digest>
				Set the gain applied to the signal before limiting
			</digest>
			<description>
				The word <m>ingain</m>, followed by a number, sets the gain in dB applied to the signal before limiting.
			</description>
		</method>
		<method name="meterData">
			<arglist />
			<digest>
				Send metering data out the right outlet
			</digest>
			<description>
				When metering is on, the word <m>meterData</m> will cause a list of two values to be sent from the rightmost outlet at a rate specified by the <m>meterRate message</m>. These values describe the gain reduction in dB currently applied to the two input signals.
			</description>
		</method>
		<method name="meterRate">
			<arglist>
				<arg name="data-output-interval" optional="0" units="ms" type="int" />
			</arglist>
			<digest>
				Set the data output interval
			</digest>
			<description>
				The word <m>meterRate</m>, followed by a number, specifies the interval (in milliseconds) at which the meter data described above will be sent.
			</description>
		</method>
		<method name="meters">
			<arglist>
				<arg name="metering-flag" optional="0" type="int" />
			</arglist>
			<digest>
				Disable/enable metering
			</digest>
			<description>
				The word <m>meters</m>, 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 <m>meterRate message</m>. These values describe the gain reduction in dB currently applied to the two input signals.
			</description>
		</method>
		<method name="mode">
			<arglist>
				<arg name="response-mode-flag" optional="0" type="int" />
			</arglist>
			<digest>
				Set the limiter response mode
			</digest>
			<description>
				The word <m>mode</m>, 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.
			</description>
		</method>
		<method name="outgain">
			<arglist>
				<arg name="post-limiter-gain" optional="0" units="db" type="float" />
			</arglist>
			<digest>
				Set the gain applied to the signal after limiting
			</digest>
			<description>
				The word <m>outgain</m>, followed by a number, sets the gain in dB applied to the signal after limiting.
			</description>
		</method>
		<method name="saveSettings">
			<arglist />
			<digest>
				Send all parameter values out the third outlet
			</digest>
			<description>
				The word <m>saveSettings</m> causes all parameter values to be sent out the third outlet.
			</description>
		</method>
		<method name="threshold">
			<arglist>
				<arg name="limiter-threshold" optional="0" units="db" type="float" />
			</arglist>
			<digest>
				Set the limiter threshold
			</digest>
			<description>
				The word <m>threshold</m>, 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.
			</description>
		</method>
		<method name="signal">
			<arglist />
			<digest>
				Audio input
			</digest>
			<description>
				Audio input, the signal or pair of signals to be compressed.
			</description>
		</method>
	</methodlist>
	<!--ATTRIBUTES-->
	<!--EXAMPLE-->
	<examplelist>
		<example />
	</examplelist>
	<!--SEEALSO-->
	<seealsolist>
		<seealso name="omx.4band~" />
		<seealso name="omx.5band~" />
		<seealso name="omx.comp~" />
		<seealso name="17_msp_compress_01" module="msp" type="tutorial" />
	</seealsolist>
	<misc name="Output">
		<entry name="signal">
			<description>
				Out leftmost two outlets: the input signals (if present), with dynamics processing applied.
			</description>
		</entry>
		<entry name="list">
			<description>
				Out third outlet: parameter values in response to <m>saveSettings</m> message.
				<br />
				<br />
				Out fourth outlet: meter data. When metering is turned on, lists of values will be output that describe various internal levels. See the description of the <m>meters</m> message.
				<br />
				<br />
			</description>
		</entry>
	</misc>
</c74object>
