summaryrefslogtreecommitdiff
path: root/opcodes/mclock.xml
blob: 5f71e95fe9e080ac827741279fef776d7ad00ad9 (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
<refentry id="mclock">
<indexterm id="IndexMclock"><primary>mclock</primary></indexterm>
  <refentryinfo><title>Real-time MIDI:System Realtime</title></refentryinfo>
  <refmeta>
    <refentrytitle>mclock</refentrytitle>
  </refmeta>


 
  <refnamediv>
    <refname>mclock</refname>

    <refpurpose>
      Sends a MIDI CLOCK message.
          </refpurpose>
  </refnamediv>
 
  <refsect1>
    <title>Description</title>
    <para>
      Sends a MIDI CLOCK message.
    </para>
  </refsect1>
 
  <refsect1>
    <title>Syntax</title>
    <synopsis><command>mclock</command> ifreq</synopsis>
  </refsect1>
 
  <refsect1>
    <title>Initialization</title>
    <para>
      <emphasis>ifreq</emphasis> -- clock message frequency rate in Hz
    </para>
  </refsect1>
 
  <refsect1>
    <title>Performance</title>
    <para>
      Sends a MIDI CLOCK message (0xF8) every 1/<emphasis>ifreq</emphasis> seconds. So <emphasis>ifreq</emphasis> is the frequency rate of CLOCK message in Hz.
    </para>
  </refsect1>

  <refsect1>
    <title>See Also</title>
    <para>
      <link linkend="mrtmsg"><citetitle>mrtmsg</citetitle></link>
    </para>
  </refsect1>
 
  <refsect1>
    <title>Examples</title>
    <para>
      Here is an example of the mclock opcode. It uses the file <ulink url="examples/mclock.csd"><citetitle>mclock.csd</citetitle></ulink>.
      <example>
        <title>Example of the mclock 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/mclock.csd.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
      </example>
    </para>
  </refsect1>

  <refsect1>
    <title>Credits</title>
    <para>
      <simplelist>
        <member>Author: &namegabriel;</member>
        <member>Italy</member>
      </simplelist>
    </para>

    <para>New in Csound version 3.47</para>
  </refsect1>
</refentry>