<!-- Converted to DocBook/SGML by Kevin Conder -->
<refentry id="mute">
  <refmeta>
    <refentrytitle>mute</refentrytitle>
  </refmeta>

  <refnamediv>
    <refname>mute</refname>
    <refpurpose>
      Mutes/unmutes new instances of a given instrument.
      <indexterm id="IndexMute"><primary>mute</primary></indexterm>
    </refpurpose>
  </refnamediv>
  
  <refsect1>
    <title>Description</title>
    <para>
      Mutes/unmutes new instances of a given instrument.
    </para>
  </refsect1>

  <refsect1>
    <title>Syntax</title>
    <synopsis><command>mute</command> insnum [, iswitch]</synopsis>
    <synopsis><command>mute</command> &quot;insname&quot; [, iswitch]</synopsis>
  </refsect1>

  <refsect1>
    <title>Initialization</title>
    <para>
      <emphasis>insnum</emphasis> -- instrument number. Equivalent to <emphasis>p1</emphasis> in a score <link linkend="i"><citetitle>i statement</citetitle></link>.
    </para>

    <para>
      <emphasis><quote>insname</quote></emphasis> -- A string (in double-quotes) representing a named instrument.
    </para>

    <para>
      <emphasis>iswitch</emphasis> (optional, default=0) -- represents a switch to mute/unmute an instrument. A value of 0 will mute new instances of an instrument, other values will unmute them. The default value is 0.
    </para>
  </refsect1>

  <refsect1>
    <title>Performance</title>
    <para>
      All new instances of instrument inst will me muted (iswitch = 0) or unmuted (iswitch not equal to 0). There is no difficulty with muting muted instruments or unmuting unmuted instruments. The mechanism is the same as used by the score <link linkend="q"><citetitle>q statement</citetitle></link>. For example, it is possible to mute in the score and unmute in some instrument.
    </para>

    <para>
      Muting/Unmuting is indicated by a message (depending on message level).
    </para>
  </refsect1>

  <refsect1>
    <title>Examples</title>
    <para>
      Here is an example of the mute opcode. It uses the files <ulink url="examples/mute.orc"><citetitle>mute.orc</citetitle></ulink> and <ulink url="examples/mute.sco"><citetitle>mute.sco</citetitle></ulink>.

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

        <programlisting>
<inlinemediaobject>
            <imageobject>
              <imagedata fileref="examples/mute.orc" format="linespecific">
            </imageobject>
          </inlinemediaobject>
        </programlisting>

        <programlisting>
<inlinemediaobject>
            <imageobject>
              <imagedata fileref="examples/mute.sco" format="linespecific">
            </imageobject>
          </inlinemediaobject>
        </programlisting>
      </example>
    </para>
  </refsect1>

  <refsect1>
    <title>Credits</title>
    <para>Example written by &namekevin;.</para>
    <para>New in version 4.22</para>
  </refsect1>
</refentry>
