sam-t2/devtools/amd64/html/python/lib/module-sndhdr.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-ossaudiodev.html" />
<link rel="prev" href="module-imghdr.html" />
<link rel="parent" href="mmedia.html" />
<link rel="next" href="module-ossaudiodev.html" />
<meta name='aesop' content='information' />
<title>14.10 sndhdr -- Determine type of sound file</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.9 imghdr  "
  href="module-imghdr.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.11 ossaudiodev  "
  href="module-ossaudiodev.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-imghdr.html">14.9 imghdr  </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="module-ossaudiodev.html">14.11 ossaudiodev  </A>
</div>
<hr /></div>
</DIV>
<!--End of Navigation Panel-->

<H1><A NAME="SECTION00161000000000000000000">
14.10 <tt class="module">sndhdr</tt> --
         Determine type of sound file</A>
</H1>

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

<P>
The <tt class="module">sndhdr</tt> provides utility functions which attempt to
determine the type of sound data which is in a file.  When these
functions are able to determine what type of sound data is stored in a
file, they return a tuple <code>(<var>type</var>, <var>sampling_rate</var>,
<var>channels</var>, <var>frames</var>, <var>bits_per_sample</var>)</code>.  The value for
<var>type</var> indicates the data type and will be one of the strings
<code>'aifc'</code>, <code>'aiff'</code>, <code>'au'</code>, <code>'hcom'</code>,
<code>'sndr'</code>, <code>'sndt'</code>, <code>'voc'</code>, <code>'wav'</code>,
<code>'8svx'</code>, <code>'sb'</code>, <code>'ub'</code>, or <code>'ul'</code>.  The
<var>sampling_rate</var> will be either the actual value or <code>0</code> if
unknown or difficult to decode.  Similarly, <var>channels</var> will be
either the number of channels or <code>0</code> if it cannot be determined
or if the value is difficult to decode.  The value for <var>frames</var>
will be either the number of frames or <code>-1</code>.  The last item in
the tuple, <var>bits_per_sample</var>, will either be the sample size in
bits or <code>'A'</code> for A-LAW<a id='l2h-4767' xml:id='l2h-4767'></a> or <code>'U'</code> for
u-LAW<a id='l2h-4768' xml:id='l2h-4768'></a>.

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-4765' xml:id='l2h-4765' class="function">what</tt></b>(</nobr></td>
  <td><var>filename</var>)</td></tr></table></dt>
<dd>
  Determines the type of sound data stored in the file <var>filename</var>
  using <tt class="function">whathdr()</tt>.  If it succeeds, returns a tuple as
  described above, otherwise <code>None</code> is returned.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-4766' xml:id='l2h-4766' class="function">whathdr</tt></b>(</nobr></td>
  <td><var>filename</var>)</td></tr></table></dt>
<dd>
  Determines the type of sound data stored in a file based on the file
  header.  The name of the file is given by <var>filename</var>.  This
  function returns a tuple as described above on success, or
  <code>None</code>.
</dl>

<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.9 imghdr  "
  href="module-imghdr.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.11 ossaudiodev  "
  href="module-ossaudiodev.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-imghdr.html">14.9 imghdr  </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="module-ossaudiodev.html">14.11 ossaudiodev  </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>