|
Chris@1
|
1 <html>
|
|
Chris@1
|
2
|
|
Chris@1
|
3 <head>
|
|
Chris@1
|
4 <title>libogg - function - ogg_stream_pageout</title>
|
|
Chris@1
|
5 <link rel=stylesheet href="style.css" type="text/css">
|
|
Chris@1
|
6 </head>
|
|
Chris@1
|
7
|
|
Chris@1
|
8 <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
|
|
Chris@1
|
9 <table border=0 width=100%>
|
|
Chris@1
|
10 <tr>
|
|
Chris@1
|
11 <td><p class=tiny>libogg documentation</p></td>
|
|
Chris@1
|
12 <td align=right><p class=tiny>libogg release 1.3.0 - 20110804</p></td>
|
|
Chris@1
|
13 </tr>
|
|
Chris@1
|
14 </table>
|
|
Chris@1
|
15
|
|
Chris@1
|
16 <h1>ogg_stream_pageout</h1>
|
|
Chris@1
|
17
|
|
Chris@1
|
18 <p><i>declared in "ogg/ogg.h";</i></p>
|
|
Chris@1
|
19
|
|
Chris@1
|
20 <p>This function forms packets into pages.</p>
|
|
Chris@1
|
21
|
|
Chris@1
|
22 <p>In a typical encoding situation, this would be called after using <a
|
|
Chris@1
|
23 href="ogg_stream_packetin.html">ogg_stream_packetin()</a> to submit
|
|
Chris@1
|
24 data packets to the bitstream. Internally, this function assembles
|
|
Chris@1
|
25 the accumulated packet bodies into an Ogg page suitable for writing
|
|
Chris@1
|
26 to a stream. The function is typically called in a loop until there
|
|
Chris@1
|
27 are no more pages ready for output.</p>
|
|
Chris@1
|
28
|
|
Chris@1
|
29 <p>This function will only return a page when a "reasonable" amount of
|
|
Chris@1
|
30 packet data is available. Normally this is appropriate since it
|
|
Chris@1
|
31 limits the overhead of the Ogg page headers in the bitstream, and so
|
|
Chris@1
|
32 calling ogg_stream_pageout() after ogg_stream_packetin() should be the
|
|
Chris@1
|
33 common case. Call <a href="ogg_stream_flush.html">ogg_stream_flush()</a>
|
|
Chris@1
|
34 if immediate page generation is desired. This may be occasionally
|
|
Chris@1
|
35 necessary, for example, to limit the temporal latency of a variable
|
|
Chris@1
|
36 bitrate stream.</p>
|
|
Chris@1
|
37
|
|
Chris@1
|
38 <br><br>
|
|
Chris@1
|
39 <table border=0 color=black cellspacing=0 cellpadding=7>
|
|
Chris@1
|
40 <tr bgcolor=#cccccc>
|
|
Chris@1
|
41 <td>
|
|
Chris@1
|
42 <pre><b>
|
|
Chris@1
|
43 int ogg_stream_pageout(<a href="ogg_stream_state.html">ogg_stream_state</a> *os, <a href="ogg_page.html">ogg_page</a> *og);
|
|
Chris@1
|
44 </b></pre>
|
|
Chris@1
|
45 </td>
|
|
Chris@1
|
46 </tr>
|
|
Chris@1
|
47 </table>
|
|
Chris@1
|
48
|
|
Chris@1
|
49 <h3>Parameters</h3>
|
|
Chris@1
|
50 <dl>
|
|
Chris@1
|
51 <dt><i>os</i></dt>
|
|
Chris@1
|
52 <dd>Pointer to a previously declared <a href="ogg_stream.html">ogg_stream</a> struct, which represents the current logical bitstream.</dd>
|
|
Chris@1
|
53 <dt><i>og</i></dt>
|
|
Chris@1
|
54 <dd>Pointer to an <a href="ogg_page.html">ogg_page</a> structure to fill
|
|
Chris@1
|
55 in. Data pointed to is owned by libogg. The structure is valid until the
|
|
Chris@1
|
56 next call to ogg_stream_pageout(), ogg_stream_packetin(), or
|
|
Chris@1
|
57 ogg_stream_flush().</dd>
|
|
Chris@1
|
58 </dl>
|
|
Chris@1
|
59
|
|
Chris@1
|
60
|
|
Chris@1
|
61 <h3>Return Values</h3>
|
|
Chris@1
|
62 <blockquote>
|
|
Chris@1
|
63 <li>Zero means that insufficient data has accumulated to fill a page, or an internal error occurred. In
|
|
Chris@1
|
64 this case <i>og</i> is not modified.</li>
|
|
Chris@1
|
65 <li>Non-zero means that a page has been completed and returned.</li>
|
|
Chris@1
|
66 </blockquote>
|
|
Chris@1
|
67 <p>
|
|
Chris@1
|
68
|
|
Chris@1
|
69 <br><br>
|
|
Chris@1
|
70 <hr noshade>
|
|
Chris@1
|
71 <table border=0 width=100%>
|
|
Chris@1
|
72 <tr valign=top>
|
|
Chris@1
|
73 <td><p class=tiny>copyright © 2000-2010 xiph.org</p></td>
|
|
Chris@1
|
74 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/">Ogg Container Format</a></p></td>
|
|
Chris@1
|
75 </tr><tr>
|
|
Chris@1
|
76 <td><p class=tiny>libogg documentation</p></td>
|
|
Chris@1
|
77 <td align=right><p class=tiny>libogg release 1.3.0 - 20110804</p></td>
|
|
Chris@1
|
78 </tr>
|
|
Chris@1
|
79 </table>
|
|
Chris@1
|
80
|
|
Chris@1
|
81
|
|
Chris@1
|
82 </body>
|
|
Chris@1
|
83
|
|
Chris@1
|
84 </html>
|
