forked from auracaster/pyalsaaudio
df89c12581
items. Argument parsing errors are reported with the methodname (minor improvement). Smallish documentation improvements. git-svn-id: svn://svn.code.sf.net/p/pyalsaaudio/code/trunk@23 ec2f30ec-7544-0410-870e-f70ca00c83f0
171 lines
6.9 KiB
HTML
171 lines
6.9 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
|
<html>
|
|
<head>
|
|
<link rel="STYLESHEET" href="pyalsaaudio.css" type='text/css' />
|
|
<link rel="first" href="pyalsaaudio.html" title='PyAlsaAudio' />
|
|
<link rel='contents' href='contents.html' title="Contents" />
|
|
<link rel='last' href='about.html' title='About this document...' />
|
|
<link rel='help' href='about.html' title='About this document...' />
|
|
<link rel="prev" href="node5.html" />
|
|
<link rel="parent" href="contents.html" />
|
|
<link rel="next" href="node7.html" />
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
<meta name='aesop' content='information' />
|
|
<title>4 alsaaudio</title>
|
|
</head>
|
|
<body>
|
|
<div class="navigation">
|
|
<div id='top-navigation-panel' xml:id='top-navigation-panel'>
|
|
<table align="center" width="100%" cellpadding="0" cellspacing="2">
|
|
<tr>
|
|
<td class='online-navigation'><a rel="prev" title="3 Installation"
|
|
href="node5.html"><img src='previous.png'
|
|
border='0' height='32' alt='Previous Page' width='32' /></a></td>
|
|
<td class='online-navigation'><a rel="parent" title="Contents"
|
|
href="contents.html"><img src='up.png'
|
|
border='0' height='32' alt='Up one Level' width='32' /></a></td>
|
|
<td class='online-navigation'><a rel="next" title="4.1 pcm Terminology and"
|
|
href="node7.html"><img src='next.png'
|
|
border='0' height='32' alt='Next Page' width='32' /></a></td>
|
|
<td align="center" width="100%">PyAlsaAudio</td>
|
|
<td class='online-navigation'><a rel="contents" title="Table of Contents"
|
|
href="contents.html"><img src='contents.png'
|
|
border='0' height='32' alt='Contents' width='32' /></a></td>
|
|
<td class='online-navigation'><img src='blank.png'
|
|
border='0' height='32' alt='' width='32' /></td>
|
|
<td class='online-navigation'><img src='blank.png'
|
|
border='0' height='32' alt='' width='32' /></td>
|
|
</tr></table>
|
|
<div class='online-navigation'>
|
|
<b class="navlabel">Previous:</b>
|
|
<a class="sectref" rel="prev" href="node5.html">3 Installation</a>
|
|
<b class="navlabel">Up:</b>
|
|
<a class="sectref" rel="parent" href="contents.html">Contents</a>
|
|
<b class="navlabel">Next:</b>
|
|
<a class="sectref" rel="next" href="node7.html">4.1 PCM Terminology and</a>
|
|
</div>
|
|
<hr /></div>
|
|
</div>
|
|
<!--End of Navigation Panel-->
|
|
|
|
<h1><a name="SECTION002400000000000000000">
|
|
4 <tt class="module">alsaaudio</tt></a>
|
|
</h1>
|
|
|
|
<p>
|
|
<a name="module-alsaaudio"></a>
|
|
<p>
|
|
|
|
<p class="availability">Availability: <span
|
|
class="platform">Linux</span>.</p>
|
|
|
|
<p>
|
|
|
|
<p>
|
|
|
|
<p>
|
|
The <tt class="module">alsaaudio</tt> module defines functions and classes for using
|
|
ALSA.
|
|
|
|
<p>
|
|
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
|
|
<td><nobr><b><tt id='l2h-2' xml:id='l2h-2' class="function">mixers</tt></b>(</nobr></td>
|
|
<td><var></var><big>[</big><var>cardname</var><big>]</big><var></var>)</td></tr></table></dt>
|
|
<dd>
|
|
List the available mixers. The optional <var>cardname</var> specifies which
|
|
card should be queried (this is only relevant if you have more than one
|
|
sound card). Omit to use the default sound card.
|
|
</dl>
|
|
|
|
<p>
|
|
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
|
|
<td><nobr><b><span class="typelabel">class</span> <tt id='l2h-3' xml:id='l2h-3' class="class">PCM</tt></b>(</nobr></td>
|
|
<td><var></var><big>[</big><var>type</var><big>]</big><var>, </var><big>[</big><var>mode</var><big>]</big><var>, </var><big>[</big><var>cardname</var><big>]</big><var></var>)</td></tr></table></dt>
|
|
<dd>
|
|
This class is used to represent a PCM device (both playback and
|
|
capture devices).
|
|
The arguments are:
|
|
<br> <var>type</var> - can be either PCM_CAPTURE or PCM_PLAYBACK (default).
|
|
<br> <var>mode</var> - can be either PCM_NONBLOCK, PCM_ASYNC, or PCM_NORMAL (the default).
|
|
<br> <var>cardname</var> - specifies which card should be used (this is only
|
|
relevant if you have more than one sound card). Omit to use the
|
|
default sound card
|
|
</dl>
|
|
|
|
<p>
|
|
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
|
|
<td><nobr><b><span class="typelabel">class</span> <tt id='l2h-4' xml:id='l2h-4' class="class">Mixer</tt></b>(</nobr></td>
|
|
<td><var></var><big>[</big><var>control</var><big>]</big><var>, </var><big>[</big><var>id</var><big>]</big><var>, </var><big>[</big><var>cardname</var><big>]</big><var></var>)</td></tr></table></dt>
|
|
<dd>
|
|
This class is used to access a specific ALSA mixer.
|
|
The arguments are:
|
|
<br><var>control</var> - Name of the chosen mixed (default is Master).
|
|
<br><var>id</var> - id of mixer (default is 0) - More explanation needed here
|
|
<br><var>cardname</var> specifies which card should be used (this is only relevant
|
|
if you have more than one sound card). Omit to use the default sound card
|
|
</dl>
|
|
|
|
<p>
|
|
<dl><dt><b><span class="typelabel">exception</span> <tt id='l2h-5' xml:id='l2h-5' class="exception">ALSAAudioError</tt></b></dt>
|
|
<dd>
|
|
Exception raised when an operation fails for a ALSA specific reason.
|
|
The exception argument is a string describing the reason of the
|
|
failure.
|
|
</dd></dl>
|
|
|
|
<p>
|
|
|
|
<p><br /></p><hr class='online-navigation' />
|
|
<div class='online-navigation'>
|
|
<!--Table of Child-Links-->
|
|
<a name="CHILD_LINKS"><strong>Subsections</strong></a>
|
|
|
|
<ul class="ChildLinks">
|
|
<li><a href="node7.html">4.1 PCM Terminology and Concepts</a>
|
|
<li><a href="pcm-objects.html">4.2 PCM Objects</a>
|
|
<li><a href="mixer-objects.html">4.3 Mixer Objects</a>
|
|
<li><a href="pcm-example.html">4.4 ALSA Examples</a>
|
|
</ul>
|
|
<!--End of Table of Child-Links-->
|
|
</div>
|
|
|
|
<div class="navigation">
|
|
<div class='online-navigation'>
|
|
<p></p><hr />
|
|
<table align="center" width="100%" cellpadding="0" cellspacing="2">
|
|
<tr>
|
|
<td class='online-navigation'><a rel="prev" title="3 Installation"
|
|
href="node5.html"><img src='previous.png'
|
|
border='0' height='32' alt='Previous Page' width='32' /></a></td>
|
|
<td class='online-navigation'><a rel="parent" title="Contents"
|
|
href="contents.html"><img src='up.png'
|
|
border='0' height='32' alt='Up one Level' width='32' /></a></td>
|
|
<td class='online-navigation'><a rel="next" title="4.1 pcm Terminology and"
|
|
href="node7.html"><img src='next.png'
|
|
border='0' height='32' alt='Next Page' width='32' /></a></td>
|
|
<td align="center" width="100%">PyAlsaAudio</td>
|
|
<td class='online-navigation'><a rel="contents" title="Table of Contents"
|
|
href="contents.html"><img src='contents.png'
|
|
border='0' height='32' alt='Contents' width='32' /></a></td>
|
|
<td class='online-navigation'><img src='blank.png'
|
|
border='0' height='32' alt='' width='32' /></td>
|
|
<td class='online-navigation'><img src='blank.png'
|
|
border='0' height='32' alt='' width='32' /></td>
|
|
</tr></table>
|
|
<div class='online-navigation'>
|
|
<b class="navlabel">Previous:</b>
|
|
<a class="sectref" rel="prev" href="node5.html">3 Installation</a>
|
|
<b class="navlabel">Up:</b>
|
|
<a class="sectref" rel="parent" href="contents.html">Contents</a>
|
|
<b class="navlabel">Next:</b>
|
|
<a class="sectref" rel="next" href="node7.html">4.1 PCM Terminology and</a>
|
|
</div>
|
|
</div>
|
|
<hr />
|
|
<span class="release-info">Release 0.4.</span>
|
|
</div>
|
|
<!--End of Navigation Panel-->
|
|
|
|
</body>
|
|
</html>
|