0.8 documentation

This commit is contained in:
Lars Immisch
2015-05-13 23:52:07 +02:00
parent 78b8528cea
commit 9090be4c2f
20 changed files with 718 additions and 10728 deletions
+14 -12
View File
@@ -1,5 +1,3 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
@@ -15,7 +13,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
URL_ROOT: './',
VERSION: '0.8',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
@@ -60,9 +58,9 @@
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Author:</th><td class="field-body">Casper Wilstrup</td>
<tr class="field-odd field"><th class="field-name">Author:</th><td class="field-body">Casper Wilstrup &lt;<a class="reference external" href="mailto:cwi&#37;&#52;&#48;aves&#46;dk">cwi<span>&#64;</span>aves<span>&#46;</span>dk</a>&gt;</td>
</tr>
<tr class="field-even field"><th class="field-name">Author:</th><td class="field-body">Lars Immisch</td>
<tr class="field-even field"><th class="field-name">Author:</th><td class="field-body">Lars Immisch &lt;<a class="reference external" href="mailto:lars&#37;&#52;&#48;ibp&#46;de">lars<span>&#64;</span>ibp<span>&#46;</span>de</a>&gt;</td>
</tr>
</tbody>
</table>
@@ -123,7 +121,8 @@ default in Linux kernel 2.6 and later. If you are using kernel version 2.4 you
may need to install the ALSA patches yourself - although most distributions
ship with ALSA kernels.</p>
<p>To install, execute the following: &#8212;</p>
<div class="highlight-python"><pre>$ python setup.py build</pre>
<div class="highlight-python"><div class="highlight"><pre>$ python setup.py build
</pre></div>
</div>
<p>And then as root: &#8212;</p>
<div class="highlight-python"><div class="highlight"><pre><span class="c"># python setup.py install</span>
@@ -133,18 +132,21 @@ ship with ALSA kernels.</p>
<div class="section" id="testing">
<h1>Testing<a class="headerlink" href="#testing" title="Permalink to this headline"></a></h1>
<p>First of all, run:</p>
<div class="highlight-python"><pre>$ python test.py</pre>
<div class="highlight-python"><div class="highlight"><pre>$ python test.py
</pre></div>
</div>
<p>This is a small test suite that mostly performs consistency tests. If
it fails, please file a <a class="reference external" href="http://sourceforge.net/tracker/?group_id=120651">bug report</a>.</p>
it fails, please file a <a class="reference external" href="https://github.com/larsimmisch/pyalsaaudio/issues">bug report</a>.</p>
<p>To test PCM recordings (on your default soundcard), verify your
microphone works, then do:</p>
<div class="highlight-python"><pre>$ python recordtest.py &lt;filename&gt;</pre>
<div class="highlight-python"><div class="highlight"><pre>$ python recordtest.py &lt;filename&gt;
</pre></div>
</div>
<p>Speak into the microphone, and interrupt the recording at any time
with <tt class="docutils literal"><span class="pre">Ctl-C</span></tt>.</p>
<p>Play back the recording with:</p>
<div class="highlight-python"><pre>$ python playbacktest.py &lt;filename&gt;</pre>
<div class="highlight-python"><div class="highlight"><pre>$ python playbacktest.py &lt;filename&gt;
</pre></div>
</div>
</div>
@@ -213,8 +215,8 @@ with <tt class="docutils literal"><span class="pre">Ctl-C</span></tt>.</p>
</div>
<div class="footer">
&copy; Copyright 2008-2009, Casper Wilstrup, Lars Immisch.
Last updated on Apr 30, 2015.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
Last updated on May 13, 2015.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
</div>
</body>
</html>