sam-t2/devtools/v9/html/python/lib/module-wave.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-chunk.html" />
<link rel="prev" href="module-sunau.html" />
<link rel="parent" href="mmedia.html" />
<link rel="next" href="Wave-read-objects.html" />
<meta name='aesop' content='information' />
<title>14.5 wave -- Read and write WAV files</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.2 AU_write Objects"
  href="au-write-objects.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. Multimedia Services"
  href="mmedia.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.1 Wave_read Objects"
  href="Wave-read-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="au-write-objects.html">14.4.2 AU_write Objects</A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="mmedia.html">14. Multimedia Services</A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="Wave-read-objects.html">14.5.1 Wave_read Objects</A>
</div>
<hr /></div>
</DIV>
<!--End of Navigation Panel-->

<H1><A NAME="SECTION0016500000000000000000">
14.5 <tt class="module">wave</tt> --
         Read and write WAV files</A>
</H1>

<P>
<A NAME="module-wave"></A>

<P>
The <tt class="module">wave</tt> module provides a convenient interface to the WAV sound
format. It does not support compression/decompression, but it does support
mono/stereo.

<P>
The <tt class="module">wave</tt> module defines the following function and exception:

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-4708' xml:id='l2h-4708' class="function">open</tt></b>(</nobr></td>
  <td><var>file</var><big>[</big><var>, mode</var><big>]</big><var></var>)</td></tr></table></dt>
<dd>
If <var>file</var> is a string, open the file by that name, other treat it
as a seekable file-like object. <var>mode</var> can be any of
<DL>
<DT><STRONG><code>'r'</code>, <code>'rb'</code></STRONG></DT>
<DD>Read only mode.

</DD>
<DT><STRONG><code>'w'</code>, <code>'wb'</code></STRONG></DT>
<DD>Write only mode.
</DD>
</DL>
Note that it does not allow read/write WAV files.

<P>
A <var>mode</var> of <code>'r'</code> or <code>'rb'</code> returns a <tt class="class">Wave_read</tt>
object, while a <var>mode</var> of <code>'w'</code> or <code>'wb'</code> returns
a <tt class="class">Wave_write</tt> object.  If <var>mode</var> is omitted and a file-like
object is passed as <var>file</var>, <code><var>file</var>.mode</code> is used as the
default value for <var>mode</var> (the "<tt class="character">b</tt>" flag is still added if
necessary).
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-4709' xml:id='l2h-4709' class="function">openfp</tt></b>(</nobr></td>
  <td><var>file, mode</var>)</td></tr></table></dt>
<dd>
A synonym for <tt class="function">open()</tt>, maintained for backwards compatibility.
</dl>

<P>
<dl><dt><b><span class="typelabel">exception</span>&nbsp;<tt id='l2h-4710' xml:id='l2h-4710' class="exception">Error</tt></b></dt>
<dd>
An error raised when something is impossible because it violates the
WAV specification or hits an implementation deficiency.
</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="Wave-read-objects.html">14.5.1 Wave_read Objects</a>
<LI><A href="Wave-write-objects.html">14.5.2 Wave_write 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="14.4.2 AU_write Objects"
  href="au-write-objects.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. Multimedia Services"
  href="mmedia.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.1 Wave_read Objects"
  href="Wave-read-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="au-write-objects.html">14.4.2 AU_write Objects</A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="mmedia.html">14. Multimedia Services</A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="Wave-read-objects.html">14.5.1 Wave_read 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>