Baoding-FenShuaJiang
/
Green_GoodERP18_FSJ_Standard
Watch 1
Star 0
Wiki 捐赠
gooderp18绿色标准版
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Tree: 0f75e31513
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '0f75e31513'
${ noResults }
Green_GoodERP18_FSJ_Standard/python/Doc/html/library/wave.html

588 lines
38KB
Raw Blame History 

  1. <!DOCTYPE html>

  2. 

  3. <html lang="en" data-content_root="../">

  4.   <head>

  5.     <meta charset="utf-8" />

  6.     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

  7. <meta property="og:title" content="wave — Read and write WAV files" />

  8. <meta property="og:type" content="website" />

  9. <meta property="og:url" content="https://docs.python.org/3/library/wave.html" />

  10. <meta property="og:site_name" content="Python documentation" />

  11. <meta property="og:description" content="Source code: Lib/wave.py The wave module provides a convenient interface to the Waveform Audio “WAVE” (or “WAV”) file format. Only uncompressed PCM encoded wave files are supported. The wave module..." />

  12. <meta property="og:image" content="https://docs.python.org/3/_static/og-image.png" />

  13. <meta property="og:image:alt" content="Python documentation" />

  14. <meta name="description" content="Source code: Lib/wave.py The wave module provides a convenient interface to the Waveform Audio “WAVE” (or “WAV”) file format. Only uncompressed PCM encoded wave files are supported. The wave module..." />

  15. <meta property="og:image:width" content="200" />

  16. <meta property="og:image:height" content="200" />

  17. <meta name="theme-color" content="#3776ab" />

  18. 

  19.     <title>wave — Read and write WAV files &#8212; Python 3.12.3 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">

  20.     

  21.     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />

  22.     <link rel="stylesheet" type="text/css" href="../_static/pydoctheme.css?v=bb723527" />

  23.     <link id="pygments_dark_css" media="(prefers-color-scheme: dark)" rel="stylesheet" type="text/css" href="../_static/pygments_dark.css?v=b20cc3f5" />

  24.     

  25.     <script src="../_static/documentation_options.js?v=2c828074"></script>

  26.     <script src="../_static/doctools.js?v=888ff710"></script>

  27.     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>

  28.     

  29.     <script src="../_static/sidebar.js"></script>

  30.     

  31.     <link rel="search" type="application/opensearchdescription+xml"

  32.           title="Search within Python 3.12.3 documentation"

  33.           href="../_static/opensearch.xml"/>

  34.     <link rel="author" title="About these documents" href="../about.html" />

  35.     <link rel="index" title="Index" href="../genindex.html" />

  36.     <link rel="search" title="Search" href="../search.html" />

  37.     <link rel="copyright" title="Copyright" href="../copyright.html" />

  38.     <link rel="next" title="colorsys — Conversions between color systems" href="colorsys.html" />

  39.     <link rel="prev" title="Multimedia Services" href="mm.html" />

  40.     <link rel="canonical" href="https://docs.python.org/3/library/wave.html" />

  41.     

  42.       

  43.     

  44. 

  45.     

  46.     <style>

  47.       @media only screen {

  48.         table.full-width-table {

  49.             width: 100%;

  50.         }

  51.       }

  52.     </style>

  53. <link rel="stylesheet" href="../_static/pydoctheme_dark.css" media="(prefers-color-scheme: dark)" id="pydoctheme_dark_css">

  54.     <link rel="shortcut icon" type="image/png" href="../_static/py.svg" />

  55.             <script type="text/javascript" src="../_static/copybutton.js"></script>

  56.             <script type="text/javascript" src="../_static/menu.js"></script>

  57.             <script type="text/javascript" src="../_static/search-focus.js"></script>

  58.             <script type="text/javascript" src="../_static/themetoggle.js"></script> 

  59. 

  60.   </head>

  61. <body>

  62. <div class="mobile-nav">

  63.     <input type="checkbox" id="menuToggler" class="toggler__input" aria-controls="navigation"

  64.            aria-pressed="false" aria-expanded="false" role="button" aria-label="Menu" />

  65.     <nav class="nav-content" role="navigation">

  66.         <label for="menuToggler" class="toggler__label">

  67.             <span></span>

  68.         </label>

  69.         <span class="nav-items-wrapper">

  70.             <a href="https://www.python.org/" class="nav-logo">

  71.                 <img src="../_static/py.svg" alt="Python logo"/>

  72.             </a>

  73.             <span class="version_switcher_placeholder"></span>

  74.             <form role="search" class="search" action="../search.html" method="get">

  75.                 <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" class="search-icon">

  76.                     <path fill-rule="nonzero" fill="currentColor" d="M15.5 14h-.79l-.28-.27a6.5 6.5 0 001.48-5.34c-.47-2.78-2.79-5-5.59-5.34a6.505 6.505 0 00-7.27 7.27c.34 2.8 2.56 5.12 5.34 5.59a6.5 6.5 0 005.34-1.48l.27.28v.79l4.25 4.25c.41.41 1.08.41 1.49 0 .41-.41.41-1.08 0-1.49L15.5 14zm-6 0C7.01 14 5 11.99 5 9.5S7.01 5 9.5 5 14 7.01 14 9.5 11.99 14 9.5 14z"></path>

  77.                 </svg>

  78.                 <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" />

  79.                 <input type="submit" value="Go"/>

  80.             </form>

  81.         </span>

  82.     </nav>

  83.     <div class="menu-wrapper">

  84.         <nav class="menu" role="navigation" aria-label="main navigation">

  85.             <div class="language_switcher_placeholder"></div>

  86.             

  87. <label class="theme-selector-label">

  88.     Theme

  89.     <select class="theme-selector" oninput="activateTheme(this.value)">

  90.         <option value="auto" selected>Auto</option>

  91.         <option value="light">Light</option>

  92.         <option value="dark">Dark</option>

  93.     </select>

  94. </label>

  95.   <div>

  96.     <h3><a href="../contents.html">Table of Contents</a></h3>

  97.     <ul>

  98. <li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate"><span class="pre">wave</span></code> — Read and write WAV files</a><ul>

  99. <li><a class="reference internal" href="#wave-read-objects">Wave_read Objects</a></li>

  100. <li><a class="reference internal" href="#wave-write-objects">Wave_write Objects</a></li>

  101. </ul>

  102. </li>

  103. </ul>

  104. 

  105.   </div>

  106.   <div>

  107.     <h4>Previous topic</h4>

  108.     <p class="topless"><a href="mm.html"

  109.                           title="previous chapter">Multimedia Services</a></p>

  110.   </div>

  111.   <div>

  112.     <h4>Next topic</h4>

  113.     <p class="topless"><a href="colorsys.html"

  114.                           title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">colorsys</span></code> — Conversions between color systems</a></p>

  115.   </div>

  116.   <div role="note" aria-label="source link">

  117.     <h3>This Page</h3>

  118.     <ul class="this-page-menu">

  119.       <li><a href="../bugs.html">Report a Bug</a></li>

  120.       <li>

  121.         <a href="https://github.com/python/cpython/blob/main/Doc/library/wave.rst"

  122.             rel="nofollow">Show Source

  123.         </a>

  124.       </li>

  125.     </ul>

  126.   </div>

  127.         </nav>

  128.     </div>

  129. </div>

  130. 

  131.   

  132.     <div class="related" role="navigation" aria-label="related navigation">

  133.       <h3>Navigation</h3>

  134.       <ul>

  135.         <li class="right" style="margin-right: 10px">

  136.           <a href="../genindex.html" title="General Index"

  137.              accesskey="I">index</a></li>

  138.         <li class="right" >

  139.           <a href="../py-modindex.html" title="Python Module Index"

  140.              >modules</a> |</li>

  141.         <li class="right" >

  142.           <a href="colorsys.html" title="colorsys — Conversions between color systems"

  143.              accesskey="N">next</a> |</li>

  144.         <li class="right" >

  145.           <a href="mm.html" title="Multimedia Services"

  146.              accesskey="P">previous</a> |</li>

  147. 

  148.           <li><img src="../_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"/></li>

  149.           <li><a href="https://www.python.org/">Python</a> &#187;</li>

  150.           <li class="switchers">

  151.             <div class="language_switcher_placeholder"></div>

  152.             <div class="version_switcher_placeholder"></div>

  153.           </li>

  154.           <li>

  155.               

  156.           </li>

  157.     <li id="cpython-language-and-version">

  158.       <a href="../index.html">3.12.3 Documentation</a> &#187;

  159.     </li>

  160. 

  161.           <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>

  162.           <li class="nav-item nav-item-2"><a href="mm.html" accesskey="U">Multimedia Services</a> &#187;</li>

  163.         <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">wave</span></code> — Read and write WAV files</a></li>

  164.                 <li class="right">

  165.                     

  166. 

  167.     <div class="inline-search" role="search">

  168.         <form class="inline-search" action="../search.html" method="get">

  169.           <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box" />

  170.           <input type="submit" value="Go" />

  171.         </form>

  172.     </div>

  173.                      |

  174.                 </li>

  175.             <li class="right">

  176. <label class="theme-selector-label">

  177.     Theme

  178.     <select class="theme-selector" oninput="activateTheme(this.value)">

  179.         <option value="auto" selected>Auto</option>

  180.         <option value="light">Light</option>

  181.         <option value="dark">Dark</option>

  182.     </select>

  183. </label> |</li>

  184.             

  185.       </ul>

  186.     </div>    

  187. 

  188.     <div class="document">

  189.       <div class="documentwrapper">

  190.         <div class="bodywrapper">

  191.           <div class="body" role="main">

  192.             

  193.   <section id="module-wave">

  194. <span id="wave-read-and-write-wav-files"></span><h1><a class="reference internal" href="#module-wave" title="wave: Provide an interface to the WAV sound format."><code class="xref py py-mod docutils literal notranslate"><span class="pre">wave</span></code></a> — Read and write WAV files<a class="headerlink" href="#module-wave" title="Link to this heading">¶</a></h1>

  195. <p><strong>Source code:</strong> <a class="reference external" href="https://github.com/python/cpython/tree/3.12/Lib/wave.py">Lib/wave.py</a></p>

  196. <hr class="docutils" />

  197. <p>The <a class="reference internal" href="#module-wave" title="wave: Provide an interface to the WAV sound format."><code class="xref py py-mod docutils literal notranslate"><span class="pre">wave</span></code></a> module provides a convenient interface to the Waveform Audio

  198. “WAVE” (or “WAV”) file format. Only uncompressed PCM encoded wave files are

  199. supported.</p>

  200. <div class="versionchanged">

  201. <p><span class="versionmodified changed">Changed in version 3.12: </span>Support for <code class="docutils literal notranslate"><span class="pre">WAVE_FORMAT_EXTENSIBLE</span></code> headers was added, provided that the

  202. extended format is <code class="docutils literal notranslate"><span class="pre">KSDATAFORMAT_SUBTYPE_PCM</span></code>.</p>

  203. </div>

  204. <p>The <a class="reference internal" href="#module-wave" title="wave: Provide an interface to the WAV sound format."><code class="xref py py-mod docutils literal notranslate"><span class="pre">wave</span></code></a> module defines the following function and exception:</p>

  205. <dl class="py function">

  206. <dt class="sig sig-object py" id="wave.open">

  207. <span class="sig-prename descclassname"><span class="pre">wave.</span></span><span class="sig-name descname"><span class="pre">open</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mode</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#wave.open" title="Link to this definition">¶</a></dt>

  208. <dd><p>If <em>file</em> is a string, open the file by that name, otherwise treat it as a

  209. file-like object.  <em>mode</em> can be:</p>

  210. <dl class="simple">

  211. <dt><code class="docutils literal notranslate"><span class="pre">'rb'</span></code></dt><dd><p>Read only mode.</p>

  212. </dd>

  213. <dt><code class="docutils literal notranslate"><span class="pre">'wb'</span></code></dt><dd><p>Write only mode.</p>

  214. </dd>

  215. </dl>

  216. <p>Note that it does not allow read/write WAV files.</p>

  217. <p>A <em>mode</em> of <code class="docutils literal notranslate"><span class="pre">'rb'</span></code> returns a <a class="reference internal" href="#wave.Wave_read" title="wave.Wave_read"><code class="xref py py-class docutils literal notranslate"><span class="pre">Wave_read</span></code></a> object, while a <em>mode</em> of

  218. <code class="docutils literal notranslate"><span class="pre">'wb'</span></code> returns a <a class="reference internal" href="#wave.Wave_write" title="wave.Wave_write"><code class="xref py py-class docutils literal notranslate"><span class="pre">Wave_write</span></code></a> object.  If <em>mode</em> is omitted and a

  219. file-like object is passed as <em>file</em>, <code class="docutils literal notranslate"><span class="pre">file.mode</span></code> is used as the default

  220. value for <em>mode</em>.</p>

  221. <p>If you pass in a file-like object, the wave object will not close it when its

  222. <code class="docutils literal notranslate"><span class="pre">close()</span></code> method is called; it is the caller’s responsibility to close

  223. the file object.</p>

  224. <p>The <a class="reference internal" href="#wave.open" title="wave.open"><code class="xref py py-func docutils literal notranslate"><span class="pre">open()</span></code></a> function may be used in a <a class="reference internal" href="../reference/compound_stmts.html#with"><code class="xref std std-keyword docutils literal notranslate"><span class="pre">with</span></code></a> statement.  When

  225. the <code class="xref std std-keyword docutils literal notranslate"><span class="pre">with</span></code> block completes, the <a class="reference internal" href="#wave.Wave_read.close" title="wave.Wave_read.close"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Wave_read.close()</span></code></a> or

  226. <a class="reference internal" href="#wave.Wave_write.close" title="wave.Wave_write.close"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Wave_write.close()</span></code></a> method is called.</p>

  227. <div class="versionchanged">

  228. <p><span class="versionmodified changed">Changed in version 3.4: </span>Added support for unseekable files.</p>

  229. </div>

  230. </dd></dl>

  231. 

  232. <dl class="py exception">

  233. <dt class="sig sig-object py" id="wave.Error">

  234. <em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">wave.</span></span><span class="sig-name descname"><span class="pre">Error</span></span><a class="headerlink" href="#wave.Error" title="Link to this definition">¶</a></dt>

  235. <dd><p>An error raised when something is impossible because it violates the WAV

  236. specification or hits an implementation deficiency.</p>

  237. </dd></dl>

  238. 

  239. <section id="wave-read-objects">

  240. <span id="id1"></span><h2>Wave_read Objects<a class="headerlink" href="#wave-read-objects" title="Link to this heading">¶</a></h2>

  241. <dl class="py class">

  242. <dt class="sig sig-object py" id="wave.Wave_read">

  243. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">wave.</span></span><span class="sig-name descname"><span class="pre">Wave_read</span></span><a class="headerlink" href="#wave.Wave_read" title="Link to this definition">¶</a></dt>

  244. <dd><p>Read a WAV file.</p>

  245. <p>Wave_read objects, as returned by <a class="reference internal" href="#wave.open" title="wave.open"><code class="xref py py-func docutils literal notranslate"><span class="pre">open()</span></code></a>, have the following methods:</p>

  246. <dl class="py method">

  247. <dt class="sig sig-object py" id="wave.Wave_read.close">

  248. <span class="sig-name descname"><span class="pre">close</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#wave.Wave_read.close" title="Link to this definition">¶</a></dt>

  249. <dd><p>Close the stream if it was opened by <a class="reference internal" href="#module-wave" title="wave: Provide an interface to the WAV sound format."><code class="xref py py-mod docutils literal notranslate"><span class="pre">wave</span></code></a>, and make the instance

  250. unusable.  This is called automatically on object collection.</p>

  251. </dd></dl>

  252. 

  253. <dl class="py method">

  254. <dt class="sig sig-object py" id="wave.Wave_read.getnchannels">

  255. <span class="sig-name descname"><span class="pre">getnchannels</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#wave.Wave_read.getnchannels" title="Link to this definition">¶</a></dt>

  256. <dd><p>Returns number of audio channels (<code class="docutils literal notranslate"><span class="pre">1</span></code> for mono, <code class="docutils literal notranslate"><span class="pre">2</span></code> for stereo).</p>

  257. </dd></dl>

  258. 

  259. <dl class="py method">

  260. <dt class="sig sig-object py" id="wave.Wave_read.getsampwidth">

  261. <span class="sig-name descname"><span class="pre">getsampwidth</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#wave.Wave_read.getsampwidth" title="Link to this definition">¶</a></dt>

  262. <dd><p>Returns sample width in bytes.</p>

  263. </dd></dl>

  264. 

  265. <dl class="py method">

  266. <dt class="sig sig-object py" id="wave.Wave_read.getframerate">

  267. <span class="sig-name descname"><span class="pre">getframerate</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#wave.Wave_read.getframerate" title="Link to this definition">¶</a></dt>

  268. <dd><p>Returns sampling frequency.</p>

  269. </dd></dl>

  270. 

  271. <dl class="py method">

  272. <dt class="sig sig-object py" id="wave.Wave_read.getnframes">

  273. <span class="sig-name descname"><span class="pre">getnframes</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#wave.Wave_read.getnframes" title="Link to this definition">¶</a></dt>

  274. <dd><p>Returns number of audio frames.</p>

  275. </dd></dl>

  276. 

  277. <dl class="py method">

  278. <dt class="sig sig-object py" id="wave.Wave_read.getcomptype">

  279. <span class="sig-name descname"><span class="pre">getcomptype</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#wave.Wave_read.getcomptype" title="Link to this definition">¶</a></dt>

  280. <dd><p>Returns compression type (<code class="docutils literal notranslate"><span class="pre">'NONE'</span></code> is the only supported type).</p>

  281. </dd></dl>

  282. 

  283. <dl class="py method">

  284. <dt class="sig sig-object py" id="wave.Wave_read.getcompname">

  285. <span class="sig-name descname"><span class="pre">getcompname</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#wave.Wave_read.getcompname" title="Link to this definition">¶</a></dt>

  286. <dd><p>Human-readable version of <a class="reference internal" href="#wave.Wave_read.getcomptype" title="wave.Wave_read.getcomptype"><code class="xref py py-meth docutils literal notranslate"><span class="pre">getcomptype()</span></code></a>. Usually <code class="docutils literal notranslate"><span class="pre">'not</span> <span class="pre">compressed'</span></code>

  287. parallels <code class="docutils literal notranslate"><span class="pre">'NONE'</span></code>.</p>

  288. </dd></dl>

  289. 

  290. <dl class="py method">

  291. <dt class="sig sig-object py" id="wave.Wave_read.getparams">

  292. <span class="sig-name descname"><span class="pre">getparams</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#wave.Wave_read.getparams" title="Link to this definition">¶</a></dt>

  293. <dd><p>Returns a <a class="reference internal" href="collections.html#collections.namedtuple" title="collections.namedtuple"><code class="xref py py-func docutils literal notranslate"><span class="pre">namedtuple()</span></code></a> <code class="docutils literal notranslate"><span class="pre">(nchannels,</span> <span class="pre">sampwidth,</span>

  294. <span class="pre">framerate,</span> <span class="pre">nframes,</span> <span class="pre">comptype,</span> <span class="pre">compname)</span></code>, equivalent to output of the

  295. <code class="docutils literal notranslate"><span class="pre">get*()</span></code> methods.</p>

  296. </dd></dl>

  297. 

  298. <dl class="py method">

  299. <dt class="sig sig-object py" id="wave.Wave_read.readframes">

  300. <span class="sig-name descname"><span class="pre">readframes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">n</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#wave.Wave_read.readframes" title="Link to this definition">¶</a></dt>

  301. <dd><p>Reads and returns at most <em>n</em> frames of audio, as a <a class="reference internal" href="stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate"><span class="pre">bytes</span></code></a> object.</p>

  302. </dd></dl>

  303. 

  304. <dl class="py method">

  305. <dt class="sig sig-object py" id="wave.Wave_read.rewind">

  306. <span class="sig-name descname"><span class="pre">rewind</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#wave.Wave_read.rewind" title="Link to this definition">¶</a></dt>

  307. <dd><p>Rewind the file pointer to the beginning of the audio stream.</p>

  308. </dd></dl>

  309. 

  310. <p>The following two methods are defined for compatibility with the <a class="reference internal" href="aifc.html#module-aifc" title="aifc: Read and write audio files in AIFF or AIFC format. (deprecated)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">aifc</span></code></a>

  311. module, and don’t do anything interesting.</p>

  312. <dl class="py method">

  313. <dt class="sig sig-object py" id="wave.Wave_read.getmarkers">

  314. <span class="sig-name descname"><span class="pre">getmarkers</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#wave.Wave_read.getmarkers" title="Link to this definition">¶</a></dt>

  315. <dd><p>Returns <code class="docutils literal notranslate"><span class="pre">None</span></code>.</p>

  316. </dd></dl>

  317. 

  318. <dl class="py method">

  319. <dt class="sig sig-object py" id="wave.Wave_read.getmark">

  320. <span class="sig-name descname"><span class="pre">getmark</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#wave.Wave_read.getmark" title="Link to this definition">¶</a></dt>

  321. <dd><p>Raise an error.</p>

  322. </dd></dl>

  323. 

  324. <p>The following two methods define a term “position” which is compatible between

  325. them, and is otherwise implementation dependent.</p>

  326. <dl class="py method">

  327. <dt class="sig sig-object py" id="wave.Wave_read.setpos">

  328. <span class="sig-name descname"><span class="pre">setpos</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pos</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#wave.Wave_read.setpos" title="Link to this definition">¶</a></dt>

  329. <dd><p>Set the file pointer to the specified position.</p>

  330. </dd></dl>

  331. 

  332. <dl class="py method">

  333. <dt class="sig sig-object py" id="wave.Wave_read.tell">

  334. <span class="sig-name descname"><span class="pre">tell</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#wave.Wave_read.tell" title="Link to this definition">¶</a></dt>

  335. <dd><p>Return current file pointer position.</p>

  336. </dd></dl>

  337. 

  338. </dd></dl>

  339. 

  340. </section>

  341. <section id="wave-write-objects">

  342. <span id="id2"></span><h2>Wave_write Objects<a class="headerlink" href="#wave-write-objects" title="Link to this heading">¶</a></h2>

  343. <dl class="py class">

  344. <dt class="sig sig-object py" id="wave.Wave_write">

  345. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">wave.</span></span><span class="sig-name descname"><span class="pre">Wave_write</span></span><a class="headerlink" href="#wave.Wave_write" title="Link to this definition">¶</a></dt>

  346. <dd><p>Write a WAV file.</p>

  347. <p>Wave_write objects, as returned by <a class="reference internal" href="#wave.open" title="wave.open"><code class="xref py py-func docutils literal notranslate"><span class="pre">open()</span></code></a>.</p>

  348. <p>For seekable output streams, the <code class="docutils literal notranslate"><span class="pre">wave</span></code> header will automatically be updated

  349. to reflect the number of frames actually written.  For unseekable streams, the

  350. <em>nframes</em> value must be accurate when the first frame data is written.  An

  351. accurate <em>nframes</em> value can be achieved either by calling

  352. <a class="reference internal" href="#wave.Wave_write.setnframes" title="wave.Wave_write.setnframes"><code class="xref py py-meth docutils literal notranslate"><span class="pre">setnframes()</span></code></a> or <a class="reference internal" href="#wave.Wave_write.setparams" title="wave.Wave_write.setparams"><code class="xref py py-meth docutils literal notranslate"><span class="pre">setparams()</span></code></a> with the number

  353. of frames that will be written before <a class="reference internal" href="#wave.Wave_write.close" title="wave.Wave_write.close"><code class="xref py py-meth docutils literal notranslate"><span class="pre">close()</span></code></a> is called and

  354. then using <a class="reference internal" href="#wave.Wave_write.writeframesraw" title="wave.Wave_write.writeframesraw"><code class="xref py py-meth docutils literal notranslate"><span class="pre">writeframesraw()</span></code></a> to write the frame data, or by

  355. calling <a class="reference internal" href="#wave.Wave_write.writeframes" title="wave.Wave_write.writeframes"><code class="xref py py-meth docutils literal notranslate"><span class="pre">writeframes()</span></code></a> with all of the frame data to be

  356. written.  In the latter case <a class="reference internal" href="#wave.Wave_write.writeframes" title="wave.Wave_write.writeframes"><code class="xref py py-meth docutils literal notranslate"><span class="pre">writeframes()</span></code></a> will calculate

  357. the number of frames in the data and set <em>nframes</em> accordingly before writing

  358. the frame data.</p>

  359. <div class="versionchanged">

  360. <p><span class="versionmodified changed">Changed in version 3.4: </span>Added support for unseekable files.</p>

  361. </div>

  362. <p>Wave_write objects have the following methods:</p>

  363. <dl class="py method">

  364. <dt class="sig sig-object py" id="wave.Wave_write.close">

  365. <span class="sig-name descname"><span class="pre">close</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#wave.Wave_write.close" title="Link to this definition">¶</a></dt>

  366. <dd><p>Make sure <em>nframes</em> is correct, and close the file if it was opened by

  367. <a class="reference internal" href="#module-wave" title="wave: Provide an interface to the WAV sound format."><code class="xref py py-mod docutils literal notranslate"><span class="pre">wave</span></code></a>.  This method is called upon object collection.  It will raise

  368. an exception if the output stream is not seekable and <em>nframes</em> does not

  369. match the number of frames actually written.</p>

  370. </dd></dl>

  371. 

  372. <dl class="py method">

  373. <dt class="sig sig-object py" id="wave.Wave_write.setnchannels">

  374. <span class="sig-name descname"><span class="pre">setnchannels</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">n</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#wave.Wave_write.setnchannels" title="Link to this definition">¶</a></dt>

  375. <dd><p>Set the number of channels.</p>

  376. </dd></dl>

  377. 

  378. <dl class="py method">

  379. <dt class="sig sig-object py" id="wave.Wave_write.setsampwidth">

  380. <span class="sig-name descname"><span class="pre">setsampwidth</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">n</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#wave.Wave_write.setsampwidth" title="Link to this definition">¶</a></dt>

  381. <dd><p>Set the sample width to <em>n</em> bytes.</p>

  382. </dd></dl>

  383. 

  384. <dl class="py method">

  385. <dt class="sig sig-object py" id="wave.Wave_write.setframerate">

  386. <span class="sig-name descname"><span class="pre">setframerate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">n</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#wave.Wave_write.setframerate" title="Link to this definition">¶</a></dt>

  387. <dd><p>Set the frame rate to <em>n</em>.</p>

  388. <div class="versionchanged">

  389. <p><span class="versionmodified changed">Changed in version 3.2: </span>A non-integral input to this method is rounded to the nearest

  390. integer.</p>

  391. </div>

  392. </dd></dl>

  393. 

  394. <dl class="py method">

  395. <dt class="sig sig-object py" id="wave.Wave_write.setnframes">

  396. <span class="sig-name descname"><span class="pre">setnframes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">n</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#wave.Wave_write.setnframes" title="Link to this definition">¶</a></dt>

  397. <dd><p>Set the number of frames to <em>n</em>.  This will be changed later if the number

  398. of frames actually written is different (this update attempt will

  399. raise an error if the output stream is not seekable).</p>

  400. </dd></dl>

  401. 

  402. <dl class="py method">

  403. <dt class="sig sig-object py" id="wave.Wave_write.setcomptype">

  404. <span class="sig-name descname"><span class="pre">setcomptype</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#wave.Wave_write.setcomptype" title="Link to this definition">¶</a></dt>

  405. <dd><p>Set the compression type and description. At the moment, only compression type

  406. <code class="docutils literal notranslate"><span class="pre">NONE</span></code> is supported, meaning no compression.</p>

  407. </dd></dl>

  408. 

  409. <dl class="py method">

  410. <dt class="sig sig-object py" id="wave.Wave_write.setparams">

  411. <span class="sig-name descname"><span class="pre">setparams</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tuple</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#wave.Wave_write.setparams" title="Link to this definition">¶</a></dt>

  412. <dd><p>The <em>tuple</em> should be <code class="docutils literal notranslate"><span class="pre">(nchannels,</span> <span class="pre">sampwidth,</span> <span class="pre">framerate,</span> <span class="pre">nframes,</span> <span class="pre">comptype,</span>

  413. <span class="pre">compname)</span></code>, with values valid for the <code class="docutils literal notranslate"><span class="pre">set*()</span></code> methods.  Sets all

  414. parameters.</p>

  415. </dd></dl>

  416. 

  417. <dl class="py method">

  418. <dt class="sig sig-object py" id="wave.Wave_write.tell">

  419. <span class="sig-name descname"><span class="pre">tell</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#wave.Wave_write.tell" title="Link to this definition">¶</a></dt>

  420. <dd><p>Return current position in the file, with the same disclaimer for the

  421. <a class="reference internal" href="#wave.Wave_read.tell" title="wave.Wave_read.tell"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Wave_read.tell()</span></code></a> and <a class="reference internal" href="#wave.Wave_read.setpos" title="wave.Wave_read.setpos"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Wave_read.setpos()</span></code></a> methods.</p>

  422. </dd></dl>

  423. 

  424. <dl class="py method">

  425. <dt class="sig sig-object py" id="wave.Wave_write.writeframesraw">

  426. <span class="sig-name descname"><span class="pre">writeframesraw</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#wave.Wave_write.writeframesraw" title="Link to this definition">¶</a></dt>

  427. <dd><p>Write audio frames, without correcting <em>nframes</em>.</p>

  428. <div class="versionchanged">

  429. <p><span class="versionmodified changed">Changed in version 3.4: </span>Any <a class="reference internal" href="../glossary.html#term-bytes-like-object"><span class="xref std std-term">bytes-like object</span></a> is now accepted.</p>

  430. </div>

  431. </dd></dl>

  432. 

  433. <dl class="py method">

  434. <dt class="sig sig-object py" id="wave.Wave_write.writeframes">

  435. <span class="sig-name descname"><span class="pre">writeframes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#wave.Wave_write.writeframes" title="Link to this definition">¶</a></dt>

  436. <dd><p>Write audio frames and make sure <em>nframes</em> is correct.  It will raise an

  437. error if the output stream is not seekable and the total number of frames

  438. that have been written after <em>data</em> has been written does not match the

  439. previously set value for <em>nframes</em>.</p>

  440. <div class="versionchanged">

  441. <p><span class="versionmodified changed">Changed in version 3.4: </span>Any <a class="reference internal" href="../glossary.html#term-bytes-like-object"><span class="xref std std-term">bytes-like object</span></a> is now accepted.</p>

  442. </div>

  443. <p>Note that it is invalid to set any parameters after calling <a class="reference internal" href="#wave.Wave_write.writeframes" title="wave.Wave_write.writeframes"><code class="xref py py-meth docutils literal notranslate"><span class="pre">writeframes()</span></code></a>

  444. or <a class="reference internal" href="#wave.Wave_write.writeframesraw" title="wave.Wave_write.writeframesraw"><code class="xref py py-meth docutils literal notranslate"><span class="pre">writeframesraw()</span></code></a>, and any attempt to do so will raise

  445. <a class="reference internal" href="#wave.Error" title="wave.Error"><code class="xref py py-exc docutils literal notranslate"><span class="pre">wave.Error</span></code></a>.</p>

  446. </dd></dl>

  447. 

  448. </dd></dl>

  449. 

  450. </section>

  451. </section>

  452. 

  453. 

  454.             <div class="clearer"></div>

  455.           </div>

  456.         </div>

  457.       </div>

  458.       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">

  459.         <div class="sphinxsidebarwrapper">

  460.   <div>

  461.     <h3><a href="../contents.html">Table of Contents</a></h3>

  462.     <ul>

  463. <li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate"><span class="pre">wave</span></code> — Read and write WAV files</a><ul>

  464. <li><a class="reference internal" href="#wave-read-objects">Wave_read Objects</a></li>

  465. <li><a class="reference internal" href="#wave-write-objects">Wave_write Objects</a></li>

  466. </ul>

  467. </li>

  468. </ul>

  469. 

  470.   </div>

  471.   <div>

  472.     <h4>Previous topic</h4>

  473.     <p class="topless"><a href="mm.html"

  474.                           title="previous chapter">Multimedia Services</a></p>

  475.   </div>

  476.   <div>

  477.     <h4>Next topic</h4>

  478.     <p class="topless"><a href="colorsys.html"

  479.                           title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">colorsys</span></code> — Conversions between color systems</a></p>

  480.   </div>

  481.   <div role="note" aria-label="source link">

  482.     <h3>This Page</h3>

  483.     <ul class="this-page-menu">

  484.       <li><a href="../bugs.html">Report a Bug</a></li>

  485.       <li>

  486.         <a href="https://github.com/python/cpython/blob/main/Doc/library/wave.rst"

  487.             rel="nofollow">Show Source

  488.         </a>

  489.       </li>

  490.     </ul>

  491.   </div>

  492.         </div>

  493. <div id="sidebarbutton" title="Collapse sidebar">

  494. <span>«</span>

  495. </div>

  496. 

  497.       </div>

  498.       <div class="clearer"></div>

  499.     </div>  

  500.     <div class="related" role="navigation" aria-label="related navigation">

  501.       <h3>Navigation</h3>

  502.       <ul>

  503.         <li class="right" style="margin-right: 10px">

  504.           <a href="../genindex.html" title="General Index"

  505.              >index</a></li>

  506.         <li class="right" >

  507.           <a href="../py-modindex.html" title="Python Module Index"

  508.              >modules</a> |</li>

  509.         <li class="right" >

  510.           <a href="colorsys.html" title="colorsys — Conversions between color systems"

  511.              >next</a> |</li>

  512.         <li class="right" >

  513.           <a href="mm.html" title="Multimedia Services"

  514.              >previous</a> |</li>

  515. 

  516.           <li><img src="../_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"/></li>

  517.           <li><a href="https://www.python.org/">Python</a> &#187;</li>

  518.           <li class="switchers">

  519.             <div class="language_switcher_placeholder"></div>

  520.             <div class="version_switcher_placeholder"></div>

  521.           </li>

  522.           <li>

  523.               

  524.           </li>

  525.     <li id="cpython-language-and-version">

  526.       <a href="../index.html">3.12.3 Documentation</a> &#187;

  527.     </li>

  528. 

  529.           <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>

  530.           <li class="nav-item nav-item-2"><a href="mm.html" >Multimedia Services</a> &#187;</li>

  531.         <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">wave</span></code> — Read and write WAV files</a></li>

  532.                 <li class="right">

  533.                     

  534. 

  535.     <div class="inline-search" role="search">

  536.         <form class="inline-search" action="../search.html" method="get">

  537.           <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box" />

  538.           <input type="submit" value="Go" />

  539.         </form>

  540.     </div>

  541.                      |

  542.                 </li>

  543.             <li class="right">

  544. <label class="theme-selector-label">

  545.     Theme

  546.     <select class="theme-selector" oninput="activateTheme(this.value)">

  547.         <option value="auto" selected>Auto</option>

  548.         <option value="light">Light</option>

  549.         <option value="dark">Dark</option>

  550.     </select>

  551. </label> |</li>

  552.             

  553.       </ul>

  554.     </div>  

  555.     <div class="footer">

  556.     &copy; 

  557.       <a href="../copyright.html">

  558.     

  559.     Copyright

  560.     

  561.       </a>

  562.      2001-2024, Python Software Foundation.

  563.     <br />

  564.     This page is licensed under the Python Software Foundation License Version 2.

  565.     <br />

  566.     Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.

  567.     <br />

  568.     

  569.       See <a href="/license.html">History and License</a> for more information.<br />

  570.     

  571.     

  572.     <br />

  573. 

  574.     The Python Software Foundation is a non-profit corporation.

  575. <a href="https://www.python.org/psf/donations/">Please donate.</a>

  576. <br />

  577.     <br />

  578.       Last updated on Apr 09, 2024 (13:47 UTC).

  579.     

  580.       <a href="/bugs.html">Found a bug</a>?

  581.     

  582.     <br />

  583. 

  584.     Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.

  585.     </div>

  586. 

  587.   </body>

  588. </html>
上海开阖软件有限公司 沪ICP备12045867号-1