summaryrefslogtreecommitdiff
path: root/opcodes/outrg.xml
blob: 901b60b2405ba89c4870d3f0038ddd5f6b1c3005 (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="outrg">
<indexterm id="IndexOutrg"><primary>outrg</primary></indexterm>
  <refentryinfo><title>Signal I/O:Signal Output</title></refentryinfo>
  <refmeta>
    <refentrytitle>outrg</refentrytitle>
  </refmeta>

  <refnamediv>
    <refname>outrg</refname>
    <refpurpose>
      Allow output to a range of adjacent audio channels on the audio output device
    </refpurpose>
  </refnamediv>

  <refsect1>
    <title>Description</title>
    <para>
      <emphasis>outrg</emphasis> outputs audio to a range of adjacent audio channels on the audio output device.
    </para>
  </refsect1>

  <refsect1>
    <title>Syntax</title>
    <synopsis><command>outrg</command> kstart, aout1 [,aout2, aout3, ..., aoutN]</synopsis>
  </refsect1>

<!--  <refsect1>
    <title>Initialization</title>
    <para>
    </para>
  </refsect1>-->

  <refsect1>
    <title>Performance</title> 


    <para>
      <emphasis>kstart</emphasis> - the number of the first channel of the output device to be accessed (channel numbers starts with 1, which is the first channel)
    </para>
    <para>
      <emphasis>aout1, aout2, ... aoutN</emphasis> - the arguments containing the audio to be output to the corresponding output channels.
    </para>
    <para>
      <emphasis>outrg</emphasis> allows to output a range of adjacent channels to the output device. <emphasis>kstart</emphasis> indicates the first channel to be accessed (channel 1 is the first channel). The user must be sure that the number obtained by summing kstart plus the number of accessed channels -1 is &lt;= <link linkend="nchnls"><citetitle>nchnls</citetitle></link>.
    </para>
  </refsect1>
<!--
  <refsect1>
    <title>Examples</title>
    <para>
      Here is an example of the outrg opcode. It uses the file <ulink url="examples/outrg.csd"><citetitle>outrg.csd</citetitle></ulink>.

      <example>
        <title>Example of the outrg 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/outrg.csd.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
      </example>
    </para>
  </refsect1>-->
<!--  <refsect1>
    <title>See Also</title>
    <para>
      <link linkend="lposcil"><citetitle>lposcil</citetitle></link>,
      <link linkend="lposcila"><citetitle>lposcila</citetitle></link>,
      <link linkend="outrg2"><citetitle>outrg2</citetitle></link>
    </para>
  </refsect1>-->

  <refsect1>
    <title>Credits</title>
    <para>Author: &namegabriel;</para>
    <para>New in version 5.06</para>
  </refsect1>
</refentry>