4 <title>libogg - function - ogg_stream_pageout_fill</title>
5 <link rel=stylesheet href="style.css" type="text/css">
8 <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
9 <table border=0 width=100%>
11 <td><p class=tiny>libogg documentation</p></td>
12 <td align=right><p class=tiny>libogg release 1.3.5 - 20210603</p></td>
16 <h1>ogg_stream_pageout_fill</h1>
18 <p><i>declared in "ogg/ogg.h";</i></p>
20 <p>This function forms packets into pages, similar
21 to <a href="ogg_stream_pageout.html">ogg_stream_pageout()</a>, but
22 allows applications to explicitly request a specific page spill
25 <p>In a typical encoding situation, this would be called after using <a
26 href="ogg_stream_packetin.html">ogg_stream_packetin()</a> to submit
27 data packets to the bitstream. Internally, this function assembles
28 the accumulated packet bodies into an Ogg page suitable for writing
29 to a stream. The function is typically called in a loop until there
30 are no more pages ready for output.</p>
32 <p>This function will return a page when at least four packets have
33 been accumulated and accumulated packet data meets or exceeds the
34 specified number of bytes, <b>and/or</b> when the accumulated packet
35 data meets/exceeds the maximum page size regardless of accumulated
37 Call <a href="ogg_stream_flush.html">ogg_stream_flush()</a> or
38 <a href="ogg_stream_flush_fill.html">ogg_stream_flush_fill()</a> if
39 immediate page generation is desired regardless of accumulated data.</p>
42 <table border=0 color=black cellspacing=0 cellpadding=7>
46 int ogg_stream_pageout_fill(<a href="ogg_stream_state.html">ogg_stream_state</a> *os, <a href="ogg_page.html">ogg_page</a> *og, int fillbytes);
55 <dd>Pointer to a previously declared <a href="ogg_stream.html">ogg_stream</a> struct, which represents the current logical bitstream.</dd>
57 <dd>Pointer to an <a href="ogg_page.html">ogg_page</a> structure to fill
58 in. Data pointed to is owned by libogg. The structure is valid until the
59 next call to ogg_stream_pageout(), ogg_stream_packetin(), or
60 ogg_stream_flush().</dd>
61 <dt><i>fillbytes</i></dt>
62 <dd>Packet data watermark in bytes.</dd>
66 <h3>Return Values</h3>
68 <li>Zero means that insufficient data has accumulated to fill a page, or an internal error occurred. In
69 this case <i>og</i> is not modified.</li>
70 <li>Non-zero means that a page has been completed and returned.</li>
76 <table border=0 width=100%>
78 <td><p class=tiny>copyright © 2000-2021 Xiph.Org Foundation</p></td>
79 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/">Ogg Container Format</a></p></td>
81 <td><p class=tiny>libogg documentation</p></td>
82 <td align=right><p class=tiny>libogg release 1.3.5 - 20210603</p></td>