opcodes/outvalue.xml


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

<refentry id="outvalue">
<indexterm id="IndexOutvalue"><primary>outvalue</primary></indexterm>
  <refentryinfo><title>Signal I/O:Signal Output</title></refentryinfo>
  <refmeta>
    <refentrytitle>outvalue</refentrytitle>
  </refmeta>


  <refnamediv>
    <refname>outvalue</refname>
    <refpurpose>
      Sends a k-rate signal or string to a user-defined channel.
          </refpurpose>
  </refnamediv>
  
  <refsect1>
    <title>Description</title>
    <para>
      Sends a k-rate signal or string to a user-defined channel.
    </para>
  </refsect1>

  <refsect1>
    <title>Syntax</title>
    <synopsis><command>outvalue</command> &quot;channel name&quot;, kvalue</synopsis>
    <synopsis><command>outvalue</command> &quot;channel name&quot;, &quot;string&quot;</synopsis>
  </refsect1>

  <refsect1>
    <title>Performance</title>
    <para>
      <emphasis>&quot;channel name&quot;</emphasis> -- An integer or string (in double-quotes) representing channel.
    </para>
    <para>
      <emphasis>kvalue</emphasis> -- The k-rate value that is sent to the channel.
    </para>
    <para>
      <emphasis>string</emphasis> -- The string or string variable that is sent to the channel.
    </para>
  </refsect1>
 
  <refsect1>
    <title>Examples</title>
    <para>
      Here is an example of the outvalue opcode. It uses the file <ulink url="examples/outvalue.csd"><citetitle>outvalue.csd</citetitle></ulink>.
      <example>
        <title>Example of the outvalue 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/outvalue.csd.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
      </example>
    </para>
  </refsect1>

  <refsect1>
    <title>See Also</title>
    <para>
      <link linkend="invalue"><citetitle>invalue</citetitle></link>
    </para>
  </refsect1>

  <refsect1>
    <title>Credits</title>
    <para>
      <simplelist>
        <member>Author: Matt Ingalls</member>
      </simplelist>
    </para>
  </refsect1>
</refentry>