<!-- Converted to DocBook/SGML by Kevin Conder -->
<refentry id="zkmod">
  <refmeta>
    <refentrytitle>zkmod</refentrytitle>
  </refmeta>
 
  <refnamediv>
    <refname>zkmod</refname>
    <refpurpose>
      Facilitates the modulation of one signal by another.
      <indexterm id="IndexZkmod"><primary>zkmod</primary></indexterm>
    </refpurpose>
  </refnamediv>
 
  <refsect1>
    <title>Description</title>
    <para>
      Facilitates the modulation of one signal by another.
    </para>
  </refsect1>
 
  <refsect1>
    <title>Syntax</title>
    <synopsis>kr <command>zkmod</command> ksig, kzkmod</synopsis>
  </refsect1>
 
  <refsect1>
    <title>Performance</title>
    <para>
      <emphasis>ksig</emphasis> -- the input signal
    </para>

    <para>
      <emphasis>kzkmod</emphasis> -- controls which zk variable is used for modulation. A positive value means additive modulation, a negative value means multiplicative modulation. A value of 0 means no change to <emphasis>ksig</emphasis>. <emphasis>kzkmod</emphasis> can be i-rate or k-rate
    </para>

    <para>
      <emphasis>zkmod</emphasis> facilitates the modulation of one signal by another, where the modulating signal comes from a zk variable. Either additive or mulitiplicative modulation can be specified.
    </para>
  </refsect1>

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

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

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

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

  <refsect1>
    <title>See Also</title>
    <para>
      <link linkend="zamod"><citetitle>zamod</citetitle></link>,
      <link linkend="zkcl"><citetitle>zkcl</citetitle></link>,
      <link linkend="zkr"><citetitle>zkr</citetitle></link>,
      <link linkend="zkwm"><citetitle>zkwm</citetitle></link>,
      <link linkend="zkw"><citetitle>zkw</citetitle></link>
    </para>
  </refsect1>
 
  <refsect1>
    <title>Credits</title>
    <para>
      <simplelist>
        <member>Author: Robin Whittle</member>
        <member>Australia</member>
        <member>May 1997</member>
      </simplelist>
    </para>
    <para>Example written by &namekevin;.</para>
  </refsect1>
</refentry>
