summaryrefslogtreecommitdiff
path: root/opcodes/opa.xml
blob: bb77762167ccb1fecd9cd42850113ef1be7051cd (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
<refentry id="opa">
<indexterm id="IndexA"><primary>a</primary></indexterm>
  <refentryinfo><title>Signal Modifiers:Sample Level Operators</title></refentryinfo>
  <refmeta>
    <refentrytitle>a</refentrytitle>
  </refmeta>



  <refnamediv>
    <refname>a</refname>

    <refpurpose>
      Converts a k-rate parameter to an a-rate value with interpolation.
          </refpurpose>
  </refnamediv>

  <refsect1>
    <title>Description</title>
    <para>
      Converts a k-rate parameter to an a-rate value with interpolation.
    </para>
  </refsect1>

  <refsect1>
    <title>Syntax</title>
    <synopsis><command>a</command>(x) (control-rate args only)</synopsis>

    <para>
      where the argument within the parentheses may be an expression. Value converters perform arithmetic translation from units of one kind to units of another. The result can then be a term in a further expression.
    </para>
  </refsect1>

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

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

  <refsect1>
    <title>See Also</title>
    <para>
      <link linkend="opi"><citetitle>i</citetitle></link>,
      <link linkend="opk"><citetitle>k</citetitle></link>
    </para>
  </refsect1>

  <refsect1>
    <title>Credits</title>
    <para>Author: &namegabriel;</para>
    <para>Example written by &namekevin;.</para>
    <para>New in version 4.21</para>
  </refsect1>
</refentry>