auracaster/sw_pyalsaaudio
3
0
Fork 0
forked from auracaster/pyalsaaudio
Code Pull Requests Activity
Files
e15481ead528cd255119d813086ae2f4bd1b8012
sw_pyalsaaudio/libalsaaudio.html
Lars Immisch e15481ead5 Formatting.
2020-07-13 22:17:03 +02:00

816 lines
53 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>alsaaudio &#8212; alsaaudio documentation 0.9.0 documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="prev" title="PCM Terminology and Concepts" href="terminology.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="module-alsaaudio">
<span id="alsaaudio"></span><h1><a class="reference internal" href="#module-alsaaudio" title="alsaaudio (Linux)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">alsaaudio</span></code></a><a class="headerlink" href="#module-alsaaudio" title="Permalink to this headline"></a></h1>
<p>The <a class="reference internal" href="#module-alsaaudio" title="alsaaudio (Linux)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">alsaaudio</span></code></a> module defines functions and classes for using ALSA.</p>
<dl class="py function">
<dt id="alsaaudio.pcms">
<code class="sig-prename descclassname">alsaaudio.</code><code class="sig-name descname">pcms</code><span class="sig-paren">(</span><span class="optional">[</span><em class="sig-param">type=PCM_PLAYBACK</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#alsaaudio.pcms" title="Permalink to this definition"></a></dt>
<dd><p>List available PCM devices by name.</p>
<p>Arguments are:</p>
<ul class="simple">
<li><p><em>type</em> - can be either <code class="xref py py-const docutils literal notranslate"><span class="pre">PCM_CAPTURE</span></code> or <code class="xref py py-const docutils literal notranslate"><span class="pre">PCM_PLAYBACK</span></code>
(default).</p></li>
</ul>
<p><strong>Note:</strong></p>
<p>For <code class="xref py py-const docutils literal notranslate"><span class="pre">PCM_PLAYBACK</span></code>, the list of device names should be equivalent
to the list of device names that <code class="docutils literal notranslate"><span class="pre">aplay</span> <span class="pre">-L</span></code> displays on the commandline:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ aplay -L
</pre></div>
</div>
<p>For <code class="xref py py-const docutils literal notranslate"><span class="pre">PCM_CAPTURE</span></code>, the list of device names should be equivalent
to the list of device names that <code class="docutils literal notranslate"><span class="pre">arecord</span> <span class="pre">-L</span></code> displays on the
commandline:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ arecord -L
</pre></div>
</div>
<p><em>New in 0.8</em></p>
</dd></dl>
<dl class="py function">
<dt id="alsaaudio.cards">
<code class="sig-prename descclassname">alsaaudio.</code><code class="sig-name descname">cards</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#alsaaudio.cards" title="Permalink to this definition"></a></dt>
<dd><p>List the available ALSA cards by name. This function is only moderately
useful. If you want to see a list of available PCM devices, use <a class="reference internal" href="#alsaaudio.pcms" title="alsaaudio.pcms"><code class="xref py py-func docutils literal notranslate"><span class="pre">pcms()</span></code></a>
instead.</p>
</dd></dl>
<dl class="py function">
<dt id="alsaaudio.mixers">
<code class="sig-prename descclassname">alsaaudio.</code><code class="sig-name descname">mixers</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">cardindex</span><span class="o">=</span><span class="default_value">- 1</span></em>, <em class="sig-param"><span class="n">device</span><span class="o">=</span><span class="default_value">'default'</span></em><span class="sig-paren">)</span><a class="headerlink" href="#alsaaudio.mixers" title="Permalink to this definition"></a></dt>
<dd><p>List the available mixers. The arguments are:</p>
<ul class="simple">
<li><p><em>cardindex</em> - the card index. If this argument is given, the device name
is constructed as: ‘hw:<em>cardindex</em>’ and
the <cite>device</cite> keyword argument is ignored. <code class="docutils literal notranslate"><span class="pre">0</span></code> is the first hardware sound
card.</p></li>
<li><p><em>device</em> - the name of the device on which the mixer resides. The default
is <code class="docutils literal notranslate"><span class="pre">'default'</span></code>.</p></li>
</ul>
<p><strong>Note:</strong> For a list of available controls, you can also use <code class="docutils literal notranslate"><span class="pre">amixer</span></code> on
the commandline:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ amixer
</pre></div>
</div>
<p>To elaborate the example, calling <a class="reference internal" href="#alsaaudio.mixers" title="alsaaudio.mixers"><code class="xref py py-func docutils literal notranslate"><span class="pre">mixers()</span></code></a> with the argument
<code class="docutils literal notranslate"><span class="pre">cardindex=0</span></code> should give the same list of Mixer controls as:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ amixer -c 0
</pre></div>
</div>
<p>And calling <a class="reference internal" href="#alsaaudio.mixers" title="alsaaudio.mixers"><code class="xref py py-func docutils literal notranslate"><span class="pre">mixers()</span></code></a> with the argument <code class="docutils literal notranslate"><span class="pre">device='foo'</span></code> should give
the same list of Mixer controls as:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ amixer -D foo
</pre></div>
</div>
<p><em>Changed in 0.8</em>:</p>
<ul class="simple">
<li><p>The keyword argument <cite>device</cite> is new and can be used to
select virtual devices. As a result, the default behaviour has subtly
changed. Since 0.8, this functions returns the mixers for the default
device, not the mixers for the first card.</p></li>
</ul>
</dd></dl>
<div class="section" id="pcm-objects">
<span id="id1"></span><h2>PCM Objects<a class="headerlink" href="#pcm-objects" title="Permalink to this headline"></a></h2>
<p>PCM objects in <a class="reference internal" href="#module-alsaaudio" title="alsaaudio (Linux)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">alsaaudio</span></code></a> can play or capture (record) PCM
sound through speakers or a microphone. The PCM constructor takes the
following arguments:</p>
<dl class="py class">
<dt id="alsaaudio.PCM">
<em class="property">class </em><code class="sig-prename descclassname">alsaaudio.</code><code class="sig-name descname">PCM</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">type</span><span class="o">=</span><span class="default_value">PCM_PLAYBACK</span></em>, <em class="sig-param"><span class="n">mode</span><span class="o">=</span><span class="default_value">PCM_NORMAL</span></em>, <em class="sig-param"><span class="n">rate</span><span class="o">=</span><span class="default_value">44100</span></em>, <em class="sig-param"><span class="n">channels</span><span class="o">=</span><span class="default_value">2</span></em>, <em class="sig-param"><span class="n">format</span><span class="o">=</span><span class="default_value">PCM_FORMAT_S16_LE</span></em>, <em class="sig-param"><span class="n">periodsize</span><span class="o">=</span><span class="default_value">32</span></em>, <em class="sig-param"><span class="n">device</span><span class="o">=</span><span class="default_value">'default'</span></em>, <em class="sig-param"><span class="n">cardindex</span><span class="o">=</span><span class="default_value">- 1</span></em><span class="sig-paren">)</span><a class="headerlink" href="#alsaaudio.PCM" title="Permalink to this definition"></a></dt>
<dd><p>This class is used to represent a PCM device (either for playback and
recording). The arguments are:</p>
<ul class="simple">
<li><p><em>type</em> - can be either <code class="xref py py-const docutils literal notranslate"><span class="pre">PCM_CAPTURE</span></code> or <code class="xref py py-const docutils literal notranslate"><span class="pre">PCM_PLAYBACK</span></code>
(default).</p></li>
<li><p><em>mode</em> - can be either <code class="xref py py-const docutils literal notranslate"><span class="pre">PCM_NONBLOCK</span></code>, or <code class="xref py py-const docutils literal notranslate"><span class="pre">PCM_NORMAL</span></code>
(default).</p></li>
<li><p><em>rate</em> - the sampling rate in Hz. Typical values are <code class="docutils literal notranslate"><span class="pre">8000</span></code> (mainly used for telephony), <code class="docutils literal notranslate"><span class="pre">16000</span></code>, <code class="docutils literal notranslate"><span class="pre">44100</span></code> (default), <code class="docutils literal notranslate"><span class="pre">48000</span></code> and <code class="docutils literal notranslate"><span class="pre">96000</span></code>.</p></li>
<li><p><em>channels</em> - the number of channels. The default value is 2 (stereo).</p></li>
<li><p><em>format</em> - the data format. This controls how the PCM device interprets data for playback, and how data is encoded in captures.
The default value is <code class="xref py py-const docutils literal notranslate"><span class="pre">PCM_FORMAT_S16_LE</span></code>.</p></li>
</ul>
<table class="docutils align-default">
<colgroup>
<col style="width: 24%" />
<col style="width: 76%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>Format</p></th>
<th class="head"><p>Description</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">PCM_FORMAT_S8</span></code></p></td>
<td><p>Signed 8 bit samples for each channel</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">PCM_FORMAT_U8</span></code></p></td>
<td><p>Signed 8 bit samples for each channel</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">PCM_FORMAT_S16_LE</span></code></p></td>
<td><p>Signed 16 bit samples for each channel Little Endian byte order)</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">PCM_FORMAT_S16_BE</span></code></p></td>
<td><p>Signed 16 bit samples for each channel (Big Endian byte order)</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">PCM_FORMAT_U16_LE</span></code></p></td>
<td><p>Unsigned 16 bit samples for each channel (Little Endian byte order)</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">PCM_FORMAT_U16_BE</span></code></p></td>
<td><p>Unsigned 16 bit samples for each channel (Big Endian byte order)</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">PCM_FORMAT_S24_LE</span></code></p></td>
<td><p>Signed 24 bit samples for each channel (Little Endian byte order in 4 bytes)</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">PCM_FORMAT_S24_BE</span></code></p></td>
<td><p>Signed 24 bit samples for each channel (Big Endian byte order in 4 bytes)</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">PCM_FORMAT_U24_LE</span></code></p></td>
<td><p>Unsigned 24 bit samples for each channel (Little Endian byte order in 4 bytes)</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">PCM_FORMAT_U24_BE</span></code></p></td>
<td><p>Unsigned 24 bit samples for each channel (Big Endian byte order in 4 bytes)</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">PCM_FORMAT_S32_LE</span></code></p></td>
<td><p>Signed 32 bit samples for each channel (Little Endian byte order)</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">PCM_FORMAT_S32_BE</span></code></p></td>
<td><p>Signed 32 bit samples for each channel (Big Endian byte order)</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">PCM_FORMAT_U32_LE</span></code></p></td>
<td><p>Unsigned 32 bit samples for each channel (Little Endian byte order)</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">PCM_FORMAT_U32_BE</span></code></p></td>
<td><p>Unsigned 32 bit samples for each channel (Big Endian byte order)</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">PCM_FORMAT_FLOAT_LE</span></code></p></td>
<td><p>32 bit samples encoded as float (Little Endian byte order)</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">PCM_FORMAT_FLOAT_BE</span></code></p></td>
<td><p>32 bit samples encoded as float (Big Endian byte order)</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">PCM_FORMAT_FLOAT64_LE</span></code></p></td>
<td><p>64 bit samples encoded as float (Little Endian byte order)</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">PCM_FORMAT_FLOAT64_BE</span></code></p></td>
<td><p>64 bit samples encoded as float (Big Endian byte order)</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">PCM_FORMAT_MU_LAW</span></code></p></td>
<td><p>A logarithmic encoding (used by Sun .au files and telephony)</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">PCM_FORMAT_A_LAW</span></code></p></td>
<td><p>Another logarithmic encoding</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">PCM_FORMAT_IMA_ADPCM</span></code></p></td>
<td><p>A 4:1 compressed format defined by the Interactive Multimedia Association.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">PCM_FORMAT_MPEG</span></code></p></td>
<td><p>MPEG encoded audio?</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">PCM_FORMAT_GSM</span></code></p></td>
<td><p>9600 bits/s constant rate encoding for speech</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">PCM_FORMAT_S24_3LE</span></code></p></td>
<td><p>Signed 24 bit samples for each channel (Little Endian byte order in 3 bytes)</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">PCM_FORMAT_S24_3BE</span></code></p></td>
<td><p>Signed 24 bit samples for each channel (Big Endian byte order in 3 bytes)</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">PCM_FORMAT_U24_3LE</span></code></p></td>
<td><p>Unsigned 24 bit samples for each channel (Little Endian byte order in 3 bytes)</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">PCM_FORMAT_U24_3BE</span></code></p></td>
<td><p>Unsigned 24 bit samples for each channel (Big Endian byte order in 3 bytes)</p></td>
</tr>
</tbody>
</table>
<ul class="simple">
<li><p><em>periodsize</em> - the period size in frames. Each write should consist of <em>periodsize</em> frames. The default value is 32.</p></li>
<li><p><em>device</em> - the name of the PCM device that should be used (for example
a value from the output of <a class="reference internal" href="#alsaaudio.pcms" title="alsaaudio.pcms"><code class="xref py py-func docutils literal notranslate"><span class="pre">pcms()</span></code></a>). The default value is
<code class="docutils literal notranslate"><span class="pre">'default'</span></code>.</p></li>
<li><p><em>cardindex</em> - the card index. If this argument is given, the device name
is constructed as ‘hw:<em>cardindex</em>’ and
the <cite>device</cite> keyword argument is ignored.
<code class="docutils literal notranslate"><span class="pre">0</span></code> is the first hardware sound card.</p></li>
</ul>
<p>This will construct a PCM object with the given settings.</p>
<p><em>Changed in 0.9:</em></p>
<ul class="simple">
<li><p>Added the optional named parameters <cite>rate</cite>, <cite>channels</cite>, <cite>format</cite> and <cite>periodsize</cite>.</p></li>
</ul>
<p><em>Changed in 0.8:</em></p>
<ul class="simple">
<li><p>The <cite>card</cite> keyword argument is still supported,
but deprecated. Please use <cite>device</cite> instead.</p></li>
<li><p>The keyword argument <cite>cardindex</cite> was added.</p></li>
</ul>
<p>The <cite>card</cite> keyword is deprecated because it guesses the real ALSA
name of the card. This was always fragile and broke some legitimate usecases.</p>
</dd></dl>
<p>PCM objects have the following methods:</p>
<dl class="py method">
<dt id="alsaaudio.PCM.pcmtype">
<code class="sig-prename descclassname">PCM.</code><code class="sig-name descname">pcmtype</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#alsaaudio.PCM.pcmtype" title="Permalink to this definition"></a></dt>
<dd><p>Returns the type of PCM object. Either <code class="xref py py-const docutils literal notranslate"><span class="pre">PCM_CAPTURE</span></code> or
<code class="xref py py-const docutils literal notranslate"><span class="pre">PCM_PLAYBACK</span></code>.</p>
</dd></dl>
<dl class="py method">
<dt id="alsaaudio.PCM.pcmmode">
<code class="sig-prename descclassname">PCM.</code><code class="sig-name descname">pcmmode</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#alsaaudio.PCM.pcmmode" title="Permalink to this definition"></a></dt>
<dd><p>Return the mode of the PCM object. One of <code class="xref py py-const docutils literal notranslate"><span class="pre">PCM_NONBLOCK</span></code>,
<code class="xref py py-const docutils literal notranslate"><span class="pre">PCM_ASYNC</span></code>, or <code class="xref py py-const docutils literal notranslate"><span class="pre">PCM_NORMAL</span></code></p>
</dd></dl>
<dl class="py method">
<dt id="alsaaudio.PCM.cardname">
<code class="sig-prename descclassname">PCM.</code><code class="sig-name descname">cardname</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#alsaaudio.PCM.cardname" title="Permalink to this definition"></a></dt>
<dd><p>Return the name of the sound card used by this PCM object.</p>
</dd></dl>
<dl class="py method">
<dt id="alsaaudio.PCM.setchannels">
<code class="sig-prename descclassname">PCM.</code><code class="sig-name descname">setchannels</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">nchannels</span></em><span class="sig-paren">)</span><a class="headerlink" href="#alsaaudio.PCM.setchannels" title="Permalink to this definition"></a></dt>
<dd><div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 0.9: </span>Use the <cite>channels</cite> named argument to <a class="reference internal" href="#alsaaudio.PCM" title="alsaaudio.PCM"><code class="xref py py-func docutils literal notranslate"><span class="pre">PCM()</span></code></a>.</p>
</div>
</dd></dl>
<dl class="py method">
<dt id="alsaaudio.PCM.setrate">
<code class="sig-prename descclassname">PCM.</code><code class="sig-name descname">setrate</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">rate</span></em><span class="sig-paren">)</span><a class="headerlink" href="#alsaaudio.PCM.setrate" title="Permalink to this definition"></a></dt>
<dd><div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 0.9: </span>Use the <cite>rate</cite> named argument to <a class="reference internal" href="#alsaaudio.PCM" title="alsaaudio.PCM"><code class="xref py py-func docutils literal notranslate"><span class="pre">PCM()</span></code></a>.</p>
</div>
</dd></dl>
<dl class="py method">
<dt id="alsaaudio.PCM.setformat">
<code class="sig-prename descclassname">PCM.</code><code class="sig-name descname">setformat</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">format</span></em><span class="sig-paren">)</span><a class="headerlink" href="#alsaaudio.PCM.setformat" title="Permalink to this definition"></a></dt>
<dd><div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 0.9: </span>Use the <cite>format</cite> named argument to <a class="reference internal" href="#alsaaudio.PCM" title="alsaaudio.PCM"><code class="xref py py-func docutils literal notranslate"><span class="pre">PCM()</span></code></a>.</p>
</div>
</dd></dl>
<dl class="py method">
<dt id="alsaaudio.PCM.setperiodsize">
<code class="sig-prename descclassname">PCM.</code><code class="sig-name descname">setperiodsize</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">period</span></em><span class="sig-paren">)</span><a class="headerlink" href="#alsaaudio.PCM.setperiodsize" title="Permalink to this definition"></a></dt>
<dd><div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 0.9: </span>Use the <cite>periodsize</cite> named argument to <a class="reference internal" href="#alsaaudio.PCM" title="alsaaudio.PCM"><code class="xref py py-func docutils literal notranslate"><span class="pre">PCM()</span></code></a>.</p>
</div>
</dd></dl>
<dl class="py method">
<dt id="alsaaudio.PCM.read">
<code class="sig-prename descclassname">PCM.</code><code class="sig-name descname">read</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#alsaaudio.PCM.read" title="Permalink to this definition"></a></dt>
<dd><p>In <code class="xref py py-const docutils literal notranslate"><span class="pre">PCM_NORMAL</span></code> mode, this function blocks until a full period is
available, and then returns a tuple (length,data) where <em>length</em> is
the number of frames of captured data, and <em>data</em> is the captured
sound frames as a string. The length of the returned data will be
periodsize*framesize bytes.</p>
<p>In <code class="xref py py-const docutils literal notranslate"><span class="pre">PCM_NONBLOCK</span></code> mode, the call will not block, but will return
<code class="docutils literal notranslate"><span class="pre">(0,'')</span></code> if no new period has become available since the last
call to read.</p>
<p>In case of an overrun, this function will return a negative size: <code class="xref py py-const docutils literal notranslate"><span class="pre">-EPIPE</span></code>.
This indicates that data was lost, even if the operation itself succeeded.
Try using a larger periodsize.</p>
</dd></dl>
<dl class="py method">
<dt id="alsaaudio.PCM.write">
<code class="sig-prename descclassname">PCM.</code><code class="sig-name descname">write</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</span></em><span class="sig-paren">)</span><a class="headerlink" href="#alsaaudio.PCM.write" title="Permalink to this definition"></a></dt>
<dd><p>Writes (plays) the sound in data. The length of data <em>must</em> be a
multiple of the frame size, and <em>should</em> be exactly the size of a
period. If less than ‘period size’ frames are provided, the actual
playout will not happen until more data is written.</p>
<p>If the device is not in <code class="xref py py-const docutils literal notranslate"><span class="pre">PCM_NONBLOCK</span></code> mode, this call will block if
the kernel buffer is full, and until enough sound has been played
to allow the sound data to be buffered. The call always returns the
size of the data provided.</p>
<p>In <code class="xref py py-const docutils literal notranslate"><span class="pre">PCM_NONBLOCK</span></code> mode, the call will return immediately, with a
return value of zero, if the buffer is full. In this case, the data
should be written at a later time.</p>
</dd></dl>
<dl class="py method">
<dt id="alsaaudio.PCM.pause">
<code class="sig-prename descclassname">PCM.</code><code class="sig-name descname">pause</code><span class="sig-paren">(</span><span class="optional">[</span><em class="sig-param">enable=True</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#alsaaudio.PCM.pause" title="Permalink to this definition"></a></dt>
<dd><p>If <em>enable</em> is <code class="xref py py-const docutils literal notranslate"><span class="pre">True</span></code>, playback or capture is paused.
Otherwise, playback/capture is resumed.</p>
</dd></dl>
<dl class="py method">
<dt id="alsaaudio.PCM.polldescriptors">
<code class="sig-prename descclassname">PCM.</code><code class="sig-name descname">polldescriptors</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#alsaaudio.PCM.polldescriptors" title="Permalink to this definition"></a></dt>
<dd><p>Returns a tuple of <em>(file descriptor, eventmask)</em> that can be used to
wait for changes on the mixer with <em>select.poll</em>.</p>
<p>The <em>eventmask</em> value is compatible with <a class="reference external" href="http://docs.python.org/library/select.html#poll-objects">poll.register</a> in the Python
<code class="xref py py-const docutils literal notranslate"><span class="pre">select</span></code> module.</p>
</dd></dl>
<p><strong>A few hints on using PCM devices for playback</strong></p>
<p>The most common reason for problems with playback of PCM audio is that writes
to PCM devices must <em>exactly</em> match the data rate of the device.</p>
<p>If too little data is written to the device, it will underrun, and
ugly clicking sounds will occur. Conversely, of too much data is
written to the device, the write function will either block
(<code class="xref py py-const docutils literal notranslate"><span class="pre">PCM_NORMAL</span></code> mode) or return zero (<code class="xref py py-const docutils literal notranslate"><span class="pre">PCM_NONBLOCK</span></code> mode).</p>
<p>If your program does nothing but play sound, the best strategy is to put the
device in <code class="xref py py-const docutils literal notranslate"><span class="pre">PCM_NORMAL</span></code> mode, and just write as much data to the device as
possible. This strategy can also be achieved by using a separate
thread with the sole task of playing out sound.</p>
<p>In GUI programs, however, it may be a better strategy to setup the device,
preload the buffer with a few periods by calling write a couple of times, and
then use some timer method to write one period size of data to the device every
period. The purpose of the preloading is to avoid underrun clicks if the used
timer doesn’t expire exactly on time.</p>
<p>Also note, that most timer APIs that you can find for Python will
accummulate time delays: If you set the timer to expire after 1/10’th
of a second, the actual timeout will happen slightly later, which will
accumulate to quite a lot after a few seconds. Hint: use time.time()
to check how much time has really passed, and add extra writes as nessecary.</p>
</div>
<div class="section" id="mixer-objects">
<span id="id3"></span><h2>Mixer Objects<a class="headerlink" href="#mixer-objects" title="Permalink to this headline"></a></h2>
<p>Mixer objects provides access to the ALSA mixer API.</p>
<dl class="py class">
<dt id="alsaaudio.Mixer">
<em class="property">class </em><code class="sig-prename descclassname">alsaaudio.</code><code class="sig-name descname">Mixer</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">control</span><span class="o">=</span><span class="default_value">'Master'</span></em>, <em class="sig-param"><span class="n">id</span><span class="o">=</span><span class="default_value">0</span></em>, <em class="sig-param"><span class="n">cardindex</span><span class="o">=</span><span class="default_value">- 1</span></em>, <em class="sig-param"><span class="n">device</span><span class="o">=</span><span class="default_value">'default'</span></em><span class="sig-paren">)</span><a class="headerlink" href="#alsaaudio.Mixer" title="Permalink to this definition"></a></dt>
<dd><p>Arguments are:</p>
<ul class="simple">
<li><p><em>control</em> - specifies which control to manipulate using this mixer
object. The list of available controls can be found with the
<a class="reference internal" href="#module-alsaaudio" title="alsaaudio (Linux)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">alsaaudio</span></code></a>.<a class="reference internal" href="#alsaaudio.mixers" title="alsaaudio.mixers"><code class="xref py py-func docutils literal notranslate"><span class="pre">mixers()</span></code></a> function. The default value is
<code class="docutils literal notranslate"><span class="pre">'Master'</span></code> - other common controls may be <code class="docutils literal notranslate"><span class="pre">'Master</span> <span class="pre">Mono'</span></code>, <code class="docutils literal notranslate"><span class="pre">'PCM'</span></code>,
<code class="docutils literal notranslate"><span class="pre">'Line'</span></code>, etc.</p></li>
<li><p><em>id</em> - the id of the mixer control. Default is <code class="docutils literal notranslate"><span class="pre">0</span></code>.</p></li>
<li><p><em>cardindex</em> - specifies which card should be used. If this argument
is given, the device name is constructed like this: ‘hw:<em>cardindex</em>’ and
the <cite>device</cite> keyword argument is ignored. <code class="docutils literal notranslate"><span class="pre">0</span></code> is the
first sound card.</p></li>
<li><p><em>device</em> - the name of the device on which the mixer resides. The default
value is <code class="docutils literal notranslate"><span class="pre">'default'</span></code>.</p></li>
</ul>
<p><em>Changed in 0.8</em>:</p>
<ul class="simple">
<li><p>The keyword argument <cite>device</cite> is new and can be used to select virtual
devices.</p></li>
</ul>
</dd></dl>
<p>Mixer objects have the following methods:</p>
<dl class="py method">
<dt id="alsaaudio.Mixer.cardname">
<code class="sig-prename descclassname">Mixer.</code><code class="sig-name descname">cardname</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#alsaaudio.Mixer.cardname" title="Permalink to this definition"></a></dt>
<dd><p>Return the name of the sound card used by this Mixer object</p>
</dd></dl>
<dl class="py method">
<dt id="alsaaudio.Mixer.mixer">
<code class="sig-prename descclassname">Mixer.</code><code class="sig-name descname">mixer</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#alsaaudio.Mixer.mixer" title="Permalink to this definition"></a></dt>
<dd><p>Return the name of the specific mixer controlled by this object, For example
<code class="docutils literal notranslate"><span class="pre">'Master'</span></code> or <code class="docutils literal notranslate"><span class="pre">'PCM'</span></code></p>
</dd></dl>
<dl class="py method">
<dt id="alsaaudio.Mixer.mixerid">
<code class="sig-prename descclassname">Mixer.</code><code class="sig-name descname">mixerid</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#alsaaudio.Mixer.mixerid" title="Permalink to this definition"></a></dt>
<dd><p>Return the ID of the ALSA mixer controlled by this object.</p>
</dd></dl>
<dl class="py method">
<dt id="alsaaudio.Mixer.switchcap">
<code class="sig-prename descclassname">Mixer.</code><code class="sig-name descname">switchcap</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#alsaaudio.Mixer.switchcap" title="Permalink to this definition"></a></dt>
<dd><p>Returns a list of the switches which are defined by this specific mixer.
Possible values in this list are:</p>
<table class="docutils align-default">
<colgroup>
<col style="width: 31%" />
<col style="width: 69%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>Switch</p></th>
<th class="head"><p>Description</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>‘Mute’</p></td>
<td><p>This mixer can mute</p></td>
</tr>
<tr class="row-odd"><td><p>‘Joined Mute’</p></td>
<td><p>This mixer can mute all channels at the same time</p></td>
</tr>
<tr class="row-even"><td><p>‘Playback Mute’</p></td>
<td><p>This mixer can mute the playback output</p></td>
</tr>
<tr class="row-odd"><td><p>‘Joined Playback Mute’</p></td>
<td><p>Mute playback for all channels at the same time}</p></td>
</tr>
<tr class="row-even"><td><p>‘Capture Mute’</p></td>
<td><p>Mute sound capture</p></td>
</tr>
<tr class="row-odd"><td><p>‘Joined Capture Mute’</p></td>
<td><p>Mute sound capture for all channels at a time}</p></td>
</tr>
<tr class="row-even"><td><p>‘Capture Exclusive’</p></td>
<td><p>Not quite sure what this is</p></td>
</tr>
</tbody>
</table>
<p>To manipulate these switches use the <a class="reference internal" href="#alsaaudio.Mixer.setrec" title="alsaaudio.Mixer.setrec"><code class="xref py py-meth docutils literal notranslate"><span class="pre">setrec()</span></code></a> or
<a class="reference internal" href="#alsaaudio.Mixer.setmute" title="alsaaudio.Mixer.setmute"><code class="xref py py-meth docutils literal notranslate"><span class="pre">setmute()</span></code></a> methods</p>
</dd></dl>
<dl class="py method">
<dt id="alsaaudio.Mixer.volumecap">
<code class="sig-prename descclassname">Mixer.</code><code class="sig-name descname">volumecap</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#alsaaudio.Mixer.volumecap" title="Permalink to this definition"></a></dt>
<dd><p>Returns a list of the volume control capabilities of this
mixer. Possible values in the list are:</p>
<table class="docutils align-default">
<colgroup>
<col style="width: 28%" />
<col style="width: 72%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>Capability</p></th>
<th class="head"><p>Description</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>‘Volume’</p></td>
<td><p>This mixer can control volume</p></td>
</tr>
<tr class="row-odd"><td><p>‘Joined Volume’</p></td>
<td><p>This mixer can control volume for all channels at the same time</p></td>
</tr>
<tr class="row-even"><td><p>‘Playback Volume’</p></td>
<td><p>This mixer can manipulate the playback output</p></td>
</tr>
<tr class="row-odd"><td><p>‘Joined Playback Volume’</p></td>
<td><p>Manipulate playback volumne for all channels at the same time</p></td>
</tr>
<tr class="row-even"><td><p>‘Capture Volume’</p></td>
<td><p>Manipulate sound capture volume</p></td>
</tr>
<tr class="row-odd"><td><p>‘Joined Capture Volume’</p></td>
<td><p>Manipulate sound capture volume for all channels at a time</p></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="py method">
<dt id="alsaaudio.Mixer.getenum">
<code class="sig-prename descclassname">Mixer.</code><code class="sig-name descname">getenum</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#alsaaudio.Mixer.getenum" title="Permalink to this definition"></a></dt>
<dd><p>For enumerated controls, return the currently selected item and the list of
items available.</p>
<p>Returns a tuple <em>(string, list of strings)</em>.</p>
<p>For example, my soundcard has a Mixer called <em>Mono Output Select</em>. Using
<em>amixer</em>, I get:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ amixer get &quot;Mono Output Select&quot;
Simple mixer control &#39;Mono Output Select&#39;,0
Capabilities: enum
Items: &#39;Mix&#39; &#39;Mic&#39;
Item0: &#39;Mix&#39;
</pre></div>
</div>
<p>Using <a class="reference internal" href="#module-alsaaudio" title="alsaaudio (Linux)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">alsaaudio</span></code></a>, one could do:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">alsaaudio</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">m</span> <span class="o">=</span> <span class="n">alsaaudio</span><span class="o">.</span><span class="n">Mixer</span><span class="p">(</span><span class="s1">&#39;Mono Output Select&#39;</span><span class="p">)</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">m</span><span class="o">.</span><span class="n">getenum</span><span class="p">()</span>
<span class="go">(&#39;Mix&#39;, [&#39;Mix&#39;, &#39;Mic&#39;])</span>
</pre></div>
</div>
<p>This method will return an empty tuple if the mixer is not an enumerated
control.</p>
</dd></dl>
<dl class="py method">
<dt id="alsaaudio.Mixer.getmute">
<code class="sig-prename descclassname">Mixer.</code><code class="sig-name descname">getmute</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#alsaaudio.Mixer.getmute" title="Permalink to this definition"></a></dt>
<dd><p>Return a list indicating the current mute setting for each
channel. 0 means not muted, 1 means muted.</p>
<p>This method will fail if the mixer has no playback switch capabilities.</p>
</dd></dl>
<dl class="py method">
<dt id="alsaaudio.Mixer.getrange">
<code class="sig-prename descclassname">Mixer.</code><code class="sig-name descname">getrange</code><span class="sig-paren">(</span><span class="optional">[</span><em class="sig-param">direction</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#alsaaudio.Mixer.getrange" title="Permalink to this definition"></a></dt>
<dd><p>Return the volume range of the ALSA mixer controlled by this object.</p>
<p>The optional <em>direction</em> argument can be either <code class="xref py py-const docutils literal notranslate"><span class="pre">PCM_PLAYBACK</span></code> or
<code class="xref py py-const docutils literal notranslate"><span class="pre">PCM_CAPTURE</span></code>, which is relevant if the mixer can control both
playback and capture volume. The default value is <code class="xref py py-const docutils literal notranslate"><span class="pre">PCM_PLAYBACK</span></code>
if the mixer has playback channels, otherwise it is <code class="xref py py-const docutils literal notranslate"><span class="pre">PCM_CAPTURE</span></code>.</p>
</dd></dl>
<dl class="py method">
<dt id="alsaaudio.Mixer.getrec">
<code class="sig-prename descclassname">Mixer.</code><code class="sig-name descname">getrec</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#alsaaudio.Mixer.getrec" title="Permalink to this definition"></a></dt>
<dd><p>Return a list indicating the current record mute setting for each channel. 0
means not recording, 1 means recording.</p>
<p>This method will fail if the mixer has no capture switch capabilities.</p>
</dd></dl>
<dl class="py method">
<dt id="alsaaudio.Mixer.getvolume">
<code class="sig-prename descclassname">Mixer.</code><code class="sig-name descname">getvolume</code><span class="sig-paren">(</span><span class="optional">[</span><em class="sig-param">direction</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#alsaaudio.Mixer.getvolume" title="Permalink to this definition"></a></dt>
<dd><p>Returns a list with the current volume settings for each channel. The list
elements are integer percentages.</p>
<p>The optional <em>direction</em> argument can be either <code class="xref py py-const docutils literal notranslate"><span class="pre">PCM_PLAYBACK</span></code> or
<code class="xref py py-const docutils literal notranslate"><span class="pre">PCM_CAPTURE</span></code>, which is relevant if the mixer can control both
playback and capture volume. The default value is <code class="xref py py-const docutils literal notranslate"><span class="pre">PCM_PLAYBACK</span></code>
if the mixer has playback channels, otherwise it is <code class="xref py py-const docutils literal notranslate"><span class="pre">PCM_CAPTURE</span></code>.</p>
</dd></dl>
<dl class="py method">
<dt id="alsaaudio.Mixer.setvolume">
<code class="sig-prename descclassname">Mixer.</code><code class="sig-name descname">setvolume</code><span class="sig-paren">(</span><em class="sig-param">volume</em><span class="optional">[</span>, <em class="sig-param">channel</em><span class="optional">]</span><span class="optional">[</span>, <em class="sig-param">direction</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#alsaaudio.Mixer.setvolume" title="Permalink to this definition"></a></dt>
<dd><p>Change the current volume settings for this mixer. The <em>volume</em> argument
controls the new volume setting as an integer percentage.</p>
<p>If the optional argument <em>channel</em> is present, the volume is set
only for this channel. This assumes that the mixer can control the
volume for the channels independently.</p>
<p>The optional <em>direction</em> argument can be either <code class="xref py py-const docutils literal notranslate"><span class="pre">PCM_PLAYBACK</span></code> or
<code class="xref py py-const docutils literal notranslate"><span class="pre">PCM_CAPTURE</span></code>, which is relevant if the mixer can control both
playback and capture volume. The default value is <code class="xref py py-const docutils literal notranslate"><span class="pre">PCM_PLAYBACK</span></code>
if the mixer has playback channels, otherwise it is <code class="xref py py-const docutils literal notranslate"><span class="pre">PCM_CAPTURE</span></code>.</p>
</dd></dl>
<dl class="py method">
<dt id="alsaaudio.Mixer.setmute">
<code class="sig-prename descclassname">Mixer.</code><code class="sig-name descname">setmute</code><span class="sig-paren">(</span><em class="sig-param">mute</em><span class="optional">[</span>, <em class="sig-param">channel</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#alsaaudio.Mixer.setmute" title="Permalink to this definition"></a></dt>
<dd><p>Sets the mute flag to a new value. The <em>mute</em> argument is either 0 for not
muted, or 1 for muted.</p>
<p>The optional <em>channel</em> argument controls which channel is
muted. The default is to set the mute flag for all channels.</p>
<p>This method will fail if the mixer has no playback mute capabilities</p>
</dd></dl>
<dl class="py method">
<dt id="alsaaudio.Mixer.setrec">
<code class="sig-prename descclassname">Mixer.</code><code class="sig-name descname">setrec</code><span class="sig-paren">(</span><em class="sig-param">capture</em><span class="optional">[</span>, <em class="sig-param">channel</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#alsaaudio.Mixer.setrec" title="Permalink to this definition"></a></dt>
<dd><p>Sets the capture mute flag to a new value. The <em>capture</em> argument
is either 0 for no capture, or 1 for capture.</p>
<p>The optional <em>channel</em> argument controls which channel is
changed. The default is to set the capture flag for all channels.</p>
<p>This method will fail if the mixer has no capture switch capabilities.</p>
</dd></dl>
<dl class="py method">
<dt id="alsaaudio.Mixer.polldescriptors">
<code class="sig-prename descclassname">Mixer.</code><code class="sig-name descname">polldescriptors</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#alsaaudio.Mixer.polldescriptors" title="Permalink to this definition"></a></dt>
<dd><p>Returns a tuple of <em>(file descriptor, eventmask)</em> that can be used to
wait for changes on the mixer with <em>select.poll</em>.</p>
<p>The <em>eventmask</em> value is compatible with <a class="reference external" href="http://docs.python.org/library/select.html#poll-objects">poll.register</a> in the Python
<code class="xref py py-const docutils literal notranslate"><span class="pre">select</span></code> module.</p>
</dd></dl>
<dl class="py method">
<dt id="alsaaudio.Mixer.handleevents">
<code class="sig-prename descclassname">Mixer.</code><code class="sig-name descname">handleevents</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#alsaaudio.Mixer.handleevents" title="Permalink to this definition"></a></dt>
<dd><p>Acknowledge events on the <em>polldescriptors</em> file descriptors
to prevent subsequent polls from returning the same events again.
Returns the number of events that were acknowledged.</p>
</dd></dl>
<p><strong>A rant on the ALSA Mixer API</strong></p>
<p>The ALSA mixer API is extremely complicated - and hardly documented at all.
<a class="reference internal" href="#module-alsaaudio" title="alsaaudio (Linux)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">alsaaudio</span></code></a> implements a much simplified way to access this API. In
designing the API I’ve had to make some choices which may limit what can and
cannot be controlled through the API. However, if I had chosen to implement the
full API, I would have reexposed the horrible complexity/documentation ratio of
the underlying API. At least the <a class="reference internal" href="#module-alsaaudio" title="alsaaudio (Linux)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">alsaaudio</span></code></a> API is easy to
understand and use.</p>
<p>If my design choises prevents you from doing something that the underlying API
would have allowed, please let me know, so I can incorporate these needs into
future versions.</p>
<p>If the current state of affairs annoys you, the best you can do is to write a
HOWTO on the API and make this available on the net. Until somebody does this,
the availability of ALSA mixer capable devices will stay quite limited.</p>
<p>Unfortunately, I’m not able to create such a HOWTO myself, since I only
understand half of the API, and that which I do understand has come from a
painful trial and error process.</p>
</div>
<div class="section" id="examples">
<span id="pcm-example"></span><h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<p>The following example are provided:</p>
<ul class="simple">
<li><p><cite>playwav.py</cite></p></li>
<li><p><cite>recordtest.py</cite></p></li>
<li><p><cite>playbacktest.py</cite></p></li>
<li><p><cite>mixertest.py</cite></p></li>
</ul>
<p>All examples (except <cite>mixertest.py</cite>) accept the commandline option
<em>-c &lt;cardname&gt;</em>.</p>
<p>To determine a valid card name, use the commandline ALSA player:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ aplay -L
</pre></div>
</div>
<p>or:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ python
&gt;&gt;&gt; import alsaaudio
&gt;&gt;&gt; alsaaudio.pcms()
</pre></div>
</div>
<p>mixertest.py accepts the commandline options <em>-d &lt;device&gt;</em> and
<em>-c &lt;cardindex&gt;</em>.</p>
<div class="section" id="playwav-py">
<h3>playwav.py<a class="headerlink" href="#playwav-py" title="Permalink to this headline"></a></h3>
<p><strong>playwav.py</strong> plays a wav file.</p>
<p>To test PCM playback (on your default soundcard), run:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ python playwav.py &lt;wav file&gt;
</pre></div>
</div>
</div>
<div class="section" id="recordtest-py-and-playbacktest-py">
<h3>recordtest.py and playbacktest.py<a class="headerlink" href="#recordtest-py-and-playbacktest-py" title="Permalink to this headline"></a></h3>
<p><strong>recordtest.py</strong> and <strong>playbacktest.py</strong> will record and play a raw
sound file in CD quality.</p>
<p>To test PCM recordings (on your default soundcard), run:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ python recordtest.py &lt;filename&gt;
</pre></div>
</div>
<p>Speak into the microphone, and interrupt the recording at any time
with <code class="docutils literal notranslate"><span class="pre">Ctl-C</span></code>.</p>
<p>Play back the recording with:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ python playbacktest.py &lt;filename&gt;
</pre></div>
</div>
</div>
<div class="section" id="mixertest-py">
<h3>mixertest.py<a class="headerlink" href="#mixertest-py" title="Permalink to this headline"></a></h3>
<p>Without arguments, <strong>mixertest.py</strong> will list all available <em>controls</em> on the
default soundcard.</p>
<p>The output might look like this:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ ./mixertest.py
Available mixer controls:
&#39;Master&#39;
&#39;Master Mono&#39;
&#39;Headphone&#39;
&#39;PCM&#39;
&#39;Line&#39;
&#39;Line In-&gt;Rear Out&#39;
&#39;CD&#39;
&#39;Mic&#39;
&#39;PC Speaker&#39;
&#39;Aux&#39;
&#39;Mono Output Select&#39;
&#39;Capture&#39;
&#39;Mix&#39;
&#39;Mix Mono&#39;
</pre></div>
</div>
<p>With a single argument - the <em>control</em>, it will display the settings of
that control; for example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ ./mixertest.py Master
Mixer name: &#39;Master&#39;
Capabilities: Playback Volume Playback Mute
Channel 0 volume: 61%
Channel 1 volume: 61%
</pre></div>
</div>
<p>With two arguments, the <em>control</em> and a <em>parameter</em>, it will set the
parameter on the mixer:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ ./mixertest.py Master mute
</pre></div>
</div>
<p>This will mute the Master mixer.</p>
<p>Or:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ ./mixertest.py Master 40
</pre></div>
</div>
<p>This sets the volume to 40% on all channels.</p>
<p>To select a different soundcard, use either the <em>device</em> or <em>cardindex</em>
argument:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ ./mixertest.py -c 0 Master
Mixer name: &#39;Master&#39;
Capabilities: Playback Volume Playback Mute
Channel 0 volume: 61%
Channel 1 volume: 61%
</pre></div>
</div>
<p class="rubric">Footnotes</p>
<dl class="footnote brackets">
<dt class="label" id="f1"><span class="brackets">1</span></dt>
<dd><p>ALSA also allows <code class="docutils literal notranslate"><span class="pre">PCM_ASYNC</span></code>, but this is not supported yet.</p>
</dd>
</dl>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="index.html">alsaaudio documentation</a></h1>
<h3>Navigation</h3>
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="pyalsaaudio.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyalsaaudio.html#what-is-alsa">What is ALSA</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyalsaaudio.html#installation">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyalsaaudio.html#testing">Testing</a></li>
<li class="toctree-l1"><a class="reference internal" href="terminology.html">PCM Terminology and Concepts</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#"><code class="xref py py-mod docutils literal notranslate"><span class="pre">alsaaudio</span></code></a><ul>
<li class="toctree-l2"><a class="reference internal" href="#pcm-objects">PCM Objects</a></li>
<li class="toctree-l2"><a class="reference internal" href="#mixer-objects">Mixer Objects</a></li>
<li class="toctree-l2"><a class="reference internal" href="#examples">Examples</a></li>
</ul>
</li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li>Previous: <a href="terminology.html" title="previous chapter">PCM Terminology and Concepts</a></li>
</ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&copy;2017, Lars Immisch & Casper Wilstrup.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 3.1.2</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
<a href="_sources/libalsaaudio.rst.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>
View Git Blame Copy Permalink