ampmidi.xml


<refentry id="ampmidi">
<indexterm id="IndexAmpmidi"><primary>ampmidi</primary></indexterm>
  <refentryinfo><title>Real-time MIDI:Converters</title></refentryinfo>
  <refmeta>
    <refentrytitle>ampmidi</refentrytitle>
  </refmeta>


 
  <refnamediv>
    <refname>ampmidi</refname>

    <refpurpose>
      Get the velocity of the current MIDI event.
          </refpurpose>
  </refnamediv>
 
  <refsect1>
    <title>Description</title>
    <para>
      Get the velocity of the current MIDI event.
    </para>
  </refsect1>
 
  <refsect1>
    <title>Syntax</title>
    <synopsis>iamp <command>ampmidi</command> iscal [, ifn]</synopsis>
  </refsect1>
 
  <refsect1>
    <title>Initialization</title>
    <para>
      <emphasis>iscal</emphasis> -- i-time scaling factor
    </para>

    <para>
      <emphasis>ifn</emphasis> (optional, default=0) -- function table number of a normalized translation table, by which the incoming value is first interpreted. The default value is 0, denoting no translation.
    </para>
  </refsect1>
 
  <refsect1>
    <title>Performance</title>
    <para>
      Get the velocity of the current MIDI event, optionally pass it through a normalized translation table, and return an amplitude value in the range 0 - <emphasis>iscal</emphasis>.
    </para>
  </refsect1>

  <refsect1>
    <title>Examples</title>
    <para>
      Here is an example of the ampmidi opcode. It uses the file <ulink url="examples/ampmidi.csd"><citetitle>ampmidi.csd</citetitle></ulink>.

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

        

        <para>See the sections <link linkend="UsingRealTime"><citetitle>Real-time Audio</citetitle></link> and <link linkend="CommandFlags"><citetitle>Command Line Flags</citetitle></link> for more information on using command line flags.</para>
          <xi:include href="examples-xml/ampmidi.csd.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
      </example>
    </para>
  </refsect1>
 
  <refsect1>
    <title>See Also</title>
    <para>
      <link linkend="aftouch"><citetitle>aftouch</citetitle></link>,
      <link linkend="cpsmidi"><citetitle>cpsmidi</citetitle></link>,
      <link linkend="cpsmidib"><citetitle>cpsmidib</citetitle></link>,
      <link linkend="midictrl"><citetitle>midictrl</citetitle></link>,
      <link linkend="notnum"><citetitle>notnum</citetitle></link>,
      <link linkend="octmidi"><citetitle>octmidi</citetitle></link>,
      <link linkend="octmidib"><citetitle>octmidib</citetitle></link>,
      <link linkend="pchbend"><citetitle>pchbend</citetitle></link>,
      <link linkend="pchmidi"><citetitle>pchmidi</citetitle></link>,
      <link linkend="pchmidib"><citetitle>pchmidib</citetitle></link>,
      <link linkend="veloc"><citetitle>veloc</citetitle></link>
    </para>
  </refsect1>
 
  <refsect1>
    <title>Credits</title>
    <para>
      <simplelist>
        <member>Author: &namebarry; - &namemike;</member>
        <member>MIT - Mills</member>
        <member>May 1997</member>
      </simplelist>
    </para>
  </refsect1>
</refentry>