<?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.matrixset" module="jit" category="Jitter Data">
	<digest>
		A set of matrices for storage/resequencing
	</digest>
	<description>
		The <o>jit.matrixset</o> object keeps a set of internal matrices which may be written to or read from. This may be useful for data storage and/or matrix resequencing.
	</description>
	<!--METADATA-->
	<metadatalist>
		<metadata name="author">
			Cycling '74
		</metadata>
		<metadata name="tag">
			Jitter
		</metadata>
		<metadata name="tag">
			Jitter Data
		</metadata>
	</metadatalist>
	<!--INLETS-->
	<inletlist>
		<inlet id="0" type="matrix">
			<digest>
				in
			</digest>
			<description>
				TEXT_HERE
			</description>
		</inlet>
		<inlet id="1" type="matrix">
			<digest>
				in
			</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>
	<!--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="bang">
			<arglist />
			<digest>
				Send a matrix out the left outlet.
			</digest>
			<description>
				Sends a matrix out the left outlet.
			</description>
		</method>
		<method name="clear">
			<arglist />
			<digest>
				Set all values to zero
			</digest>
			<description>
				Sets all values to zero.
			</description>
		</method>
		<method name="exportmovie">
			<arglist>
				<arg name="filename" optional="1" type="symbol" />
				<arg name="FPS" type="float" />
				<arg name="codec" type="symbol" />
			</arglist>
			<digest>
				Export a matrix as a QuickTime movie
			</digest>
			<description>
				Exports a matrix as a QuickTime movie. The <m>exportmovie</m> message takes an optional argument to specify a file name. If no filename is specified, a file dialog will open to let you choose a file.
				<p>
					The default <i>FPS</i> is 30. frames per second
				</p>
				<p>
					The default <i>codec</i> is <m>h264</m>. For a list of supported codecs check the <o>jit.record</o>  <at>codec</at> attribute.
				</p>
			</description>
		</method>
		<method name="importmovie">
			<arglist>
				<arg name="filename" optional="1" type="symbol" />
				<arg name="time-offset" type="int" />
				<arg name="index-ffset" type="int" />
				<arg name="number-of-frames" type="int" />
			</arglist>
			<digest>
				Import a QuickTime movie
			</digest>
			<description>
				Imports a QuickTime movie into the matrix set. If no filename is specified, a file dialog will open to let you choose a file. The <i>time-offset</i> and <i>index-offset</i> arguments may be used to set a time and index offset for the QuickTime movie being imported (the default is 0 for both arguments). The <i>number-of-frames</i> argument specifies the number of frames to import (the default is set to the value specified by the <i>matrixcount</i> attribute). Note that the importmovie message will not resize the jit.matrixset.
			</description>
		</method>
		<method name="read">
			<arglist>
				<arg name="filename" optional="1" type="symbol" />
			</arglist>
			<digest>
				Read Jitter binary data files (.jxf)
			</digest>
			<description>
				Reads Jitter binary data files (.jxf) into a matrix set. If no filename is specified, a file dialog will open to let you choose a file.
			</description>
		</method>
		<method name="write">
			<arglist>
				<arg name="filename" optional="1" type="symbol" />
			</arglist>
			<digest>
				Write matrix set as a Jitter binary data file (.jxf)
			</digest>
			<description>
				Writes matrix set as a Jitter binary data file (.jxf). If no filename is specified, a file dialog will open to let you choose a file.
			</description>
		</method>
	</methodlist>
	<jittermethodlist>
		<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="dim" get="1" set="1" type="int" size="32">
			<digest>
				Matrix dimensions
			</digest>
			<description>
				The dimensions of matrix data (default = 1 1)
			</description>
		</attribute>
		<attribute name="dstdimend" get="1" set="1" type="int" size="32">
			<digest>
				Destination dimension end position
			</digest>
			<description>
				The destination dimension end position (default = all <at>dim</at> values minus 1)
			</description>
		</attribute>
		<attribute name="dstdimstart" get="1" set="1" type="int" size="32">
			<digest>
				Destination dimension start position
			</digest>
			<description>
				The source dimension start position (default = all 0)
			</description>
		</attribute>
		<attribute name="index" get="1" set="1" type="int" size="1">
			<digest>
				Matrix to be written to
			</digest>
			<description>
				The which of the matrices an incoming matrix will be written to (default = 0)
			</description>
		</attribute>
		<attribute name="interp" get="1" set="1" type="int" size="1">
			<digest>
				Interpolation flag
			</digest>
			<description>
				Interpolation flag (default = 0) When the flag is set, an input matrix is interpolated when copied to internal matrices.
			</description>
		</attribute>
		<attribute name="matrixcount" get="1" set="1" type="int" size="1">
			<digest>
				Number of matrices in the matrix set
			</digest>
			<description>
				The number of matrices in the matrix set (default = 1)
			</description>
		</attribute>
		<attribute name="planecount" get="1" set="1" type="int" size="1">
			<digest>
				Number of planes in matrix data
			</digest>
			<description>
				The number of planes in matrix data (default = 4)
			</description>
		</attribute>
		<attribute name="planemap" get="1" set="1" type="int" size="32">
			<digest>
				Plane mapping
			</digest>
			<description>
				Maps input planes to output planes (default = 0 1 2 3 ...)
			</description>
		</attribute>
		<attribute name="thru" get="1" set="1" type="int" size="1">
			<digest>
				Thru mode flag
			</digest>
			<description>
				Thru mode flag (default = 1) When the flag is set, a matrix is output when another one is received.
			</description>
		</attribute>
		<attribute name="type" get="1" set="1" type="symbol" size="1">
			<digest>
				Matrix data type
			</digest>
			<description>
				The type of matrix data (default = <m>char</m>) Supported data types are <m>char</m>, <m>long</m>, <m>float32</m>, or <m>float64</m>.
			</description>
		</attribute>
		<attribute name="srcdimend" get="1" set="1" type="int" size="32">
			<digest>
				Source dimension end position
			</digest>
			<description>
				The source dimension end position (default = all <at>dim</at> values minus 1)
			</description>
		</attribute>
		<attribute name="srcdimstart" get="1" set="1" type="int" size="32">
			<digest>
				Source dimension start position
			</digest>
			<description>
				The source dimension start position (default = all 0)
			</description>
		</attribute>
		<attribute name="usedstdim" get="1" set="1" type="int" size="1">
			<digest>
				Destdim use flag
			</digest>
			<description>
				Destdim use flag (default = 0) When the flag is set, the destination dimension's attributes are used when copying an input matrix to an internal matrix.
			</description>
		</attribute>
		<attribute name="usesrcdim" get="1" set="1" type="int" size="1">
			<digest>
				Srcdim use flag
			</digest>
			<description>
				Srcdim use flag (default = 0) When the flag is set, the source dimension's attributes are used when copying an input matrix to an internal matrix.
			</description>
		</attribute>
	</attributelist>
	<jitterattributelist />
	<!--EXAMPLE-->
	<examplelist>
		<example img="jit.matrixset.png" />
	</examplelist>
	<!--SEEALSO-->
	<seealsolist>
		<seealso name="jit.matrix" />
		<seealso module="jit" name="jitterchapter20" type="tutorial" />
	</seealsolist>
</c74object>
