diff options
Diffstat (limited to 'doc/classes/playback.html')
| -rw-r--r-- | doc/classes/playback.html | 331 |
1 files changed, 331 insertions, 0 deletions
diff --git a/doc/classes/playback.html b/doc/classes/playback.html new file mode 100644 index 0000000..fcee0d6 --- /dev/null +++ b/doc/classes/playback.html @@ -0,0 +1,331 @@ +<!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><a href="../classes/pan.html">pan</a></li> + <li><strong>playback</strong></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>playback</code></h1> +<p>Audio sample playback.</p> +<p> + + + +<pre> +<span class="keyword">local</span> msample = <span class="global">require</span> <span class="string">'melisma.sample'</span> +<span class="keyword">local</span> mplayback = <span class="global">require</span> <span class="string">'melisma.playback'</span> + +<span class="keyword">local</span> sample = msample.<span class="global">load</span>(<span class="string">'sample.wav'</span>) +<span class="keyword">local</span> playb = mplayback.<span class="function-name">init</span>(sample) + +playb:<span class="function-name">loop</span>(<span class="keyword">true</span>) +playb:<span class="function-name">spped</span>(<span class="number">2</span>) +playb:<span class="function-name">play</span>() +</pre> + +</p> + + +<h2><a href="#Functions">Functions</a></h2> +<table class="function_list"> + <tr> + <td class="name" nowrap><a href="#playback.init">playback.init(smp)</a></td> + <td class="summary">Intialize a playback unit.</td> + </tr> +</table> +<h2><a href="#Methods">Methods</a></h2> +<table class="function_list"> + <tr> + <td class="name" nowrap><a href="#playback:loop">playback:loop(b)</a></td> + <td class="summary">Enable/disable automatic looping.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#playback:pause">playback:pause()</a></td> + <td class="summary">Pause playback.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#playback:phase">playback:phase(x)</a></td> + <td class="summary">Set playback phase.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#playback:play">playback:play()</a></td> + <td class="summary">Start playback.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#playback:reset">playback:reset()</a></td> + <td class="summary">Reset playback.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#playback:reset">playback:reset()</a></td> + <td class="summary">Set playback speed.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#playback:set_sample">playback:set_sample(smp)</a></td> + <td class="summary">Set playback sample.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#playback:stop">playback:stop()</a></td> + <td class="summary">Stop playback.</td> + </tr> +</table> + +<br/> +<br/> + + + <h2 class="section-header "><a name="Functions"></a>Functions</h2> + Methods + <dl class="function"> + <dt> + <a name = "playback.init"></a> + <strong>playback.init(smp)</strong> + </dt> + <dd> + Intialize a playback unit. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">smp</span> + <span class="types"><a class="type" href="../classes/sample.html#">sample</a> or <span class="type">nil</span></span> + + + + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + <span class="types"><a class="type" href="../classes/playback.html#">playback</a></span> + + + + </ol> + + + + +</dd> +</dl> + <h2 class="section-header "><a name="Methods"></a>Methods</h2> + + <dl class="function"> + <dt> + <a name = "playback:loop"></a> + <strong>playback:loop(b)</strong> + </dt> + <dd> + Enable/disable automatic looping. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">b</span> + <span class="types"><span class="type">bool</span></span> + + + + </li> + </ul> + + + + + +</dd> + <dt> + <a name = "playback:pause"></a> + <strong>playback:pause()</strong> + </dt> + <dd> + Pause playback. + + + + + + + +</dd> + <dt> + <a name = "playback:phase"></a> + <strong>playback:phase(x)</strong> + </dt> + <dd> + Set playback phase. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">x</span> + <span class="types"><span class="type">number</span></span> + Phase ranging from 0 to 1. + </li> + </ul> + + + + + +</dd> + <dt> + <a name = "playback:play"></a> + <strong>playback:play()</strong> + </dt> + <dd> + Start playback. + + + + + + + +</dd> + <dt> + <a name = "playback:reset"></a> + <strong>playback:reset()</strong> + </dt> + <dd> + Reset playback. </p> + +<p>Equivalent to <a href="../classes/playback.html#playback:phase">playback.phase</a>(0). + + + + + + + +</dd> + <dt> + <a name = "playback:reset"></a> + <strong>playback:reset()</strong> + </dt> + <dd> + Set playback speed. </p> + +<p>A negative speed will play the sample in reverse. + + + + + + + +</dd> + <dt> + <a name = "playback:set_sample"></a> + <strong>playback:set_sample(smp)</strong> + </dt> + <dd> + Set playback sample. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">smp</span> + <span class="types"><a class="type" href="../classes/sample.html#">sample</a></span> + + + + </li> + </ul> + + + + + +</dd> + <dt> + <a name = "playback:stop"></a> + <strong>playback:stop()</strong> + </dt> + <dd> + Stop playback. </p> + +<p>Equivalent to <a href="../classes/playback.html#playback:pause">playback.pause</a>; <a href="../classes/playback.html#playback:reset">playback.reset</a>. + + + + + + + +</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> |