blob: fdbb9d1c8638cd0da413f2909fcec5f76054a72b (
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
82
83
84
85
86
87
88
89
|
<refentry id="timeinsts">
<indexterm id="IndexTimeinsts"><primary>timeinsts</primary></indexterm>
<refentryinfo><title>Instrument Control:Time Reading</title></refentryinfo>
<refmeta>
<refentrytitle>timeinsts</refentrytitle>
</refmeta>
<refnamediv>
<refname>timeinsts</refname>
<refpurpose>
Read absolute time in seconds.
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>
Read absolute time, in seconds, since the start of an instance of an instrument.
</para>
</refsect1>
<refsect1>
<title>Syntax</title>
<synopsis>kres <command>timeinsts</command></synopsis>
</refsect1>
<refsect1>
<title>Performance</title>
<para>
Time in seconds is available with <emphasis>timeinsts</emphasis>. This would return 0.5 after half a second.
</para>
<para>
<emphasis>timeinsts</emphasis> produces a k-rate variable for output. There are no input parameters.
</para>
<para>
<emphasis>timeinsts</emphasis> is similar to <link linkend="times"><citetitle>times</citetitle></link> except it returns the time since the start of this instance of the instrument.
</para>
</refsect1>
<refsect1>
<title>Examples</title>
<para>
Here is an example of the timeinsts opcode. It uses the file <ulink url="examples/timeinsts.csd"><citetitle>timeinsts.csd</citetitle></ulink>.
<example>
<title>Example of the timeinsts 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/timeinsts.csd.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
</example>
Its output should include lines like this:
<screen>
k1 = 0.000227 seconds
k1 = 0.500000 seconds
k1 = 1.000000 seconds
k1 = 1.500000 seconds
k1 = 2.000000 seconds
</screen>
</para>
</refsect1>
<refsect1>
<title>See Also</title>
<para>
<link linkend="timeinstk"><citetitle>timeinstk</citetitle></link>, <link linkend="timek"><citetitle>timek</citetitle></link>, <link linkend="times"><citetitle>times</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>
|