1<html>
2
3<head>
4<title>libogg - function - ogg_stream_pagein</title>
5<link rel=stylesheet href="style.css" type="text/css">
6</head>
7
8<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
9<table border=0 width=100%>
10<tr>
11<td><p class=tiny>libogg documentation</p></td>
12<td align=right><p class=tiny>libogg release 1.2.0 - 20100325</p></td>
13</tr>
14</table>
15
16<h1>ogg_stream_pagein</h1>
17
18<p><i>declared in "ogg/ogg.h";</i></p>
19
20<p>This function adds a complete page to the bitstream.
21 <p>In a typical decoding situation, this function would be called after using <a href="ogg_sync_pageout.html">ogg_sync_pageout</a> to create a valid <a href="ogg_page.html">ogg_page</a> struct.
22<p>Internally, this function breaks the page into packet segments in preparation for outputting a valid packet to the codec decoding layer.
23
24<br><br>
25<table border=0 color=black cellspacing=0 cellpadding=7>
26<tr bgcolor=#cccccc>
27	<td>
28<pre><b>
29int ogg_stream_pagein(<a href="ogg_stream_state.html">ogg_stream_state</a> *os, <a href="ogg_page.html">ogg_page</a> *og);
30</b></pre>
31	</td>
32</tr>
33</table>
34
35<h3>Parameters</h3>
36<dl>
37<dt><i>os</i></dt>
38<dd>Pointer to a previously declared <a href="ogg_stream.html">ogg_stream</a> struct, which represents the current logical bitstream.</dd>
39<dt><i>og</i></dt>
40<dd>Pointer to a page of data.  The data inside this page is being submitted to the streaming layer in order to be allocated into packets.
41</dl>
42
43
44<h3>Return Values</h3>
45<blockquote>
46<li>-1 indicates failure.  This means that the serial number of the page did not match the serial number of the bitstream, the page version was incorrect, or an internal error accurred.</li>
47<li>
480 means that the page was successfully submitted to the bitstream.</li>
49</blockquote>
50<p>
51
52<br><br>
53<hr noshade>
54<table border=0 width=100%>
55<tr valign=top>
56<td><p class=tiny>copyright &copy; 2000-2010 Xiph.Org</p></td>
57<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/">Ogg Container Format</a></p></td>
58</tr><tr>
59<td><p class=tiny>libogg documentation</p></td>
60<td align=right><p class=tiny>libogg release 1.2.0 - 20100325</p></td>
61</tr>
62</table>
63
64
65</body>
66
67</html>
68