diff options
Diffstat (limited to 'doc/classes/delay.html')
| -rw-r--r-- | doc/classes/delay.html | 270 |
1 files changed, 270 insertions, 0 deletions
diff --git a/doc/classes/delay.html b/doc/classes/delay.html new file mode 100644 index 0000000..3a5470d --- /dev/null +++ b/doc/classes/delay.html @@ -0,0 +1,270 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> +<html> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/> +<head> + <title>Melisma modules</title> + <link rel="stylesheet" href="../ldoc_fixed.css" type="text/css" /> +</head> +<body> + +<div id="container"> + +<div id="product"> + <div id="product_logo"></div> + <div id="product_name"><big><b></b></big></div> + <div id="product_description"></div> +</div> <!-- id="product" --> + + +<div id="main"> + + +<!-- Menu --> + +<div id="navigation"> +<p><a href="/melisma-modules">Back to repository</a></p> +<br/> +<h1>Melisma modules</h1> + + +<ul> + <li><a href="../index.html">Index</a></li> +</ul> + +<h2>Contents</h2> +<ul> +<li><a href="#Functions">Functions</a></li> +<li><a href="#Methods">Methods</a></li> +</ul> + + +<h2>Classes</h2> +<ul class="nowrap"> + <li><a href="../classes/buffer.html">buffer</a></li> + <li><strong>delay</strong></li> + <li><a href="../classes/gain.html">gain</a></li> + <li><a href="../classes/interp.html">interp</a></li> + <li><a href="../classes/ladspa.html">ladspa</a></li> + <li><a href="../classes/mixer.html">mixer</a></li> + <li><a href="../classes/nullsink.html">nullsink</a></li> + <li><a href="../classes/oscil.html">oscil</a></li> + <li><a href="../classes/pan.html">pan</a></li> + <li><a href="../classes/playback.html">playback</a></li> + <li><a href="../classes/sample.html">sample</a></li> + <li><a href="../classes/serial.html">serial</a></li> + <li><a href="../classes/timer.html">timer</a></li> +</ul> +<h2>Modules</h2> +<ul class="nowrap"> + <li><a href="../modules/biquad.html">biquad</a></li> + <li><a href="../modules/expression.html">expression</a></li> + <li><a href="../modules/fs.html">fs</a></li> + <li><a href="../modules/keycallback.html">keycallback</a></li> + <li><a href="../modules/udp.html">udp</a></li> +</ul> + +</div> + +<div id="content"> + +<h1>Class <code>delay</code></h1> +<p>Digital delay line.</p> +<p> + +</p> + + +<h2><a href="#Functions">Functions</a></h2> +<table class="function_list"> + <tr> + <td class="name" nowrap><a href="#delay.init">delay.init(input)</a></td> + <td class="summary">Create a delay line.</td> + </tr> +</table> +<h2><a href="#Methods">Methods</a></h2> +<table class="function_list"> + <tr> + <td class="name" nowrap><a href="#delay:delay">delay:delay(d)</a></td> + <td class="summary">Set delay.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#delay:feedback">delay:feedback(f)</a></td> + <td class="summary">Set feedback.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#delay:gain">delay:gain(g)</a></td> + <td class="summary">Set gain.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#delay:wetdrymix">delay:wetdrymix(wd)</a></td> + <td class="summary">Set wet/dry mix.</td> + </tr> +</table> + +<br/> +<br/> + + + <h2 class="section-header "><a name="Functions"></a>Functions</h2> + Methods + <dl class="function"> + <dt> + <a name = "delay.init"></a> + <strong>delay.init(input)</strong> + </dt> + <dd> + Create a delay line. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">input</span> + <span class="types"><span class="type">channel</span></span> + Input signal. + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + <span class="types"><a class="type" href="../classes/delay.html#">delay</a></span> + Newly created delay line. + </ol> + + + + +</dd> +</dl> + <h2 class="section-header "><a name="Methods"></a>Methods</h2> + + <dl class="function"> + <dt> + <a name = "delay:delay"></a> + <strong>delay:delay(d)</strong> + </dt> + <dd> + Set delay. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">d</span> + <span class="types"><span class="type">number</span></span> + delay in seconds. + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + <span class="types"><a class="type" href="../classes/delay.html#">delay</a></span> + + + + </ol> + + + + +</dd> + <dt> + <a name = "delay:feedback"></a> + <strong>delay:feedback(f)</strong> + </dt> + <dd> + Set feedback. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">f</span> + <span class="types"><span class="type">number</span></span> + Feedback. + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + <span class="types"><a class="type" href="../classes/delay.html#">delay</a></span> + + + + </ol> + + + + +</dd> + <dt> + <a name = "delay:gain"></a> + <strong>delay:gain(g)</strong> + </dt> + <dd> + Set gain. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">g</span> + <span class="types"><span class="type">number</span></span> + Gain (<strong>TODO</strong>: Use decibels). + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + <span class="types"><a class="type" href="../classes/delay.html#">delay</a></span> + + + + </ol> + + + + +</dd> + <dt> + <a name = "delay:wetdrymix"></a> + <strong>delay:wetdrymix(wd)</strong> + </dt> + <dd> + Set wet/dry mix. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">wd</span> + <span class="types"><span class="type">number</span></span> + Wet/dry mix. + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + <span class="types"><a class="type" href="../classes/delay.html#">delay</a></span> + + + + </ol> + + + + +</dd> +</dl> + + +</div> <!-- id="content" --> +</div> <!-- id="main" --> +<div id="about"> +<i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i> +<i style="float:right;">Last updated 1980-01-01 00:00:00 </i> +</div> <!-- id="about" --> +</div> <!-- id="container" --> +</body> +</html> |