alwayson.xml

<refentry id="alwayson">
<indexterm id="Indexalwayson"><primary>alwayson</primary></indexterm>
  <refentryinfo><title>Signal Flow Graph Opcodes</title></refentryinfo>
  <refmeta>
    <refentrytitle>alwayson</refentrytitle>
  </refmeta>

  <refnamediv>
    <refname>alwayson</refname>
    <refpurpose>
      Activates the indicated instrument in the orchestra header,
      without need for an i statement.     
    </refpurpose>
  </refnamediv>
 
  <refsect1>
    <title>Description</title>
    <para>Plugin opcode in signalflowgraph</para>
    <para>
      Activates the indicated instrument in the orchestra header,
      without need for an i statement. Instruments must be 
      activated in the same order as they are defined.
    </para>
      
    <para>
      The alwayson opcode is designed to simplify 
      the definition of re-usable orchestras with 
      signal processing or effects chains and networks.
    </para>
  </refsect1>

  <refsect1>
    <title>Syntax</title>
    <synopsis> <command>alwayson</command> Tinstrument [p4, ..., pn]</synopsis>
  </refsect1>
  <refsect1>
    <title>Initialization</title>
    <para>
      <emphasis>Tinstrument</emphasis> -- String name of the instrument definition to be turned on.
    </para>
    <para>
      <emphasis>[p4, ..., pn]</emphasis> -- Optional pfields to be passed to the instrument, in the same
      order and type as if this were an i statement.
    </para>
    <para>
      When the instrument is activated, p1 is the insno, p2 is 0, and p3 is -1.
      Pfields from p4 on may optionally be sent to the instrument.
    </para>
  </refsect1>
 
 <refsect1>
    <title>Examples</title>
    <para>
      Here is an example of the alwayson opcode. It uses the file <ulink url="examples/alwayson.csd"><citetitle>alwayson.csd</citetitle></ulink>.

      <example>
        <title>Example of the alwayson opcode.</title>

        

          <xi:include href="examples-xml/alwayson.csd.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
      </example>
    </para>
  </refsect1>
 
  <refsect1>
<!--  And put your name and other relevant information here-->
    <title>Credits</title>
    <para>By: &namemichael; 2009</para>
  </refsect1>

<!--Now remember to add a link from the appropriate category in the Opcode Overview.-->
<!--Add the entity to manual.xml-->
<!--Add the entity reference in the appropriate place in opcodes/top.xml-->
<!--And you're set! Maybe delete the comments as well...-->

</refentry>