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



  <refnamediv>
    <refname>k</refname>

    <refpurpose>
      Converts a i-rate parameter to an k-rate value.
      Or converts an a-rate value to a k-rate value by down-sampling.
    </refpurpose>
  </refnamediv>

  <refsect1>
    <title>Description</title>
    <para>
    	Converts an i-rate value to control rate, for example to be used
    	with <link linkend="rnd"><citetitle>rnd()</citetitle></link> and
      <link linkend="birnd"><citetitle>birnd()</citetitle></link> to generate random numbers at k-rate.
    </para>
  </refsect1>

  <refsect1>
    <title>Syntax</title>
    <synopsis><command>k</command>(x) (i-rate args only)</synopsis>
    <synopsis><command>k</command>(x) (a-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>See Also</title>
    <para>
      <link linkend="opi"><citetitle>i</citetitle></link>
      <link linkend="opa"><citetitle>a</citetitle></link>
    </para>
            <para> More information on this opcode: <ulink url="http://www.csounds.com/journal/issue10/CsoundRates.html"><citetitle>http://www.csounds.com/journal/issue10/CsoundRates.html</citetitle></ulink>  , written by Andrés Cabrera </para>
  </refsect1>

  <refsect1>
    <title>Credits</title>
    <para>Author: &nameistvan;</para>
    <para>New in version Csound 5.00</para>
    <para>Author: &namejohn;</para>
    <para>arate to krate new in version Csound 6.00</para>

  </refsect1>
</refentry>