<!-- Converted to DocBook/SGML by Kevin Conder -->
<refentry id="ftlptim">
  <refmeta>
    <refentrytitle>ftlptim</refentrytitle>
  </refmeta>
 
  <refnamediv>
    <refname>ftlptim</refname>
    <refpurpose>
      Returns the loop segment start-time of a stored function table number.
      <indexterm id="IndexFtlptim"><primary>ftlptim</primary></indexterm>
    </refpurpose>
  </refnamediv>
 
  <refsect1>
    <title>Description</title>
    <para>
      Returns the loop segment start-time of a stored function table number.
    </para>
  </refsect1>
 
  <refsect1>
    <title>Syntax</title>
    <synopsis><command>ftlptim</command>(x) (init-rate args only)</synopsis>
  </refsect1>
 
  <refsect1>
    <title>Performance</title>
    <para>
      Returns the loop segment start-time (in seconds) of stored function table number <emphasis>x</emphasis>. This reports the duration of the direct recorded attack and decay parts of a sound sample, prior to its looped segment. Returns zero (and a warning message) if the sample does not contain loop points.
    </para>
  </refsect1>

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

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

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

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

      Since the audio file <quote>mary.wav</quote> is non-looping, its output should include lines like this:
      <screen>
WARNING: non-looping sample
instr 1:  itim = 0.000
      </screen>
    </para>
  </refsect1>

  <refsect1>
    <title>See Also</title>
    <para>
      <link linkend="ftchnls"><citetitle>ftchnls</citetitle></link>,
      <link linkend="ftlen"><citetitle>ftlen</citetitle></link>,
      <link linkend="ftsr"><citetitle>ftsr</citetitle></link>,
      <link linkend="nsamp"><citetitle>nsamp</citetitle></link>
    </para>
  </refsect1>
 
  <refsect1>
    <title>Credits</title>
    <para>
      <simplelist>
        <member>Author: &namebarry;</member>
        <member>MIT</member>
        <member>Cambridge, Massachussetts</member>
        <member>1997</member>
      </simplelist>
    </para>
    <para>Example written by &namekevin;.</para>
  </refsect1>
</refentry>
