<?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="clocker" module="max" category="Timing">
	<digest>
		Report elapsed time, at regular intervals
	</digest>
	<description>
		The <o>clocker</o> object is a metronome that reports the time elapsed since it was started. This object uses the Max <link name="maxtime" module="core" type="vignette">time format</link> syntax, so the interval that the <o>clocker</o> object uses can be either fixed or tempo-relative. Its output can be quantized using tempo-relative syntax, and if the <i>autostarttime</i> attribute is set, the object can also start at a tempo-relative point.
	</description>
	<!--METADATA-->
	<metadatalist>
		<metadata name="author">
			Cycling '74
		</metadata>
		<metadata name="tag">
			Timing
		</metadata>
		<metadata name="tag">
			Timing
		</metadata>
	</metadatalist>
	<!--INLETS-->
	<inletlist>
		<inlet id="0" type="INLET_TYPE">
			<digest>
				Start/Stop Metronome
			</digest>
			<description>
				TEXT_HERE
			</description>
		</inlet>
		<inlet id="1" type="INLET_TYPE">
			<digest>
				Set Metronome Time Interval
			</digest>
			<description>
				TEXT_HERE
			</description>
		</inlet>
	</inletlist>
	<!--OUTLETS-->
	<outletlist>
		<outlet id="0" type="OUTLET_TYPE">
			<digest>
				Output Ticks of Metronome
			</digest>
			<description>
				TEXT_HERE
			</description>
		</outlet>
	</outletlist>
	<!--ARGUMENTS-->
	<objarglist>
		<objarg name="time-interval" optional="0" type="int, float, symbol">
			<digest>
				The first argument sets an initial value for the time interval at which <o>clocker</o> sends out its output. This time interval can be either a number which specifies time in milliseconds (e.g. clocker 200) or a <link name="maxtime_syntax" module="core" type="vignette">notevalue</link> (e.g. clocker 4nd).
				<br />
				<br />
				Note: While the <o>clocker</o> object lets you specify time in any of Max's standard <link name="maxtime" module="core" type="vignette">time formats</link>, the <m>Interval</m> attribute argument should be used when specifying time in any other time unit besides milliseconds or notevalues.
				<br />
				<br />
				If there is no argument, the initial time interval is set to 5 milliseconds. If notevalue, ticks, or bars.beats.units are specified for the delay interval, the <o>clocker</o> object will not operate unless the transport is running.
			</digest>
			<description>
				The first argument sets an initial value for the time interval at which <o>clocker</o> sends out its output. This time interval can be either a number which specifies time in milliseconds (e.g. clocker 200) or a <link name="maxtime_syntax" module="core" type="vignette">notevalue</link> (e.g. clocker 4nd).
				<br />
				<br />
				Note: While the <o>clocker</o> object lets you specify time in any of Max's standard <link name="maxtime" module="core" type="vignette">time formats</link>, the <m>Interval</m> attribute argument should be used when specifying time in any other time unit besides milliseconds or notevalues.
				<br />
				<br />
				If there is no argument, the initial time interval is set to 5 milliseconds. If notevalue, ticks, or bars.beats.units are specified for the delay interval, the <o>clocker</o> object will not operate unless the transport is running.
			</description>
		</objarg>
	</objarglist>
	<!--MESSAGES-->
	<methodlist>
		<method name="bang">
			<arglist />
			<digest>
				In left inlet: Starts the <o>clocker</o> object.
			</digest>
			<description>
				In left inlet: Starts the <o>clocker</o> object. If the <o>clocker</o> object is not running, a <m>bang</m> message will start the count. If the <o>clocker</o> object is running, a <m>bang</m> message will reset the count.
			</description>
			<attributelist>
				<attribute name="inlet" get="1" set="1" type="int" size="1" value="1" />
			</attributelist>
		</method>
		<method name="int">
			<arglist>
				<arg name="non-zero-to-start" optional="0" type="int" />
			</arglist>
			<digest>
				Start/stop.
			</digest>
			<description>
				In left inlet: Any non-zero number starts the <o>clocker</o> object. The time elapsed since <o>clocker</o> was started is sent out the outlet at regular intervals. 0 stops the <o>clocker</o> object.
			</description>
		</method>
		<method name="float">
			<arglist>
				<arg name="non-zero-to-start" optional="0" type="float" />
			</arglist>
			<digest>
				Start/stop.
			</digest>
			<description>
				Same as <m>int</m>.
			</description>
		</method>
		<method name="list">
			<arglist>
				<arg name="input" optional="0" type="list" />
			</arglist>
			<digest>
				ITM-time-list
			</digest>
			<description>
				In right inlet: A list may be used to specify time in one of the Max <link name="maxtime" module="core" type="vignette">time formats</link>.
			</description>
		</method>
		<method name="anything">
			<arglist>
				<arg name="interval" optional="0" type="list" />
			</arglist>
			<digest>
				Same as <m>list</m>.
			</digest>
			<description>
				Same as <m>list</m>.
			</description>
			<attributelist>
				<attribute name="inlet" get="1" set="1" type="int" size="1" value="2" />
			</attributelist>
		</method>
		<method name="clock">
			<arglist>
				<arg name="setclock object name" optional="0" type="symbol" />
			</arglist>
			<digest>
				The word <m>clock</m>, followed by the name of an existing <m>setclock</m> object, sets the <o>clocker</o> object to be controlled by that <m>setclock</m> object rather than by Max’s internal millisecond clock.
			</digest>
			<description>
				The word <m>clock</m>, followed by the name of an existing <m>setclock</m> object, sets the <o>clocker</o> object to be controlled by that <m>setclock</m> object rather than by Max’s internal millisecond clock. The word <m>clock</m> by itself sets the <o>clocker</o> object back to using Max’s regular millisecond clock.
			</description>
		</method>
		<method name="stop">
			<arglist />
			<digest>
				In left inlet: Stops the <o>clocker</o> object.
			</digest>
			<description>
				In left inlet: Stops the <o>clocker</o> object.
			</description>
			<attributelist>
				<attribute name="inlet" get="1" set="1" type="int" size="1" value="1" />
			</attributelist>
		</method>
		<method name="reset">
			<arglist />
			<digest>
				In left inlet: Resets the elapsed time to 0 without stopping or restarting the clock; <o>clocker</o> continues to report the new elapsed time at the same regular interval.
			</digest>
			<description>
				In left inlet: Resets the elapsed time to 0 without stopping or restarting the clock; <o>clocker</o> continues to report the new elapsed time at the same regular interval. This message is meaningless when the <o>clocker</o> is not running, since it always resets to 0 anyway when stopped.
			</description>
			<attributelist>
				<attribute name="undocumentedfor" get="1" set="1" type="symbol" size="1" value="metro" />
			</attributelist>
		</method>
	</methodlist>
	<!--ATTRIBUTES-->
	<attributelist>
		<attribute name="active" get="1" set="1" type="int" size="1">
			<digest>
				Active
			</digest>
			<description>
				Turns the <o>clocker</o> object on and off.
			</description>
			<attributelist>
				<attribute name="basic" get="1" set="1" type="int" size="1" value="1" />
				<attribute name="category" get="1" set="1" type="symbol" size="1" value="Timing" />
				<attribute name="label" get="1" set="1" type="symbol" size="1" value="Active" />
				<attribute name="style" get="1" set="1" type="symbol" size="1" value="onoff" />
			</attributelist>
		</attribute>
		<attribute name="autostart" get="1" set="1" type="int" size="1">
			<digest>
				Autostart
			</digest>
			<description>
				If turned on (non-zero) the <o>clocker</o> object will begin running automatically at the time specified with the autostarttime attribute.
			</description>
			<attributelist>
				<attribute name="basic" get="1" set="1" type="int" size="1" value="1" />
				<attribute name="category" get="1" set="1" type="symbol" size="1" value="Timing" />
				<attribute name="label" get="1" set="1" type="symbol" size="1" value="Autostart" />
				<attribute name="style" get="1" set="1" type="symbol" size="1" value="onoff" />
			</attributelist>
		</attribute>
		<attribute name="autostarttime" get="1" set="1" type="atom" size="10">
			<digest>
				Autostart Time
			</digest>
			<description>
				If the autostart attribute is enabled (non-zero) the <o>clocker</o> object will begin running automatically at the time specified with the this attribute. The autostart operates as a <o>timepoint</o> object that is internal to the <o>clocker</o> object.
			</description>
			<attributelist>
				<attribute name="category" get="1" set="1" type="symbol" size="1" value="Timing" />
				<attribute name="label" get="1" set="1" type="symbol" size="1" value="Autostart Time" />
				<attribute name="style" get="1" set="1" type="symbol" size="1" value="time" />
				<attribute name="units" get="1" set="1" type="atom" size="3" value="ticks bars.beats.units notevalues" />
			</attributelist>
		</attribute>
		<attribute name="defer" get="1" set="1" type="float" size="1">
			<digest>
				Defer
			</digest>
			<description>
				Turn this on to send output in the low-priority queue.
			</description>
			<attributelist>
				<attribute name="category" get="1" set="1" type="symbol" size="1" value="Timing" />
				<attribute name="label" get="1" set="1" type="symbol" size="1" value="Defer" />
				<attribute name="style" get="1" set="1" type="symbol" size="1" value="onoff" />
				<attribute name="timeobj" get="1" set="1" type="atom" size="1" value="interval" />
			</attributelist>
		</attribute>
		<attribute name="interval" get="1" set="1" type="atom" size="10">
			<digest>
				Interval
			</digest>
			<description>
				Sets the The time interval at which the <o>clocker</o> object sends out a <m>bang</m>. Time can be specified in any of the <link name="maxtime" module="core" type="vignette">time formats</link> used in Max.
			</description>
			<attributelist>
				<attribute name="basic" get="1" set="1" type="int" size="1" value="1" />
				<attribute name="category" get="1" set="1" type="symbol" size="1" value="Timing" />
				<attribute name="label" get="1" set="1" type="symbol" size="1" value="Interval" />
				<attribute name="style" get="1" set="1" type="symbol" size="1" value="time" />
				<attribute name="units" get="1" set="1" type="atom" size="7" value="ms hh:mm:ss ticks bars.beats.units notevalues hz samples" />
			</attributelist>
		</attribute>
		<attribute name="quantize" get="1" set="1" type="atom" size="10">
			<digest>
				Quantization
			</digest>
			<description>
				Send output only on the specified time-boundary if appropriate. This is achieved by making internal adjustments to the times used for sending output. The quantization can be specified in the following <link name="maxtime" module="core" type="vignette">time formats</link>: bars.beats.units, ticks or note values.
			</description>
			<attributelist>
				<attribute name="basic" get="1" set="1" type="int" size="1" value="1" />
				<attribute name="category" get="1" set="1" type="symbol" size="1" value="Timing" />
				<attribute name="label" get="1" set="1" type="symbol" size="1" value="Quantization" />
				<attribute name="style" get="1" set="1" type="symbol" size="1" value="time" />
				<attribute name="units" get="1" set="1" type="atom" size="3" value="ticks bars.beats.units notevalues" />
			</attributelist>
		</attribute>
		<attribute name="transport" get="1" set="1" type="symbol" size="1">
			<digest>
				Transport
			</digest>
			<description>
				This attribute names a master time transport. If the time is specified using a 'relative' unit (for example: ticks, bars.beats.units, or notevalues), then the named transport is used to determine delay times based on tempo, time-signature, and other related information.
			</description>
			<attributelist>
				<attribute name="category" get="1" set="1" type="symbol" size="1" value="Timing" />
				<attribute name="label" get="1" set="1" type="symbol" size="1" value="Transport" />
				<attribute name="timeobj" get="1" set="1" type="atom" size="1" value="interval" />
			</attributelist>
		</attribute>
	</attributelist>
	<!--EXAMPLE-->
	<examplelist>
		<example img="clocker.png" />
	</examplelist>
	<!--SEEALSO-->
	<seealsolist>
		<seealso name="counter" />
		<seealso name="cpuclock" />
		<seealso name="delay" />
		<seealso name="setclock" />
		<seealso name="tempo" />
		<seealso name="transport" />
		<seealso name="uzi" />
	</seealsolist>
</c74object>
