diff options
Diffstat (limited to 'doc/classes/pan.html')
| -rw-r--r-- | doc/classes/pan.html | 240 |
1 files changed, 240 insertions, 0 deletions
diff --git a/doc/classes/pan.html b/doc/classes/pan.html new file mode 100644 index 0000000..1728b7c --- /dev/null +++ b/doc/classes/pan.html @@ -0,0 +1,240 @@ +<!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><a href="../classes/nullsink.html">nullsink</a></li> + <li><a href="../classes/oscil.html">oscil</a></li> + <li><strong>pan</strong></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>pan</code></h1> +<p>Panning</p> +<p> + +<pre> +<span class="keyword">local</span> mpan = <span class="global">require</span> <span class="string">'melisma.pan'</span> +<span class="keyword">local</span> mexpression = <span class="global">require</span> <span class="string">'melisma.expression'</span> +<span class="keyword">local</span> moscil = <span class="global">require</span> <span class="string">'melisma.oscil'</span> + +<span class="keyword">local</span> wt = moscil.wavetable.<span class="function-name">sin</span>() +<span class="keyword">local</span> lfo_oscil = moscil.<span class="function-name">init</span>(wt,<span class="number">1</span>,<span class="number">1</span>) +<span class="keyword">local</span> lfo = (<span class="number">1</span> + mexpression.<span class="function-name">input</span>(lfo_oscil,<span class="number">0</span>) / <span class="number">2</span>):<span class="function-name">build</span>() + +<span class="keyword">local</span> oscil = moscil.<span class="function-name">init</span>(wt,<span class="number">440</span>,<span class="number">0.5</span>) +<span class="keyword">local</span> pan = mpan.<span class="function-name">init</span>(lfo,oscil) + +<span class="keyword">local</span> left = pan:<span class="function-name">left</span>() +<span class="keyword">local</span> right = pan:<span class="function-name">right</span>() +</pre> + +</p> + + +<h2><a href="#Functions">Functions</a></h2> +<table class="function_list"> + <tr> + <td class="name" nowrap><a href="#pan.init">pan.init(x, sig)</a></td> + <td class="summary">Initialize a panning unit.</td> + </tr> +</table> +<h2><a href="#Methods">Methods</a></h2> +<table class="function_list"> + <tr> + <td class="name" nowrap><a href="#pan:left">pan:left()</a></td> + <td class="summary">Get the left output signal.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#pan:right">pan:right()</a></td> + <td class="summary">Get the right output signal.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#pan:set">pan:set(x)</a></td> + <td class="summary">Set the panning value.</td> + </tr> +</table> + +<br/> +<br/> + + + <h2 class="section-header "><a name="Functions"></a>Functions</h2> + Methods + <dl class="function"> + <dt> + <a name = "pan.init"></a> + <strong>pan.init(x, sig)</strong> + </dt> + <dd> + Initialize a panning unit. </p> + +<p>A panning value ranges from 0 to 1, where a value of 0 +will pan everything to the left. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">x</span> + <span class="types"><span class="type">number</span> or <span class="type">channel</span></span> + Constant pan or a controlling signal. + </li> + <li><span class="parameter">sig</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/pan.html#">pan</a></span> + The newly created panning unit. + </ol> + + + + +</dd> +</dl> + <h2 class="section-header "><a name="Methods"></a>Methods</h2> + + <dl class="function"> + <dt> + <a name = "pan:left"></a> + <strong>pan:left()</strong> + </dt> + <dd> + Get the left output signal. + + + + <h3>Returns:</h3> + <ol> + + <span class="types"><span class="type">channel</span></span> + + + + </ol> + + + + +</dd> + <dt> + <a name = "pan:right"></a> + <strong>pan:right()</strong> + </dt> + <dd> + Get the right output signal. + + + + <h3>Returns:</h3> + <ol> + + <span class="types"><span class="type">channel</span></span> + + + + </ol> + + + + +</dd> + <dt> + <a name = "pan:set"></a> + <strong>pan:set(x)</strong> + </dt> + <dd> + Set the panning value. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">x</span> + <span class="types"><span class="type">number</span></span> + + + + </li> + </ul> + + + + + +</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> |