ogg_stream_pageout.html 2.69 KB
Newer Older
Jack Moffitt's avatar
Jack Moffitt committed
1 2 3 4 5 6 7 8 9 10 11
<html>

<head>
<title>libogg - function - ogg_stream_pageout</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>
12
<td align=right><p class=tiny>libogg release 1.3.3 - 20171107</p></td>
Jack Moffitt's avatar
Jack Moffitt committed
13 14 15 16 17 18 19
</tr>
</table>

<h1>ogg_stream_pageout</h1>

<p><i>declared in "ogg/ogg.h";</i></p>

20 21
<p>This function forms packets into pages.</p>

22 23 24 25
<p>In a typical encoding situation, this would be called after using <a
href="ogg_stream_packetin.html">ogg_stream_packetin()</a> to submit
data packets to the bitstream. Internally, this function assembles
the accumulated packet bodies into an Ogg page suitable for writing
26 27
to a stream. The function is typically called in a loop until there
are no more pages ready for output.</p>
28

29 30
<p>This function will only return a page when a "reasonable" amount of
packet data is available. Normally this is appropriate since it
31
limits the overhead of the Ogg page headers in the bitstream, and so
32 33 34 35
calling ogg_stream_pageout() after ogg_stream_packetin() should be the
common case. Call <a href="ogg_stream_flush.html">ogg_stream_flush()</a>
if immediate page generation is desired. This may be occasionally
necessary, for example, to limit the temporal latency of a variable
36
bitrate stream.</p>
Jack Moffitt's avatar
Jack Moffitt committed
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51

<br><br>
<table border=0 color=black cellspacing=0 cellpadding=7>
<tr bgcolor=#cccccc>
	<td>
<pre><b>
int ogg_stream_pageout(<a href="ogg_stream_state.html">ogg_stream_state</a> *os, <a href="ogg_page.html">ogg_page</a> *og);
</b></pre>
	</td>
</tr>
</table>

<h3>Parameters</h3>
<dl>
<dt><i>os</i></dt>
52 53
<dd>Pointer to a previously declared <a href="ogg_stream.html">ogg_stream</a> struct, which represents the current logical bitstream.</dd>
<dt><i>og</i></dt>
54
<dd>Pointer to an <a href="ogg_page.html">ogg_page</a> structure to fill
55 56
in. Data pointed to is owned by libogg. The structure is valid until the
next call to ogg_stream_pageout(), ogg_stream_packetin(), or
57
ogg_stream_flush().</dd>
Jack Moffitt's avatar
Jack Moffitt committed
58 59 60 61 62
</dl>


<h3>Return Values</h3>
<blockquote>
63
<li>Zero means that insufficient data has accumulated to fill a page, or an internal error occurred. In
64 65
this case <i>og</i> is not modified.</li>
<li>Non-zero means that a page has been completed and returned.</li>
Jack Moffitt's avatar
Jack Moffitt committed
66 67 68 69 70 71 72
</blockquote>
<p>

<br><br>
<hr noshade>
<table border=0 width=100%>
<tr valign=top>
73
<td><p class=tiny>copyright &copy; 2000-2017 Xiph.Org Foundation</p></td>
74
<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/">Ogg Container Format</a></p></td>
Jack Moffitt's avatar
Jack Moffitt committed
75 76
</tr><tr>
<td><p class=tiny>libogg documentation</p></td>
77
<td align=right><p class=tiny>libogg release 1.3.3 - 20171107</p></td>
Jack Moffitt's avatar
Jack Moffitt committed
78 79 80 81 82 83 84
</tr>
</table>


</body>

</html>