|
cannam@86
|
1 <html>
|
|
cannam@86
|
2
|
|
cannam@86
|
3 <head>
|
|
cannam@86
|
4 <title>libogg - function - ogg_stream_flush</title>
|
|
cannam@86
|
5 <link rel=stylesheet href="style.css" type="text/css">
|
|
cannam@86
|
6 </head>
|
|
cannam@86
|
7
|
|
cannam@86
|
8 <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
|
|
cannam@86
|
9 <table border=0 width=100%>
|
|
cannam@86
|
10 <tr>
|
|
cannam@86
|
11 <td><p class=tiny>libogg documentation</p></td>
|
|
cannam@86
|
12 <td align=right><p class=tiny>libogg release 1.3.0 - 20110804</p></td>
|
|
cannam@86
|
13 </tr>
|
|
cannam@86
|
14 </table>
|
|
cannam@86
|
15
|
|
cannam@86
|
16 <h1>ogg_stream_flush</h1>
|
|
cannam@86
|
17
|
|
cannam@86
|
18 <p><i>declared in "ogg/ogg.h";</i></p>
|
|
cannam@86
|
19
|
|
cannam@86
|
20 <p>This function checks for remaining packets inside the stream and forces remaining packets into a page, regardless of the size of the page.
|
|
cannam@86
|
21 <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.
|
|
cannam@86
|
22 <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.
|
|
cannam@86
|
23
|
|
cannam@86
|
24 <br><br>
|
|
cannam@86
|
25 <table border=0 color=black cellspacing=0 cellpadding=7>
|
|
cannam@86
|
26 <tr bgcolor=#cccccc>
|
|
cannam@86
|
27 <td>
|
|
cannam@86
|
28 <pre><b>
|
|
cannam@86
|
29 int ogg_stream_flush(<a href="ogg_stream_state.html">ogg_stream_state</a> *os, <a href="ogg_page.html">ogg_page</a> *og);
|
|
cannam@86
|
30 </b></pre>
|
|
cannam@86
|
31 </td>
|
|
cannam@86
|
32 </tr>
|
|
cannam@86
|
33 </table>
|
|
cannam@86
|
34
|
|
cannam@86
|
35 <h3>Parameters</h3>
|
|
cannam@86
|
36 <dl>
|
|
cannam@86
|
37 <dt><i>os</i></dt>
|
|
cannam@86
|
38 <dd>Pointer to a previously declared <a href="ogg_stream_state.html">ogg_stream_state</a> struct, which represents the current logical bitstream.</dd>
|
|
cannam@86
|
39 <dt><i>og</i></dt>
|
|
cannam@86
|
40 <dd>Pointer to a page of data. The remaining packets in the stream will be placed into this page, if any remain.
|
|
cannam@86
|
41 </dl>
|
|
cannam@86
|
42
|
|
cannam@86
|
43
|
|
cannam@86
|
44 <h3>Return Values</h3>
|
|
cannam@86
|
45 <blockquote>
|
|
cannam@86
|
46 <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>
|
|
cannam@86
|
47 <li>
|
|
cannam@86
|
48 Nonzero means that remaining packets have successfully been flushed into the page.</li>
|
|
cannam@86
|
49 </blockquote>
|
|
cannam@86
|
50 <p>
|
|
cannam@86
|
51
|
|
cannam@86
|
52 <br><br>
|
|
cannam@86
|
53 <hr noshade>
|
|
cannam@86
|
54 <table border=0 width=100%>
|
|
cannam@86
|
55 <tr valign=top>
|
|
cannam@86
|
56 <td><p class=tiny>copyright © 2000-2011 Xiph.Org</p></td>
|
|
cannam@86
|
57 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/">Ogg Container Format</a></p></td>
|
|
cannam@86
|
58 </tr><tr>
|
|
cannam@86
|
59 <td><p class=tiny>libogg documentation</p></td>
|
|
cannam@86
|
60 <td align=right><p class=tiny>libogg release 1.3.0 - 20110804</p></td>
|
|
cannam@86
|
61 </tr>
|
|
cannam@86
|
62 </table>
|
|
cannam@86
|
63
|
|
cannam@86
|
64
|
|
cannam@86
|
65 </body>
|
|
cannam@86
|
66
|
|
cannam@86
|
67 </html>
|
