<?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="capture~" module="msp" category="MSP Analysis">
	<digest>
		Store a signal to view as text
	</digest>
	<description>
		Use the <o>capture</o> object to collect signal values for signal debugging or investigation. To record signal values, use the <o>record~</o> or <o>sfrecord~</o> object.
	</description>
	<!--METADATA-->
	<metadatalist>
		<metadata name="author">
			Cycling '74
		</metadata>
		<metadata name="tag">
			MSP
		</metadata>
		<metadata name="tag">
			MSP Analysis
		</metadata>
	</metadatalist>
	<!--INLETS-->
	<inletlist>
		<inlet id="0" type="signal">
			<digest>
				(signal) Data to be Captured, write Saves File
			</digest>
			<description>
				TEXT_HERE
			</description>
		</inlet>
		<inlet id="1" type="signal">
			<digest>
				(signal) Data to be Captured, write Saves File
			</digest>
			<description>
				TEXT_HERE
			</description>
		</inlet>
	</inletlist>
	<!--OUTLETS-->
	<!--ARGUMENTS-->
	<objarglist>
		<objarg name="behavioral-flag (f)" optional="1" type="symbol">
			<digest>
				Buffer fill mode setting
			</digest>
			<description>
				If the first argument is the letter <m>f</m>, <o>capture~</o> stores the first signal samples it receives, and then ignores subsequent samples once its storage buffer is full. If the letter <m>f</m> is not present, <o>capture~</o> stores the most recent signal samples it has received, discarding earlier samples if necessary.
			</description>
		</objarg>
		<objarg name="maximum-samples" optional="1" type="int">
			<digest>
				Maximum number of samples that <o>capture~</o> holds
			</digest>
			<description>
				Limits the number of samples (and thus the length of the excerpt) that can be held by <o>capture~</o>. If no number is typed in, <o>capture~</o> stores 4096 samples. The maximum possible number of samples is limited only by the amount of memory available to the Max application. A second number argument may be typed in to set the precision (the number of digits to the right of the decimal point) with which samples will be shown in the editing window.
			</description>
		</objarg>
		<objarg name="signal-vector-indices (up to 10 ints)" optional="1" type="list">
			<digest>
				List of indices within a signal vector
			</digest>
			<description>
				A list of up to 10 indices within a signal vector. If no indices present, <o>capture~</o> records the entire vector.
			</description>
		</objarg>
	</objarglist>
	<!--MESSAGES-->
	<methodlist>
		<method name="(mouse)">
			<digest>
				Open an edit window
			</digest>
			<description>
				Double-clicking on <o>capture~</o> opens a window for viewing and editing its contents. The numbers in the editing window can be copied and pasted into a graphic <o>buffer~</o> editing window.
			</description>
		</method>
		<method name="clear">
			<arglist />
			<digest>
				Erase the contents of <o>capture~</o> 
			</digest>
			<description>
				Erases the contents of <o>capture~</o>.
			</description>
		</method>
		<method name="open">
			<arglist />
			<digest>
				Open an edit window
			</digest>
			<description>
				Causes an editing and viewing window for the <o>capture~</o> object to become visible. The window is also brought to the front.
			</description>
		</method>
		<method name="signal">
			<arglist />
			<digest>
				Store a signal portion as text for viewing, editing, or saving
			</digest>
			<description>
				An excerpt of the signal is stored as text for viewing, editing, or saving to a file. (The length of the excerpt can be specified as a typed-in argument to the object.)
			</description>
		</method>
		<method name="wclose">
			<arglist />
			<digest>
				Open the edit window
			</digest>
			<description>
				Closes the window associated with the <o>capture~</o> object.
			</description>
		</method>
		<method name="write">
			<arglist>
				<arg name="filename" optional="0" type="symbol" />
			</arglist>
			<digest>
				Saves the contents of <o>capture~</o> to a text file
			</digest>
			<description>
				Saves the contents of <o>capture~</o> into a text file. A standard file dialog is opened for naming the file. The word <m>write</m>, followed by a symbol, saves the file, using the symbol as the filename, in the same folder as the patch containing the <o>capture~</o>. If the patch has not yet been saved, the <o>capture~</o> file is saved in the same folder as the Max application.
			</description>
		</method>
	</methodlist>
	<!--ATTRIBUTES-->
	<!--EXAMPLE-->
	<examplelist>
		<example img="capture~.png" caption="Capture a portion of a signal as text, to view, save, copy and paste, etc." />
	</examplelist>
	<!--SEEALSO-->
	<seealsolist>
		<seealso name="scope~" />
		<seealso name="14_analysischapter01" module="msp" type="tutorial">
			MSP Tutorial 23: Analysis - Viewing signal data
		</seealso>
		<br />
		<br />
		<seealso name="14_analysischapter03" module="msp" type="tutorial" />
	</seealsolist>
	<misc name="Output">
		<entry name="(text)">
			<description>
				<o>capture~</o> outputs nothing and has no outlet but the signal which it captures into text can be saved to a file or copied and pasted elsewhere for editing.
			</description>
		</entry>
	</misc>
</c74object>
