auracaster/pyalsaaudio
3
0
Fork 1
mirror of https://github.com/larsimmisch/pyalsaaudio.git synced 2026-04-19 01:14:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Import from divmod. Added css. Original log message:

Browse Source 
r1585 | casper | 2005-07-09 23:26:15 +0200 (Sat, 09 Jul 2005) | 3 lines

Last checkin before version 0.2





git-svn-id: svn://svn.code.sf.net/p/pyalsaaudio/code/trunk@12 ec2f30ec-7544-0410-870e-f70ca00c83f0
This commit is contained in:
larsimmisch
2008-01-24 12:22:41 +00:00
parent 470d6140df
commit 8fa9d27a88
24 changed files with 1192 additions and 820 deletions
Download Patch File Download Diff File Expand all files Collapse all files

230
doc/mixer-objects.html
View File

@@ -1,53 +1,55 @@
<!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="next" href="pcm-example.html">
<LINK REL="prev" href="pcm-objects.html">
<LINK REL="parent" href="module-alsaaudio.html">
<LINK REL="next" href="pcm-example.html">
<meta name='aesop' content='information'>
<META NAME="description" CONTENT="Mixer Objects">
<META NAME="keywords" CONTENT="pyalsaaudio">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
<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="next" href="pcm-example.html" />
<link rel="prev" href="pcm-objects.html" />
<link rel="parent" href="module-alsaaudio.html" />
<link rel="next" href="pcm-example.html" />
<meta name='aesop' content='information' />
<title>4.3 Mixer Objects</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><a rel="prev" title="4.2 PCM Objects"
href="pcm-objects.html"><img src='previous.gif'
border='0' height='32' alt='Previous Page' width='32'></A></td>
<td><a rel="parent" title="4 alsaaudio"
href="module-alsaaudio.html"><img src='up.gif'
border='0' height='32' alt='Up One Level' width='32'></A></td>
<td><a rel="next" title="4.4 ALSA Examples"
href="pcm-example.html"><img src='next.gif'
border='0' height='32' alt='Next Page' width='32'></A></td>
<td class='online-navigation'><a rel="prev" title="4.2 PCM Objects"
href="pcm-objects.html"><img src='previous.png'
border='0' height='32' alt='Previous Page' width='32' /></A></td>
<td class='online-navigation'><a rel="parent" title="4 alsaaudio"
href="module-alsaaudio.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.4 ALSA Examples"
href="pcm-example.html"><img src='next.png'
border='0' height='32' alt='Next Page' width='32' /></A></td>
<td align="center" width="100%">PyAlsaAudio</td>
<td><a rel="contents" title="Table of Contents"
href="contents.html"><img src='contents.gif'
border='0' height='32' alt='Contents' width='32'></A></td>
<td><img src='blank.gif'
border='0' height='32' alt='' width='32'></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="pcm-objects.html">4.2 PCM Objects</A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="module-alsaaudio.html">4 alsaaudio</A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="pcm-example.html">4.4 ALSA Examples</A>
<br><hr>
</div>
<hr /></div>
</DIV>
<!--End of Navigation Panel-->
<H2><A NAME="SECTION002430000000000000000">&nbsp;</A>
<H2><A NAME="SECTION002430000000000000000"></A>
<A NAME="mixer-objects"></A>
<BR>
4.3 Mixer Objects
</H2>
@@ -57,8 +59,8 @@ Mixer objects provides access to the ALSA mixer API.
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><span class="typelabel">class</span>&nbsp;<a name="l2h-16"><tt class="class">Mixer</tt></a></b>(</nobr></td>
<td><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>)</td></tr></table>
<td><nobr><b><span class="typelabel">class</span>&nbsp;<tt id='l2h-16' xml:id='l2h-16' 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>
<var>control</var> - specifies which control to manipulate using this mixer object. The list
of available controls can be found with the <tt class="module">alsaaudio</tt>.<tt class="function">mixers</tt> function.
@@ -77,16 +79,16 @@ Mixer objects have the following methods:
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><a name="l2h-17"><tt class="method">cardname</tt></a></b>(</nobr></td>
<td>)</td></tr></table>
<td><nobr><b><tt id='l2h-17' xml:id='l2h-17' class="method">cardname</tt></b>(</nobr></td>
<td><var></var>)</td></tr></table></dt>
<dd>
Return the name of the sound card used by this Mixer object
</dl>
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><a name="l2h-18"><tt class="method">mixer</tt></a></b>(</nobr></td>
<td>)</td></tr></table>
<td><nobr><b><tt id='l2h-18' xml:id='l2h-18' class="method">mixer</tt></b>(</nobr></td>
<td><var></var>)</td></tr></table></dt>
<dd>
Return the name of the specific mixer controlled by this object, For example 'Master'
or 'PCM'
@@ -94,44 +96,44 @@ or 'PCM'
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><a name="l2h-19"><tt class="method">mixerid</tt></a></b>(</nobr></td>
<td>)</td></tr></table>
<td><nobr><b><tt id='l2h-19' xml:id='l2h-19' class="method">mixerid</tt></b>(</nobr></td>
<td><var></var>)</td></tr></table></dt>
<dd>
Return the ID of the ALSA mixer controlled by this object.
</dl>
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><a name="l2h-20"><tt class="method">switchcap</tt></a></b>(</nobr></td>
<td>)</td></tr></table>
<td><nobr><b><tt id='l2h-20' xml:id='l2h-20' class="method">switchcap</tt></b>(</nobr></td>
<td><var></var>)</td></tr></table></dt>
<dd>
Returns a list of the switches which are defined by this specific mixer. Possible values in
this list are:
<P>
<table border align="center" style="border-collapse: collapse">
<div class="center"><table class="realtable">
<thead>
<tr class="tableheader">
<th align="left"><b>Switch</b>&nbsp;</th>
<th align="left"><b>Description</b>&nbsp;</th>
<tr>
<th class="left" >Switch</th>
<th class="left" >Description</th>
</tr>
</thead>
<tbody valign="baseline">
<tr><td align="left" valign="baseline"><Volume Capabilities>'Mute'</Volume></td>
<td align="left">This mixer can be muted</td>
<tr><td align="left" valign="baseline"><Volume Capabilities>'Joined Mute'</Volume></td>
<td align="left">This mixer can mute all channels at the same time</td>
<tr><td align="left" valign="baseline"><Volume Capabilities>'Playback Mute'</Volume></td>
<td align="left">This mixer can mute the playback output</td>
<tr><td align="left" valign="baseline"><Volume Capabilities>'Joined Playback Mute'</Volume></td>
<td align="left">Mute playback for all channels at the same time</td>
<tr><td align="left" valign="baseline"><Volume Capabilities>'Capture Mute'</Volume></td>
<td align="left">Mute sound capture</td>
<tr><td align="left" valign="baseline"><Volume Capabilities>'Joined Capture Mute'</Volume></td>
<td align="left">Mute sound capture for all channels at a time</td>
<tr><td align="left" valign="baseline"><Volume Capabilities>'Capture Exclusive'</Volume></td>
<td align="left">Not quite sure what this is</td></tbody>
</table>
<tbody>
<tr><td class="left" valign="baseline"><Volume Capabilities>'Mute'</Volume></td>
<td class="left" >This mixer can be muted</td></tr>
<tr><td class="left" valign="baseline"><Volume Capabilities>'Joined Mute'</Volume></td>
<td class="left" >This mixer can mute all channels at the same time</td></tr>
<tr><td class="left" valign="baseline"><Volume Capabilities>'Playback Mute'</Volume></td>
<td class="left" >This mixer can mute the playback output</td></tr>
<tr><td class="left" valign="baseline"><Volume Capabilities>'Joined Playback Mute'</Volume></td>
<td class="left" >Mute playback for all channels at the same time</td></tr>
<tr><td class="left" valign="baseline"><Volume Capabilities>'Capture Mute'</Volume></td>
<td class="left" >Mute sound capture</td></tr>
<tr><td class="left" valign="baseline"><Volume Capabilities>'Joined Capture Mute'</Volume></td>
<td class="left" >Mute sound capture for all channels at a time</td></tr>
<tr><td class="left" valign="baseline"><Volume Capabilities>'Capture Exclusive'</Volume></td>
<td class="left" >Not quite sure what this is</td></tr></tbody>
</table></div>
<P>
To manipulate these swithes use the <tt class="method">setrec</tt> or <tt class="method">setmute</tt> methods
@@ -139,42 +141,42 @@ To manipulate these swithes use the <tt class="method">setrec</tt> or <tt class=
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><a name="l2h-21"><tt class="method">volumecap</tt></a></b>(</nobr></td>
<td>)</td></tr></table>
<td><nobr><b><tt id='l2h-21' xml:id='l2h-21' class="method">volumecap</tt></b>(</nobr></td>
<td><var></var>)</td></tr></table></dt>
<dd>
Returns a list of the volume control capabilities of this mixer. Possible values in
the list are:
<P>
<table border align="center" style="border-collapse: collapse">
<div class="center"><table class="realtable">
<thead>
<tr class="tableheader">
<th align="left"><b>Capability</b>&nbsp;</th>
<th align="left"><b>Description</b>&nbsp;</th>
<tr>
<th class="left" >Capability</th>
<th class="left" >Description</th>
</tr>
</thead>
<tbody valign="baseline">
<tr><td align="left" valign="baseline"><Volume Capabilities>'Volume'</Volume></td>
<td align="left">This mixer can control volume</td>
<tr><td align="left" valign="baseline"><Volume Capabilities>'Joined Volume'</Volume></td>
<td align="left">This mixer can control volume for all channels at the same time</td>
<tr><td align="left" valign="baseline"><Volume Capabilities>'Playback Volume'</Volume></td>
<td align="left">This mixer can manipulate the playback volume</td>
<tr><td align="left" valign="baseline"><Volume Capabilities>'Joined Playback Volume'</Volume></td>
<td align="left">Manipulate playback volumne for all channels at the same time</td>
<tr><td align="left" valign="baseline"><Volume Capabilities>'Capture Volume'</Volume></td>
<td align="left">Manipulate sound capture volume</td>
<tr><td align="left" valign="baseline"><Volume Capabilities>'Joined Capture Volume'</Volume></td>
<td align="left">Manipulate sound capture volume for all channels at a time</td></tbody>
</table>
<tbody>
<tr><td class="left" valign="baseline"><Volume Capabilities>'Volume'</Volume></td>
<td class="left" >This mixer can control volume</td></tr>
<tr><td class="left" valign="baseline"><Volume Capabilities>'Joined Volume'</Volume></td>
<td class="left" >This mixer can control volume for all channels at the same time</td></tr>
<tr><td class="left" valign="baseline"><Volume Capabilities>'Playback Volume'</Volume></td>
<td class="left" >This mixer can manipulate the playback volume</td></tr>
<tr><td class="left" valign="baseline"><Volume Capabilities>'Joined Playback Volume'</Volume></td>
<td class="left" >Manipulate playback volumne for all channels at the same time</td></tr>
<tr><td class="left" valign="baseline"><Volume Capabilities>'Capture Volume'</Volume></td>
<td class="left" >Manipulate sound capture volume</td></tr>
<tr><td class="left" valign="baseline"><Volume Capabilities>'Joined Capture Volume'</Volume></td>
<td class="left" >Manipulate sound capture volume for all channels at a time</td></tr></tbody>
</table></div>
<P>
</dl>
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><a name="l2h-22"><tt class="method">getvolume</tt></a></b>(</nobr></td>
<td><big>[</big><var>direction</var><big>]</big>)</td></tr></table>
<td><nobr><b><tt id='l2h-22' xml:id='l2h-22' class="method">getvolume</tt></b>(</nobr></td>
<td><var></var><big>[</big><var>direction</var><big>]</big><var></var>)</td></tr></table></dt>
<dd>
Returns a list with the current volume settings for each channel. The list elements
are integer percentages.
@@ -189,8 +191,8 @@ if the mixer has this capability, otherwise 'capture'
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><a name="l2h-23"><tt class="method">getmute</tt></a></b>(</nobr></td>
<td>)</td></tr></table>
<td><nobr><b><tt id='l2h-23' xml:id='l2h-23' class="method">getmute</tt></b>(</nobr></td>
<td><var></var>)</td></tr></table></dt>
<dd>
Return a list indicating the current mute setting for each channel. 0 means not muted, 1 means muted.
@@ -200,8 +202,8 @@ This method will fail if the mixer has no playback switch capabilities.
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><a name="l2h-24"><tt class="method">getrec</tt></a></b>(</nobr></td>
<td>)</td></tr></table>
<td><nobr><b><tt id='l2h-24' xml:id='l2h-24' class="method">getrec</tt></b>(</nobr></td>
<td><var></var>)</td></tr></table></dt>
<dd>
Return a list indicating the current record mute setting for each channel. 0 means not recording, 1
means not recording.
@@ -212,8 +214,8 @@ This method will fail if the mixer has no capture switch capabilities.
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><a name="l2h-25"><tt class="method">setvolume</tt></a></b>(</nobr></td>
<td><var>volume,</var><big>[</big><var>channel</var><big>]</big><var>,</var><big>[</big><var>direction</var><big>]</big>)</td></tr></table>
<td><nobr><b><tt id='l2h-25' xml:id='l2h-25' class="method">setvolume</tt></b>(</nobr></td>
<td><var>volume,</var><big>[</big><var>channel</var><big>]</big><var>,</var><big>[</big><var>direction</var><big>]</big><var></var>)</td></tr></table></dt>
<dd>
Change the current volume settings for this mixer. The <var>volume</var> argument controls
the new volume setting as an integer percentage.
@@ -230,8 +232,8 @@ if changed. The default is 'playback' if the mixer has this capability, otherwis
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><a name="l2h-26"><tt class="method">setmute</tt></a></b>(</nobr></td>
<td><var>mute, </var><big>[</big><var>channel</var><big>]</big>)</td></tr></table>
<td><nobr><b><tt id='l2h-26' xml:id='l2h-26' class="method">setmute</tt></b>(</nobr></td>
<td><var>mute, </var><big>[</big><var>channel</var><big>]</big><var></var>)</td></tr></table></dt>
<dd>
Sets the mute flag to a new value. The <var>mute</var> argument is either 0 for not muted, or 1 for muted.
@@ -245,8 +247,8 @@ This method will fail if the mixer has no playback mute capabilities
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><a name="l2h-27"><tt class="method">setrec</tt></a></b>(</nobr></td>
<td><var>capture,</var><big>[</big><var>channel</var><big>]</big>)</td></tr></table>
<td><nobr><b><tt id='l2h-27' xml:id='l2h-27' class="method">setrec</tt></b>(</nobr></td>
<td><var>capture,</var><big>[</big><var>channel</var><big>]</big><var></var>)</td></tr></table></dt>
<dd>
Sets the capture mute flag to a new value. The <var>capture</var> argument is either 0 for no capture,
or 1 for capture.
@@ -285,37 +287,39 @@ and that which I do understand has come from a painful trial and error process.
<P>
<DIV CLASS="navigation">
<p><hr>
<div class='online-navigation'>
<p></p><hr />
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td><a rel="prev" title="4.2 PCM Objects"
rel="prev" title="4.2 PCM Objects"
href="pcm-objects.html"><img src='previous.gif'
border='0' height='32' alt='Previous Page' width='32'></A></td>
<td><a rel="parent" title="4 alsaaudio"
rel="parent" title="4 alsaaudio"
href="module-alsaaudio.html"><img src='up.gif'
border='0' height='32' alt='Up One Level' width='32'></A></td>
<td><a rel="next" title="4.4 ALSA Examples"
rel="next" title="4.4 ALSA Examples"
href="pcm-example.html"><img src='next.gif'
border='0' height='32' alt='Next Page' width='32'></A></td>
<td class='online-navigation'><a rel="prev" title="4.2 PCM Objects"
href="pcm-objects.html"><img src='previous.png'
border='0' height='32' alt='Previous Page' width='32' /></A></td>
<td class='online-navigation'><a rel="parent" title="4 alsaaudio"
href="module-alsaaudio.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.4 ALSA Examples"
href="pcm-example.html"><img src='next.png'
border='0' height='32' alt='Next Page' width='32' /></A></td>
<td align="center" width="100%">PyAlsaAudio</td>
<td><a rel="contents" title="Table of Contents"
rel="contents" title="Table of Contents"
href="contents.html"><img src='contents.gif'
border='0' height='32' alt='Contents' width='32'></A></td>
<td><img src='blank.gif'
border='0' height='32' alt='' width='32'></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="pcm-objects.html">4.2 PCM Objects</A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="module-alsaaudio.html">4 alsaaudio</A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="pcm-example.html">4.4 ALSA Examples</A>
<hr>
<span class="release-info">Release 0.1.</span>
</div>
</div>
<hr />
<span class="release-info">Release 0.2.</span>
</DIV>
<!--End of Navigation Panel-->