00001 <html>
00002
00003 <head>
00004 <title>libogg - function - ogg_stream_flush</title>
00005 <link rel=stylesheet href="style.css" type="text/css">
00006 </head>
00007
00008 <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
00009 <table border=0 width=100%>
00010 <tr>
00011 <td><p class=tiny>libogg documentation</p></td>
00012 <td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td>
00013 </tr>
00014 </table>
00015
00016 <h1>ogg_stream_flush</h1>
00017
00018 <p><i>declared in "ogg/ogg.h";</i></p>
00019
00020 <p>This function checks for remaining packets inside the stream and forces remaining packets into a page, regardless of the size of the page.
00021 <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> should always be used.
00022 <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.
00023
00024 <br><br>
00025 <table border=0 color=black cellspacing=0 cellpadding=7>
00026 <tr bgcolor=#cccccc>
00027 <td>
00028 <pre><b>
00029 int ogg_stream_flush(<a href="ogg_stream_state.html">ogg_stream_state</a> *os, <a href="ogg_page.html">ogg_page</a> *og);
00030 </b></pre>
00031 </td>
00032 </tr>
00033 </table>
00034
00035 <h3>Parameters</h3>
00036 <dl>
00037 <dt><i>os</i></dt>
00038 <dd>Pointer to a previously declared <a href="ogg_stream_state.html">ogg_stream_state</a> struct, which represents the current logical bitstream.</dd>
00039 <dt><i>og</i></dt>
00040 <dd>Pointer to a page of data. The remaining packets in the stream will be placed into this page, if any remain.
00041 </dl>
00042
00043
00044 <h3>Return Values</h3>
00045 <blockquote>
00046 <li>0 means that all packet data has already been flushed into pages, and there are no packets to put into the page.</li>
00047 <li>
00048 Nonzero means that remaining packets have successfully been flushed into the page.</li>
00049 </blockquote>
00050 <p>
00051
00052 <br><br>
00053 <hr noshade>
00054 <table border=0 width=100%>
00055 <tr valign=top>
00056 <td><p class=tiny>copyright © 2000 xiph.org</p></td>
00057 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td>
00058 </tr><tr>
00059 <td><p class=tiny>libogg documentation</p></td>
00060 <td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td>
00061 </tr>
00062 </table>
00063
00064
00065 </body>
00066
00067 </html>
