summaryrefslogtreecommitdiff
path: root/opcodes/chnparams.xml
blob: 18ab46c15ac70343a7aa2dfdbf813319dd19b69e (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
<refentry id="chnparams">
<indexterm id="Indexchnparams"><primary>chnparams</primary></indexterm>
  <refentryinfo><title>Signal I/O:Software Bus</title></refentryinfo>
  <refmeta>
    <refentrytitle>chnparams</refentrytitle>
  </refmeta>



  <refnamediv>
    <refname>chnparams</refname>
    <refpurpose>
      Query parameters of a channel.
          </refpurpose>
  </refnamediv>

  <refsect1>
    <title>Description</title>
    <para>
      Query parameters of a channel (if it does not exist, all
      returned values are zero). 
    </para>
  </refsect1>

  <refsect1>
    <title>Syntax</title>
    <synopsis>itype, imode, ictltype, idflt, imin, imax <command>chnparams</command></synopsis>
  </refsect1>

  <refsect1>
    <title>Initialization</title>
    <para>
      <emphasis>itype</emphasis> -- channel data type (1: control, 2: audio,
      3: string)
    </para>
    <para>
      <emphasis>imode</emphasis> -- sum of 1 for input and 2 for output
    </para>
    <para>
      <emphasis>ictltype</emphasis> -- special parameter for control
      channel only; if not available, set to zero.
    </para>
    <para>
      <emphasis>idflt</emphasis> -- special parameter for control
      channel only; if not available, set to zero.
    </para>
    <para>
      <emphasis>imin</emphasis> -- special parameter for control
      channel only; if not available, set to zero.
    </para>
    <para>
      <emphasis>imax</emphasis> -- special parameter for control
      channel only; if not available, set to zero.      
    </para>

  </refsect1>

  <refsect1>
    <title>Performance</title>
    <para>
    </para>
  </refsect1>

  <refsect1>
    <title>Example</title>
    <para>
    </para>
  </refsect1>

  <refsect1>
    <title>Credits</title>
    <para>
      <simplelist>
        <member>Author: &nameistvan;</member>
        <member>2005</member>
      </simplelist>
    </para>
  </refsect1>
</refentry>