00001 <html>
00002
00003 <head>
00004 <title>libogg - function - ogg_stream_pagein</title>
00005 <link rel=stylesheet href="style.css" type="text/css">
00006 </head>
00007
00008 <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
00009 <table border=0 width=100%>
00010 <tr>
00011 <td><p class=tiny>libogg documentation</p></td>
00012 <td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td>
00013 </tr>
00014 </table>
00015
00016 <h1>ogg_stream_pagein</h1>
00017
00018 <p><i>declared in "ogg/ogg.h";</i></p>
00019
00020 <p>This function adds a complete page to the bitstream.
00021 <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.
00022 <p>Internally, this function breaks the page into packet segments in preparation for outputting a valid packet to the codec decoding layer.
00023
00024 <br><br>
00025 <table border=0 color=black cellspacing=0 cellpadding=7>
00026 <tr bgcolor=#cccccc>
00027 <td>
00028 <pre><b>
00029 int ogg_stream_pagein(<a href="ogg_stream_state.html">ogg_stream_state</a> *os, <a href="ogg_page.html">ogg_page</a> *og);
00030 </b></pre>
00031 </td>
00032 </tr>
00033 </table>
00034
00035 <h3>Parameters</h3>
00036 <dl>
00037 <dt><i>os</i></dt>
00038 <dd>Pointer to a previously declared <a href="ogg_stream.html">ogg_stream</a> struct, which represents the current logical bitstream.</dd>
00039 <dt><i>og</i></dt>
00040 <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.
00041 </dl>
00042
00043
00044 <h3>Return Values</h3>
00045 <blockquote>
00046 <li>-1 indicates failure. This means that the serial number of the page did not match the serial number of the bitstream, or that the page version was incorrect.</li>
00047 <li>
00048 0 means that the page was successfully submitted to the bitstream.</li>
00049 </blockquote>
00050 <p>
00051
00052 <br><br>
00053 <hr noshade>
00054 <table border=0 width=100%>
00055 <tr valign=top>
00056 <td><p class=tiny>copyright © 2000 xiph.org</p></td>
00057 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@xiph.org">team@xiph.org</a></p></td>
00058 </tr><tr>
00059 <td><p class=tiny>libogg documentation</p></td>
00060 <td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td>
00061 </tr>
00062 </table>
00063
00064
00065 </body>
00066
00067 </html>
