summaryrefslogtreecommitdiff
path: root/opcodes/pchbend.xml
blob: 720b42614f1c83ca78db1fde98725bd9128c0fa0 (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
90
91
<refentry id="pchbend">
<indexterm id="IndexPchbend"><primary>pchbend</primary></indexterm>
  <refentryinfo><title>Real-time MIDI:Input</title></refentryinfo>
  <refmeta>
    <refentrytitle>pchbend</refentrytitle>
  </refmeta>


 
  <refnamediv>
    <refname>pchbend</refname>

    <refpurpose>
      Get the current pitch-bend value for this channel.
          </refpurpose>
  </refnamediv>
 
  <refsect1>
    <title>Description</title>
    <para>
      Get the current pitch-bend value for this channel.
    </para>
  </refsect1>
 
  <refsect1>
    <title>Syntax</title>
    <synopsis>ibend <command>pchbend</command> [imin] [, imax]</synopsis>

    <synopsis>kbend <command>pchbend</command> [imin] [, imax]</synopsis>
  </refsect1>
 
  <refsect1>
    <title>Initialization</title>
    <para>
      <emphasis>imin, imax</emphasis> (optional) -- set minimum and maximum limits on values obtained
    </para>
  </refsect1>
 
  <refsect1>
    <title>Performance</title>
    <para>
      Get the current pitch-bend value for this channel. Note that this access to pitch-bend data is independent of the MIDI pitch, enabling the value here to be used for any arbitrary purpose.
    </para>
  </refsect1>

  <refsect1>
    <title>Examples</title>
    <para>
      Here is an example of the pchbend opcode. It uses the file <ulink url="examples/pchbend.csd"><citetitle>pchbend.csd</citetitle></ulink>.

      <example>
        <title>Example of the pchbend 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/pchbend.csd.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
      </example>
    </para>
  </refsect1>

  <refsect1>
    <title>See Also</title>
    <para>
      <link linkend="aftouch"><citetitle>aftouch</citetitle></link>,
      <link linkend="ampmidi"><citetitle>ampmidi</citetitle></link>,
      <link linkend="cpsmidi"><citetitle>cpsmidi</citetitle></link>,
      <link linkend="cpsmidib"><citetitle>cpsmidib</citetitle></link>,
      <link linkend="midictrl"><citetitle>midictrl</citetitle></link>,
      <link linkend="notnum"><citetitle>notnum</citetitle></link>,
      <link linkend="octmidi"><citetitle>octmidi</citetitle></link>,
      <link linkend="octmidib"><citetitle>octmidib</citetitle></link>,
      <link linkend="pchmidi"><citetitle>pchmidi</citetitle></link>,
      <link linkend="pchmidib"><citetitle>pchmidib</citetitle></link>,
      <link linkend="veloc"><citetitle>veloc</citetitle></link>
    </para>
  </refsect1>
 
  <refsect1>
    <title>Credits</title>
    <para>
      <simplelist>
        <member>Author: &namebarry; - &namemike;</member>
        <member>MIT - Mills</member>
        <member>May 1997</member>
      </simplelist>
    </para>
    <para>Example written by &namekevin;.</para>
  </refsect1>
</refentry>