summaryrefslogtreecommitdiff
path: root/opcodes/delayr.xml
blob: b9cf48a95b7b590ea0acaca8ecbb12fc4d362132 (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
<refentry id="delayr">
<indexterm id="IndexDelayr"><primary>delayr</primary></indexterm>
  <refentryinfo><title>Signal Modifiers:Delay</title></refentryinfo>
  <refmeta>
    <refentrytitle>delayr</refentrytitle>
  </refmeta>


 
  <refnamediv>
    <refname>delayr</refname>
    <refpurpose>
      Reads from an automatically established digital delay line.
          </refpurpose>
  </refnamediv>
 
  <refsect1>
    <title>Description</title>
    <para>
      Reads from an automatically established digital delay line.
   </para>
  </refsect1>
 
  <refsect1>
    <title>Syntax</title>
    <synopsis>ares <command>delayr</command> idlt [, iskip]</synopsis>
  </refsect1>
 
  <refsect1>
    <title>Initialization</title>
    <para>
      <emphasis>idlt</emphasis> -- requested delay time in seconds. This can be as large as available memory will permit. The space required for n seconds of delay is 4n * <emphasis>sr</emphasis> bytes. It is allocated at the time the instrument is first initialized, and returned to the pool at the end of a score section.
    </para>

    <para>
      <emphasis>iskip</emphasis> (optional, default=0) -- initial disposition of delay-loop data space (see <link linkend="reson"><citetitle>reson</citetitle></link>). The default value is 0.
    </para>
  </refsect1>
 
  <refsect1>
    <title>Performance</title>
    <para>
      <emphasis>delayr</emphasis> reads from an automatically established digital delay line, in which the signal retrieved has been resident for <emphasis>idlt</emphasis> seconds. This unit must be paired with and precede an accompanying <link linkend="delayw"><citetitle>delayw</citetitle></link> unit. Any other Csound statements can intervene.
    </para>
  </refsect1>

  <refsect1>
    <title>Examples</title>
    <para>
      See the example for <link linkend="delayw"><citetitle>delayw</citetitle></link>.
    </para>
  </refsect1>

  <refsect1>
    <title>See Also</title>
    <para>
      <link linkend="delay"><citetitle>delay</citetitle></link>,
      <link linkend="delay1"><citetitle>delay1</citetitle></link>,
      <link linkend="delayw"><citetitle>delayw</citetitle></link>
    </para>
  </refsect1>
</refentry>