initHEADmain

1 files changed, 203 insertions, 0 deletions

diff --git a/doc/classes/sample.html b/doc/classes/sample.html
new file mode 100644
index 0000000..313d14d
--- /dev/null
+++ b/doc/classes/sample.html
@@ -0,0 +1,203 @@
+<!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><a href="../classes/playback.html">playback</a></li>
+  <li><strong>sample</strong></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>sample</code></h1>
+<p>Load audio samples.</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> smp = msample.<span class="global">load</span>(<span class="string">'sample.wav'</span>)
+
+<span class="global">print</span>(smp:<span class="function-name">length</span>())
+<span class="global">print</span>(smp:<span class="function-name">path</span>())
+</pre>
+
+</p>
+
+
+<h2><a href="#Functions">Functions</a></h2>
+<table class="function_list">
+	<tr>
+	<td class="name" nowrap><a href="#sample.load">sample.load(path)</a></td>
+	<td class="summary">Load an audio sample.</td>
+	</tr>
+</table>
+<h2><a href="#Methods">Methods</a></h2>
+<table class="function_list">
+	<tr>
+	<td class="name" nowrap><a href="#sample:length">sample:length()</a></td>
+	<td class="summary">Get sample length.</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#sample:path">sample:path()</a></td>
+	<td class="summary">Get sample path.</td>
+	</tr>
+</table>
+
+<br/>
+<br/>
+
+
+    <h2 class="section-header "><a name="Functions"></a>Functions</h2>
+    Methods
+    <dl class="function">
+    <dt>
+    <a name = "sample.load"></a>
+    <strong>sample.load(path)</strong>
+    </dt>
+    <dd>
+    Load an audio sample. </p>
+
+<p>If necessary, the audio will be resampled to the current sample rate.
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">path</span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
+
+
+
+        </li>
+    </ul>
+
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><a class="type" href="../classes/sample.html#">sample</a></span>
+
+
+
+    </ol>
+
+
+
+
+</dd>
+</dl>
+    <h2 class="section-header "><a name="Methods"></a>Methods</h2>
+
+    <dl class="function">
+    <dt>
+    <a name = "sample:length"></a>
+    <strong>sample:length()</strong>
+    </dt>
+    <dd>
+    Get sample length.
+
+
+
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><span class="type">number</span></span>
+        The length of the sample in seconds.
+    </ol>
+
+
+
+
+</dd>
+    <dt>
+    <a name = "sample:path"></a>
+    <strong>sample:path()</strong>
+    </dt>
+    <dd>
+    Get sample path.
+
+
+
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
+        The path that the sample was loaded from.
+    </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>