diff options
Diffstat (limited to 'contrib/ogg/doc/libogg/ogg_stream_flush.html')
| -rw-r--r-- | contrib/ogg/doc/libogg/ogg_stream_flush.html | 67 |
1 files changed, 0 insertions, 67 deletions
diff --git a/contrib/ogg/doc/libogg/ogg_stream_flush.html b/contrib/ogg/doc/libogg/ogg_stream_flush.html deleted file mode 100644 index 317f442..0000000 --- a/contrib/ogg/doc/libogg/ogg_stream_flush.html +++ /dev/null @@ -1,67 +0,0 @@ -<html> - -<head> -<title>libogg - function - ogg_stream_flush</title> -<link rel=stylesheet href="style.css" type="text/css"> -</head> - -<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> -<table border=0 width=100%> -<tr> -<td><p class=tiny>libogg documentation</p></td> -<td align=right><p class=tiny>libogg release 1.3.2 - 20140527</p></td> -</tr> -</table> - -<h1>ogg_stream_flush</h1> - -<p><i>declared in "ogg/ogg.h";</i></p> - -<p>This function checks for remaining packets inside the stream and forces remaining packets into a page, regardless of the size of the page. -<p>This should only be used when you want to flush an undersized page from the middle of the stream. Otherwise, <a href="ogg_stream_pageout.html">ogg_stream_pageout</a> or <a href="ogg_stream_pageout_fill.html">ogg_stream_pageout_fill</a> should always be used. -<p>This function can also be used to verify that all packets have been flushed. If the return value is 0, all packets have been placed into a page. Like <a href="ogg_stream_pageout.html">ogg_stream_pageout</a>, it should generally be called in a loop until available packet data has been flushes, since even a single packet may span multiple pages. - -<br><br> -<table border=0 color=black cellspacing=0 cellpadding=7> -<tr bgcolor=#cccccc> - <td> -<pre><b> -int ogg_stream_flush(<a href="ogg_stream_state.html">ogg_stream_state</a> *os, <a href="ogg_page.html">ogg_page</a> *og); -</b></pre> - </td> -</tr> -</table> - -<h3>Parameters</h3> -<dl> -<dt><i>os</i></dt> -<dd>Pointer to a previously declared <a href="ogg_stream_state.html">ogg_stream_state</a> struct, which represents the current logical bitstream.</dd> -<dt><i>og</i></dt> -<dd>Pointer to a page of data. The remaining packets in the stream will be placed into this page, if any remain. -</dl> - - -<h3>Return Values</h3> -<blockquote> -<li>0 means that all packet data has already been flushed into pages, and there are no packets to put into the page. 0 is also returned in the case of an <a href="ogg_stream_state.html">ogg_stream_state</a> that has been cleared explicitly or implicitly due to an internal error.</li> -<li> -Nonzero means that remaining packets have successfully been flushed into the page.</li> -</blockquote> -<p> - -<br><br> -<hr noshade> -<table border=0 width=100%> -<tr valign=top> -<td><p class=tiny>copyright © 2000-2014 Xiph.Org</p></td> -<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/">Ogg Container Format</a></p></td> -</tr><tr> -<td><p class=tiny>libogg documentation</p></td> -<td align=right><p class=tiny>libogg release 1.3.2 - 20140527</p></td> -</tr> -</table> - - -</body> - -</html> |