aboutsummaryrefslogtreecommitdiff
path: root/doc/classes/nullsink.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/nullsink.html')
-rw-r--r--doc/classes/nullsink.html188
1 files changed, 188 insertions, 0 deletions
diff --git a/doc/classes/nullsink.html b/doc/classes/nullsink.html
new file mode 100644
index 0000000..d8a611b
--- /dev/null
+++ b/doc/classes/nullsink.html
@@ -0,0 +1,188 @@
+<!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><a href="../classes/delay.html">delay</a></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><strong>nullsink</strong></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>nullsink</code></h1>
+<p>Reference otherwise disconnected nodes.</p>
+<p>
+
+
+
+<pre>
+<span class="keyword">local</span> mnullsink = <span class="global">require</span> <span class="string">'melisma.nullsink'</span>
+<span class="keyword">local</span> minterp = <span class="global">require</span> <span class="string">'melisma.interp'</span>
+<span class="keyword">local</span> mevent = <span class="global">require</span> <span class="string">'melisma.event'</span>
+
+<span class="keyword">local</span> interp = minterp.<span class="function-name">init</span>(<span class="number">0</span>)
+interp:<span class="function-name">linear</span>(<span class="number">1</span>,<span class="number">60</span>)
+
+<span class="comment">-- The output of interp is disconnected.
+</span><span class="comment">-- Need to connect it to a nullsink so we
+</span><span class="comment">-- can sample it in the event callback below.
+</span><span class="keyword">local</span> nullsink = mnullsink.<span class="function-name">init</span>()
+nullsink:<span class="function-name">ref</span>(interp)
+
+mevent.<span class="function-name">schedule</span>(<span class="number">30</span>, <span class="keyword">function</span>()
+ <span class="global">print</span>(<span class="string">'current value:'</span>, interp:<span class="function-name">sample</span>())
+<span class="keyword">end</span>)
+</pre>
+
+</p>
+
+
+<h2><a href="#Functions">Functions</a></h2>
+<table class="function_list">
+ <tr>
+ <td class="name" nowrap><a href="#nullsink.init">nullsink.init()</a></td>
+ <td class="summary">Create a nullsink.</td>
+ </tr>
+</table>
+<h2><a href="#Methods">Methods</a></h2>
+<table class="function_list">
+ <tr>
+ <td class="name" nowrap><a href="#nullsink:ref">nullsink:ref(input)</a></td>
+ <td class="summary">Connect an input signal.</td>
+ </tr>
+</table>
+
+<br/>
+<br/>
+
+
+ <h2 class="section-header "><a name="Functions"></a>Functions</h2>
+ Methods
+ <dl class="function">
+ <dt>
+ <a name = "nullsink.init"></a>
+ <strong>nullsink.init()</strong>
+ </dt>
+ <dd>
+ Create a nullsink.
+
+
+
+ <h3>Returns:</h3>
+ <ol>
+
+ <span class="types"><a class="type" href="../classes/nullsink.html#">nullsink</a></span>
+ The newly created nullsink.
+ </ol>
+
+
+
+
+</dd>
+</dl>
+ <h2 class="section-header "><a name="Methods"></a>Methods</h2>
+
+ <dl class="function">
+ <dt>
+ <a name = "nullsink:ref"></a>
+ <strong>nullsink:ref(input)</strong>
+ </dt>
+ <dd>
+ Connect an input signal. </p>
+
+<p>This makes sure the input signal is processed
+even if it's not connected to anything else.
+
+
+ <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/nullsink.html#">nullsink</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>