summaryrefslogtreecommitdiffhomepage
path: root/ogg/doc/libogg/ogg_stream_flush_fill.html
diff options
context:
space:
mode:
Diffstat (limited to 'ogg/doc/libogg/ogg_stream_flush_fill.html')
-rw-r--r--ogg/doc/libogg/ogg_stream_flush_fill.html74
1 files changed, 0 insertions, 74 deletions
diff --git a/ogg/doc/libogg/ogg_stream_flush_fill.html b/ogg/doc/libogg/ogg_stream_flush_fill.html
deleted file mode 100644
index 62aa11a..0000000
--- a/ogg/doc/libogg/ogg_stream_flush_fill.html
+++ /dev/null
@@ -1,74 +0,0 @@
-<html>
-
-<head>
-<title>libogg - function - ogg_stream_flush_fill</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_fill</h1>
-
-<p><i>declared in "ogg/ogg.h";</i></p>
-
-<p>This function flushes available packets into pages, similar to
-<a href="ogg_stream_flush.html">ogg_stream_flush()</a>, but
-allows applications to explicitly request a specific page spill
-size.</p>
-
-<p>This function checks for remaining packets inside the stream and forces remaining packets into pages of approximately the requested size.
-This should be used when you want to flush all remaining data from a stream. <a href="ogg_stream_flush.html">ogg_stream_flush</a> may be used instead if a particular page size isn't important.
-<p>This function can be used to verify that all packets have been flushed. If the return value is 0, all packets have been placed into a page. Generally speaking, it should be called in a loop until all packets are flushed, 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_fill(<a href="ogg_stream_state.html">ogg_stream_state</a> *os, <a href="ogg_page.html">ogg_page</a> *og, int fillbytes);
-</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.
-<dt><i>fillbytes</i></dt>
-<dd>Packet data watermark in bytes.</dd>
-</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 &copy; 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>