Document EPIPE

This commit is contained in:
Lars Immisch
2017-03-17 20:41:10 +01:00
parent b612b73188
commit 4726ac5842
8 changed files with 12 additions and 6 deletions

View File

@@ -233,6 +233,9 @@ PCM objects have the following methods:
``(0,'')`` if no new period has become available since the last ``(0,'')`` if no new period has become available since the last
call to read. call to read.
In case of an overrun, this function will return a negative size: :const:`-EPIPE`.
This indicates that data was lost, even if the operation itself succeeded.
Try using a larger periodsize;
.. method:: PCM.write(data) .. method:: PCM.write(data)

View File

@@ -298,7 +298,7 @@
</div> </div>
<div class="footer"> <div class="footer">
&copy; Copyright 2008-20017, Casper Wilstrup, Lars Immisch. &copy; Copyright 2008-20017, Casper Wilstrup, Lars Immisch.
Last updated on Feb 25, 2017. Last updated on Mar 17, 2017.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3. Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
</div> </div>
</body> </body>

View File

@@ -141,7 +141,7 @@
</div> </div>
<div class="footer"> <div class="footer">
&copy; Copyright 2008-20017, Casper Wilstrup, Lars Immisch. &copy; Copyright 2008-20017, Casper Wilstrup, Lars Immisch.
Last updated on Feb 25, 2017. Last updated on Mar 17, 2017.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3. Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
</div> </div>
</body> </body>

View File

@@ -306,6 +306,9 @@ periodsize*framesize bytes.</p>
<p>In <tt class="xref py py-const docutils literal"><span class="pre">PCM_NONBLOCK</span></tt> mode, the call will not block, but will return <p>In <tt class="xref py py-const docutils literal"><span class="pre">PCM_NONBLOCK</span></tt> mode, the call will not block, but will return
<tt class="docutils literal"><span class="pre">(0,'')</span></tt> if no new period has become available since the last <tt class="docutils literal"><span class="pre">(0,'')</span></tt> if no new period has become available since the last
call to read.</p> call to read.</p>
<p>In case of an overrun, this function will return a negative size: <tt class="xref py py-const docutils literal"><span class="pre">-EPIPE</span></tt>.
This indicates that data was lost, even if the operation itself succeeded.
Try using a larger periodsize;</p>
</dd></dl> </dd></dl>
<dl class="method"> <dl class="method">
@@ -785,7 +788,7 @@ Channel 1 volume: 61%
</div> </div>
<div class="footer"> <div class="footer">
&copy; Copyright 2008-20017, Casper Wilstrup, Lars Immisch. &copy; Copyright 2008-20017, Casper Wilstrup, Lars Immisch.
Last updated on Feb 24, 2017. Last updated on Mar 17, 2017.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3. Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
</div> </div>
</body> </body>

Binary file not shown.

View File

@@ -106,7 +106,7 @@
</div> </div>
<div class="footer"> <div class="footer">
&copy; Copyright 2008-20017, Casper Wilstrup, Lars Immisch. &copy; Copyright 2008-20017, Casper Wilstrup, Lars Immisch.
Last updated on Feb 25, 2017. Last updated on Mar 17, 2017.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3. Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
</div> </div>
</body> </body>

View File

@@ -99,7 +99,7 @@
</div> </div>
<div class="footer"> <div class="footer">
&copy; Copyright 2008-20017, Casper Wilstrup, Lars Immisch. &copy; Copyright 2008-20017, Casper Wilstrup, Lars Immisch.
Last updated on Feb 25, 2017. Last updated on Mar 17, 2017.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3. Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
</div> </div>
</body> </body>

File diff suppressed because one or more lines are too long