summaryrefslogtreecommitdiff
path: root/opcodes/ftlptim.xml
blob: 7f7b3cb6dec8b02e27ee1a00fa0180eefe33d5e2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
<refentry id="ftlptim">
<indexterm id="IndexFtlptim"><primary>ftlptim</primary></indexterm>
  <refentryinfo><title>Table Control:Table Queries</title></refentryinfo>
  <refmeta>
    <refentrytitle>ftlptim</refentrytitle>
  </refmeta>


 
  <refnamediv>
    <refname>ftlptim</refname>
    <refpurpose>
      Returns the loop segment start-time of a stored function table number.
          </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 file <ulink url="examples/ftlptim.csd"><citetitle>ftlptim.csd</citetitle></ulink>, and <ulink url="examples/mary.wav"><citetitle>mary.wav</citetitle></ulink>.

      <example>
        <title>Example of the ftlptim 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/ftlptim.csd.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
      </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>