<?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="live.banks" module="" category="">
	<digest>
		Manage Max for Live Device banks for Push controllers.
	</digest>
	<description>
		Create, edit and delete Max for Live Device parameter banks, as displayed on Ableton's Push controllers. Banks are saved with the device, but can be modified in real-time to cause updates on the Push display. For instance, you might want to reveal or hide particular parameters within a bank depending on device state.
	</description>
	<!--METADATA-->
	<metadatalist>
		<metadata name="author">
			Cycling '74
		</metadata>
		<metadata name="tag">
			Live
		</metadata>
	</metadatalist>
	<!--INLETS-->
	<inletlist>
		<inlet id="0" type="INLET_TYPE">
			<digest>
				Message in
			</digest>
			<description>
				TEXT_HERE
			</description>
		</inlet>
		<inlet id="1" type="INLET_TYPE">
			<digest>
				Message in
			</digest>
			<description>
				TEXT_HERE
			</description>
		</inlet>
	</inletlist>
	<!--OUTLETS-->
	<outletlist>
		<outlet id="0" type="OUTLET_TYPE">
			<digest>
				Color in RGBA Format
			</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="edit">
			<arglist>
				<arg name="bank_id" type="int" optional="0" />
				<arg name="bank_name" type="symbol" optional="0" />
				<arg name="bank_parameters" type="list" optional="1" />
			</arglist>
			<digest>
				Edit an existing bank.
			</digest>
			<description>
				Edit a parameter bank, specified by <i>bank_id</i> (0-indexed). To change the bank name, pass a new name as <i>bank_name</i>, or pass <m>-</m> (minus) to use the existing name. The optional list of parameters should be a list of index/name pairs in the form <i>parameter_index</i>  <i>parameter_name</i>. For instance, <m>edit 0 newname 0 foo 2 bar 4 - 5 bap</m>, would change the name of bank 0 to <i>newname</i> and modify parameter slot 0 to use the parameter <i>foo</i>, slot 2 to use the parameter <i>bar</i>, eliminate the parameter in slot 4, and assign slot 5 to the parameter named <i>bap</i>.
			</description>
		</method>
		<method name="(mouse)">
			<digest>
				Double-click to open the Parameter Banks window.
			</digest>
			<description>
				Double-click to open the Parameter Banks window. Only available in the editor, this feature is disabled inside of Live.
			</description>
		</method>
		<method name="delete">
			<arglist>
				<arg name="bank_id" type="int" optional="0" />
			</arglist>
			<digest>
				Delete an existing bank.
			</digest>
			<description>
				Delete a parameter bank. Deleting a bank will decrement the index of the banks with higher indices.
			</description>
		</method>
		<method name="getcount">
			<arglist />
			<digest>
				Report the current number of banks.
			</digest>
			<description>
				Sends the <m>count</m> message from the outlet, followed by the number of banks.
			</description>
		</method>
		<method name="getname">
			<arglist>
				<arg name="bank_id" type="int" optional="0" />
			</arglist>
			<digest>
				Report the name of a bank.
			</digest>
			<description>
				Sends the <m>name</m> message from the outlet, followed by the index (int) and name (symbol) of the specified bank.
			</description>
		</method>
		<method name="getparameters">
			<arglist>
				<arg name="bank_id" type="int" optional="0" />
			</arglist>
			<digest>
				Report the parameters in a bank.
			</digest>
			<description>
				Sends the <m>parameters</m> message from the outlet, followed by the index (int) of and a list of parameter names (symbol) in the specified bank.
			</description>
		</method>
		<method name="new">
			<arglist>
				<arg name="bank_id" type="int" optional="0" />
				<arg name="bank_name" type="symbol" optional="0" />
				<arg name="bank_parameters" type="list" optional="1" />
			</arglist>
			<digest>
				Create a parameter bank.
			</digest>
			<description>
				Create a bank at the index specified by <i>bank_id</i> (0-indexed). If a bank already exists at that index, the new bank will be inserted at the specified index and all higher-indexed banks will have their indices incremented. The bank requires a name, specified by <i>bank_name</i>. The list of parameters should be a list of up to 8 symbols, specifying the parameter name for bank slots 0-7. A <m>-</m> (minus) can be used to indicate that a slot should have no parameter associated with it. Note: when creating banks, it is possible to specify indices higher than the bank count. That is, one could start with an empty set of banks and create bank 3 first. In that case, dummy banks will be created in slots 0, 1 and 2. Dummy banks are displayed with grey text in the Parameter Banks window. Editing a dummy bank will cause it to become a 'real' bank. Creating a new bank at the index occupied by a dummy bank will replace the dummy bank in-place, rather than performing an insert.
			</description>
		</method>
	</methodlist>
	<!--ATTRIBUTES-->
	<!--EXAMPLE-->
	<examplelist>
		<example img="live.banks.png" />
	</examplelist>
	<!--SEEALSO-->
	<seealsolist>
		<seealso name="live.colors" />
	</seealsolist>
</c74object>
