sam-t2/devtools/v8plus/html/python/lib/Wave-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="Wave-write-objects.html" />
<link rel="prev" href="module-wave.html" />
<link rel="parent" href="module-wave.html" />
<link rel="next" href="Wave-write-objects.html" />
<meta name='aesop' content='information' />
<title>14.5.1 Wave_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.5 wave  "
  href="module-wave.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.5 wave  "
  href="module-wave.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.5.2 Wave_write Objects"
  href="Wave-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-wave.html">14.5 wave  </A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="module-wave.html">14.5 wave  </A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="Wave-write-objects.html">14.5.2 Wave_write Objects</A>
</div>
<hr /></div>
</DIV>
<!--End of Navigation Panel-->

<H2><A NAME="SECTION0016510000000000000000"></A><A NAME="Wave-read-objects"></A>
<BR>
14.5.1 Wave_read Objects
</H2>

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

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-4711' xml:id='l2h-4711' 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 object collection.
</dl>

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

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-4713' xml:id='l2h-4713' 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-4714' xml:id='l2h-4714' 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-4715' xml:id='l2h-4715' 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-4716' xml:id='l2h-4716' class="method">getcomptype</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>
Returns compression type (<code>'NONE'</code> is the only supported type).
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-4717' xml:id='l2h-4717' class="method">getcompname</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>
Human-readable version of <tt class="method">getcomptype()</tt>.
Usually <code>'not compressed'</code> parallels <code>'NONE'</code>.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-4718' xml:id='l2h-4718' 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-4719' xml:id='l2h-4719' 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.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-4720' xml:id='l2h-4720' 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 are defined for compatibility with the
<tt class="module"><a href="module-aifc.html">aifc</a></tt> module, and don't do anything interesting.

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-4721' xml:id='l2h-4721' 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-4722' xml:id='l2h-4722' class="method">getmark</tt></b>(</nobr></td>
  <td><var>id</var>)</td></tr></table></dt>
<dd>
Raise an error.
</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-4723' xml:id='l2h-4723' class="method">setpos</tt></b>(</nobr></td>
  <td><var>pos</var>)</td></tr></table></dt>
<dd>
Set the file pointer to the specified position.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-4724' xml:id='l2h-4724' class="method">tell</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>
Return current file pointer position.
</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.5 wave  "
  href="module-wave.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.5 wave  "
  href="module-wave.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.5.2 Wave_write Objects"
  href="Wave-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-wave.html">14.5 wave  </A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="module-wave.html">14.5 wave  </A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="Wave-write-objects.html">14.5.2 Wave_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>