<?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="jit.qt.effect" module="jit" category="Jitter QuickTime, Jitter Special FX">
	<digest>
		QuickTime Effects for Jitter matrices
	</digest>
	<description>
		The <o>jit.qt.effect</o> object provides a wrapper for the QuickTime Effects architecture within Jitter.
	</description>
	<!--METADATA-->
	<metadatalist>
		<metadata name="author">
			Cycling '74
		</metadata>
		<metadata name="tag">
			Jitter
		</metadata>
		<metadata name="tag">
			Jitter QuickTime
		</metadata>
		<metadata name="tag">
			Jitter Special FX
		</metadata>
	</metadatalist>
	<!--INLETS-->
	<inletlist>
		<inlet id="0" type="matrix">
			<digest>
				in
			</digest>
			<description>
				TEXT_HERE
			</description>
		</inlet>
		<inlet id="1" type="matrix">
			<digest>
				in2
			</digest>
			<description>
				TEXT_HERE
			</description>
		</inlet>
	</inletlist>
	<!--OUTLETS-->
	<outletlist>
		<outlet id="0" type="matrix">
			<digest>
				out
			</digest>
			<description>
				TEXT_HERE
			</description>
		</outlet>
		<outlet id="1" type="matrix">
			<digest>
				dumpout
			</digest>
			<description>
				TEXT_HERE
			</description>
		</outlet>
	</outletlist>
	<!--MOP-->
	<mop matrixinputcount="2" matrixoutputcount="1">
		<matrixinput name="in2" planelink="1" typelink="1" dimlink="1" minplanecount="4" maxplanecount="4" mindimcount="1" maxdimcount="32" ioproc="resamp">
			<types>
				char
			</types>
		</matrixinput>
		<matrixoutput name="out" planelink="1" typelink="1" dimlink="1" minplanecount="4" maxplanecount="4" mindimcount="1" maxdimcount="32">
			<types>
				char
			</types>
		</matrixoutput>
	</mop>
	<!--MESSAGES-->
	<methodlist>
		<method name="dialog">
			<arglist>
				<arg name="tween-enable" optional="1" type="int" />
			</arglist>
			<digest>
				Open the standard QuickTime Effects dialog box
			</digest>
			<description>
				Opens the standard QuickTime Effects dialog box. With no argument (or a <i>tween-enable</i> argument of 1), the dialog will open with the optionally-tweened parameters tween-enabled. With a <i>tween-enable</i> argument of 0, optionally-tweened params are tween-disabled.
			</description>
		</method>
		<method name="geteffectlist">
			<arglist />
			<digest>
				Report all available QuickTime effects
			</digest>
			<description>
				Sends a list out the object's right outlet describing all available QuickTime effects, one effect per line. The lists are in the form <m>effectlist</m>  <i>effect-number</i>  <i>effect-name</i>  <i>effect-type-code</i>.
			</description>
		</method>
		<method name="getparamhead">
			<arglist />
			<digest>
				Report all QuickTime effect parameters
			</digest>
			<description>
				Sends the parameter header list out the object's right outlet. The list is in the form <m>paramhead</m>  <i>effect-name</i>  <i>effect-type-code</i>  <i>no.-of-params</i>  <i>no.-of-sources</i>.				<br />
			</description>
		</method>
		<method name="getparamlist">
			<arglist />
			<digest>
				Report parameter information for current QuickTime effect
			</digest>
			<description>
				Sends several lists out the object's right outlet describing the parameters for the currently selected effect. The first list is in the form <m>paramhead</m>  <i>effect-name</i>  <i>effect-type-code</i>  <i>no.-of-params</i>  <i>no.-of-sources</i> 				<br />
				The following list or lists (one list for each parameter) are in the form <m>paramlist</m>  <i>param-number</i>  <i>param-name</i>  <i>param-type-code</i>  <i>tween-flag</i>  <i>data-type</i>. Depending on the effect, two additional messages may be used: <i>min-value</i>  <i>max-value</i>.				<p>
					The tween flag settings are:
					<br />
					0 = always tweened
					<br />
					1 = never tweened
					<br />
					2 = optionally tweened
					<br />
				</p>
				<p>
					The data types and their expected input are:
					<br />
					long = int
					<br />
					fixed = float
					<br />
					rgb = 3 floats, from 0 to 1.0
					<br />
					double = float
					<br />
					text = text, currently unsupported from Max, but available from the <m>dialog</m> message
					<br />
					enum = enumerated list (int)
					<br />
					bool = boolean (int)
					<br />
					imag = image, currently unsupported from Max, but available from the <m>dialog</m> message
					<br />
				</p>
				<p>
					Minimum value and maximum value are all reported in the data type of the parameter, if they are supplied at all.
				</p>
			</description>
		</method>
		<method name="loadeffect">
			<arglist>
				<arggroup type="mutex">
					<arg name="effect-number" type="int" />
					<arg name="effect-type-code" type="symbol" />
				</arggroup>
			</arglist>
			<digest>
				Load a QuickTime Effect
			</digest>
			<description>
				Selects an available QuickTime Effect for use. The effect may be specified by its index number or by its type code.
			</description>
		</method>
		<method name="qfx_read">
			<arglist />
			<digest>
				Load QuickTime effect parameters from a .qxf-formatted file.
			</digest>
			<description>
				Load and enable the parameters specified by a QuickTime Effects .qxf-formatted file. These files may also be read from the dialog box.
			</description>
		</method>
		<method name="qfx_write">
			<arglist />
			<digest>
				Write QuickTime effect parameters to a .qxf-formatted file.
			</digest>
			<description>
				Write the current effect and parameters to a QuickTime Effects .qxf-formatted file. These files may also be written from the dialog box. The <o>jit.qt.movie</o> object can read these files to generate QuickTime Effects tracks embedded within movies.
			</description>
		</method>
	</methodlist>
	<jittermethodlist>
		<jittermethod name="bang" />
		<jittermethod name="clear" />
		<jittermethod name="exportattrs" />
		<jittermethod name="exportsummary" />
		<jittermethod name="getattributes" />
		<jittermethod name="getstate" />
		<jittermethod name="jit_matrix" />
		<jittermethod name="importattrs" />
		<jittermethod name="outputmatrix" />
		<jittermethod name="summary" />
	</jittermethodlist>
	<!--ATTRIBUTES-->
	<attributelist>
		<attribute name="fx" get="1" set="1" type="symbol" size="1">
			<digest>
				Currently loaded effect
			</digest>
			<description>
				The currently loaded effect
			</description>
		</attribute>
		<attribute name="numeffects" get="1" set="0" type="int" size="1">
			<digest>
				Number of available effects
			</digest>
			<description>
				The number of available effects
			</description>
		</attribute>
		<attribute name="numparams" get="1" set="0" type="int" size="1">
			<digest>
				Number of parameters for the currently loaded effect
			</digest>
			<description>
				The number of parameters available to the currently loaded effect
			</description>
		</attribute>
		<attribute name="param" get="0" set="1" type="int" size="256">
			<digest>
				Parameter value for tweenable parameters
			</digest>
			<description>
				The parameter value for tweenable parameters
			</description>
		</attribute>
		<attribute name="param_a" get="0" set="1" type="int" size="256">
			<digest>
				Start value for tweenable parameters
			</digest>
			<description>
				The start value for tweenable parameters
			</description>
		</attribute>
		<attribute name="param_b" get="0" set="1" type="int" size="256">
			<digest>
				End value for tweenable parameters
			</digest>
			<description>
				The end value for tweenable parameters
			</description>
		</attribute>
		<attribute name="paramclip" get="1" set="1" type="int" size="1">
			<digest>
				Parameter clipping flag
			</digest>
			<description>
				Parameter clipping flag (default = 1) When the flag is set, parameter values are clipped to the effect's recommended range (default = 1)
			</description>
		</attribute>
		<attribute name="steps" get="1" set="1" type="int" size="1">
			<digest>
				Number of tweening steps
			</digest>
			<description>
				The number of steps between <at>param_a</at> and <at>param_b</at> for tweenable parameters
			</description>
		</attribute>
	</attributelist>
	<jitterattributelist>
		<jitterattribute name="outputmode" />
		<jitterattribute name="adapt" />
		<jitterattribute name="in2_name" />
		<jitterattribute name="in2_type" />
		<jitterattribute name="in2_dim" />
		<jitterattribute name="in2_planecount" />
		<jitterattribute name="out_name" />
		<jitterattribute name="type" />
		<jitterattribute name="dim" />
		<jitterattribute name="planecount" />
	</jitterattributelist>
	<!--EXAMPLE-->
	<examplelist>
		<example img="jit.qt.effect.png" />
	</examplelist>
	<!--SEEALSO-->
	<seealsolist>
		<seealso name="jit.qt.grab" />
		<seealso name="jit.qt.movie" />
		<seealso name="jit.qt.record" />
		<seealso name="jit.qt.videoout" />
		<seealso module="jit" name="jitterchapter24" type="tutorial" />
	</seealsolist>
	<discussion>
		It supports both single and dual input effects (but not triple at this time). The object's interface is complicated by the QTFX architecture -- each effect may have a completely different set of parameters requiring different data types and ranges. For complete information, refer to the help file.
	</discussion>
</c74object>
