sam-t2/devtools/v9/html/python/lib/module-al.html

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<link rel="STYLESHEET" href="lib.css" type='text/css' />
<link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" />
<link rel='start' href='../index.html' title='Python Documentation Index' />
<link rel="first" href="lib.html" title='Python Library Reference' />
<link rel='contents' href='contents.html' title="Contents" />
<link rel='index' href='genindex.html' title='Index' />
<link rel='last' href='about.html' title='About this document...' />
<link rel='help' href='about.html' title='About this document...' />
<link rel="next" href="module-al-constants.html" />
<link rel="prev" href="sgi.html" />
<link rel="parent" href="sgi.html" />
<link rel="next" href="al-config-objects.html" />
<meta name='aesop' content='information' />
<title>20.1 al -- Audio functions on the SGI</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="20. SGI IRIX Specific"
  href="sgi.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></A></td>
<td class='online-navigation'><a rel="parent" title="20. SGI IRIX Specific"
  href="sgi.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up One Level' width='32' /></A></td>
<td class='online-navigation'><a rel="next" title="20.1.1 Configuration Objects"
  href="al-config-objects.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></A></td>
<td align="center" width="100%">Python Library Reference</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></A></td>
<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
  border='0' height='32'  alt='Module Index' width='32' /></a></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></A></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="sgi.html">20. SGI IRIX Specific</A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="sgi.html">20. SGI IRIX Specific</A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="al-config-objects.html">20.1.1 Configuration Objects</A>
</div>
<hr /></div>
</DIV>
<!--End of Navigation Panel-->

<H1><A NAME="SECTION0022100000000000000000">
20.1 <tt class="module">al</tt> --
         Audio functions on the SGI</A>
</H1>

<P>
<A NAME="module-al"></A>
<p class="availability">Availability: <span
 class="platform">IRIX</span>.</p>

<P>
This module provides access to the audio facilities of the SGI Indy
and Indigo workstations.  See section 3A of the IRIX man pages for
details.  You'll need to read those man pages to understand what these
functions do!  Some of the functions are not available in IRIX
releases before 4.0.5.  Again, see the manual to check whether a
specific function is available on your platform.

<P>
All functions and methods defined in this module are equivalent to
the C functions with "<tt class="samp">AL</tt>" prefixed to their name.

<P>
Symbolic constants from the C header file <code>&lt;audio.h&gt;</code> are
defined in the standard module
<tt class="module"><a href="module-al-constants.html">AL</a></tt><a id='l2h-5043' xml:id='l2h-5043'></a>, see below.

<P>
<span class="warning"><b class="label">Warning:</b>
The current version of the audio library may dump core
when bad argument values are passed rather than returning an error
status.  Unfortunately, since the precise circumstances under which
this may happen are undocumented and hard to check, the Python
interface can provide no protection against this kind of problems.
(One example is specifying an excessive queue size -- there is no
documented upper limit.)</span>

<P>
The module defines the following functions:

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-5038' xml:id='l2h-5038' class="function">openport</tt></b>(</nobr></td>
  <td><var>name, direction</var><big>[</big><var>, config</var><big>]</big><var></var>)</td></tr></table></dt>
<dd>
The name and direction arguments are strings.  The optional
<var>config</var> argument is a configuration object as returned by
<tt class="function">newconfig()</tt>.  The return value is an <i class="dfn">audio port
object</i>; methods of audio port objects are described below.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-5039' xml:id='l2h-5039' class="function">newconfig</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>
The return value is a new <i class="dfn">audio configuration object</i>; methods of
audio configuration objects are described below.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-5040' xml:id='l2h-5040' class="function">queryparams</tt></b>(</nobr></td>
  <td><var>device</var>)</td></tr></table></dt>
<dd>
The device argument is an integer.  The return value is a list of
integers containing the data returned by <tt class="cfunction">ALqueryparams()</tt>.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-5041' xml:id='l2h-5041' class="function">getparams</tt></b>(</nobr></td>
  <td><var>device, list</var>)</td></tr></table></dt>
<dd>
The <var>device</var> argument is an integer.  The list argument is a list
such as returned by <tt class="function">queryparams()</tt>; it is modified in place
(!).
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-5042' xml:id='l2h-5042' class="function">setparams</tt></b>(</nobr></td>
  <td><var>device, list</var>)</td></tr></table></dt>
<dd>
The <var>device</var> argument is an integer.  The <var>list</var> argument is a
list such as returned by <tt class="function">queryparams()</tt>.
</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="al-config-objects.html">20.1.1 Configuration Objects</a>
<LI><A href="al-port-objects.html">20.1.2 Port Objects</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="20. SGI IRIX Specific"
  href="sgi.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></A></td>
<td class='online-navigation'><a rel="parent" title="20. SGI IRIX Specific"
  href="sgi.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up One Level' width='32' /></A></td>
<td class='online-navigation'><a rel="next" title="20.1.1 Configuration Objects"
  href="al-config-objects.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></A></td>
<td align="center" width="100%">Python Library Reference</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></A></td>
<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
  border='0' height='32'  alt='Module Index' width='32' /></a></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></A></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="sgi.html">20. SGI IRIX Specific</A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="sgi.html">20. SGI IRIX Specific</A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="al-config-objects.html">20.1.1 Configuration Objects</A>
</div>
</div>
<hr />
<span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span>
</DIV>
<!--End of Navigation Panel-->
<ADDRESS>
See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
</ADDRESS>
</BODY>
</HTML>