sam-t2/devtools/v8plus/html/python/lib/au-read-objects.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="au-write-objects.html" />
<link rel="prev" href="module-sunau.html" />
<link rel="parent" href="module-sunau.html" />
<link rel="next" href="au-write-objects.html" />
<meta name='aesop' content='information' />
<title>14.4.1 AU_read 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 class='online-navigation'><a rel="prev" title="14.4 sunau  "
  href="module-sunau.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="14.4 sunau  "
  href="module-sunau.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="14.4.2 AU_write Objects"
  href="au-write-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="module-sunau.html">14.4 sunau  </A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="module-sunau.html">14.4 sunau  </A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="au-write-objects.html">14.4.2 AU_write Objects</A>
</div>
<hr /></div>
</DIV>
<!--End of Navigation Panel-->

<H2><A NAME="SECTION0016410000000000000000"></A><A NAME="au-read-objects"></A>
<BR>
14.4.1 AU_read Objects
</H2>

<P>
AU_read objects, as returned by <tt class="function">open()</tt> above, have the
following methods:

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-4683' xml:id='l2h-4683' class="method">close</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>
Close the stream, and make the instance unusable. (This is
called automatically on deletion.)
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-4684' xml:id='l2h-4684' class="method">getnchannels</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>
Returns number of audio channels (1 for mone, 2 for stereo).
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-4685' xml:id='l2h-4685' class="method">getsampwidth</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>
Returns sample width in bytes.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-4686' xml:id='l2h-4686' class="method">getframerate</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>
Returns sampling frequency.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-4687' xml:id='l2h-4687' class="method">getnframes</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>
Returns number of audio frames.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-4688' xml:id='l2h-4688' class="method">getcomptype</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>
Returns compression type.
Supported compression types are <code>'ULAW'</code>, <code>'ALAW'</code> and <code>'NONE'</code>.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-4689' xml:id='l2h-4689' class="method">getcompname</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>
Human-readable version of <tt class="method">getcomptype()</tt>.
The supported types have the respective names <code>'CCITT G.711
u-law'</code>, <code>'CCITT G.711 A-law'</code> and <code>'not compressed'</code>.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-4690' xml:id='l2h-4690' class="method">getparams</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>
Returns a tuple <code>(<var>nchannels</var>, <var>sampwidth</var>,
<var>framerate</var>, <var>nframes</var>, <var>comptype</var>, <var>compname</var>)</code>,
equivalent to output of the <tt class="method">get*()</tt> methods.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-4691' xml:id='l2h-4691' class="method">readframes</tt></b>(</nobr></td>
  <td><var>n</var>)</td></tr></table></dt>
<dd>
Reads and returns at most <var>n</var> frames of audio, as a string of
bytes.  The data will be returned in linear format.  If the original
data is in u-LAW format, it will be converted.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-4692' xml:id='l2h-4692' class="method">rewind</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>
Rewind the file pointer to the beginning of the audio stream.
</dl>

<P>
The following two methods define a term ``position'' which is compatible
between them, and is otherwise implementation dependent.

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-4693' xml:id='l2h-4693' class="method">setpos</tt></b>(</nobr></td>
  <td><var>pos</var>)</td></tr></table></dt>
<dd>
Set the file pointer to the specified position.  Only values returned
from <tt class="method">tell()</tt> should be used for <var>pos</var>.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-4694' xml:id='l2h-4694' class="method">tell</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>
Return current file pointer position.  Note that the returned value
has nothing to do with the actual position in the file.
</dl>

<P>
The following two functions are defined for compatibility with the
<tt class="module"><a href="module-aifc.html">aifc</a></tt>, and don't do anything interesting.

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-4695' xml:id='l2h-4695' class="method">getmarkers</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>
Returns <code>None</code>.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-4696' xml:id='l2h-4696' class="method">getmark</tt></b>(</nobr></td>
  <td><var>id</var>)</td></tr></table></dt>
<dd>
Raise an error.
</dl>

<P>

<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="14.4 sunau  "
  href="module-sunau.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="14.4 sunau  "
  href="module-sunau.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="14.4.2 AU_write Objects"
  href="au-write-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="module-sunau.html">14.4 sunau  </A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="module-sunau.html">14.4 sunau  </A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="au-write-objects.html">14.4.2 AU_write 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>