00001 <html>
00002
00003 <head>
00004 <title>libogg - function - ogg_stream_packetout</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_packetout</h1>
00017
00018 <p><i>declared in "ogg/ogg.h";</i></p>
00019
00020 <p>This function assembles a raw data packet for output to the codec decoding engine. The data is already in the stream and broken into packet segments.</p>
00021 <p>In a typical decoding situation, this should be used after calling <a href="ogg_stream_pagein.html">ogg_stream_pagein()</a> to submit a page of data to the bitstream.</p>
00022
00023 <br><br>
00024 <table border=0 color=black cellspacing=0 cellpadding=7>
00025 <tr bgcolor=#cccccc>
00026 <td>
00027 <pre><b>
00028 int ogg_stream_packetout(ogg_stream_state *os,ogg_packet *op);
00029 </b></pre>
00030 </td>
00031 </tr>
00032 </table>
00033
00034 <h3>Parameters</h3>
00035 <dl>
00036 <dt><i>os</i></dt>
00037 <dd>Pointer to a previously declared <a
00038 href="ogg_stream_state.html">ogg_stream_state</a> struct. Before this function is called, an <a href="ogg_page.html">ogg_page</a> should be submitted to the stream using <a href="ogg_stream_pagein.html">ogg_stream_pagein()</a>.</dd>
00039 <dt><i>op</i></dt>
00040 <dd>Pointer to the packet that will be submitted to the decoding layer after this function is called.</dd>
00041 </dl>
00042
00043
00044 <h3>Return Values</h3>
00045 <blockquote>
00046 <ul>
00047 <li>-1 if we are out of sync and there is a gap in the data. Usually this will not be a fatal error.</li>
00048 <li>1 in all other cases.</li>
00049 </ul>
00050 </blockquote>
00051
00052 <br><br>
00053
00054 <hr noshade>
00055
00056 <table border=0 width=100%>
00057 <tr valign=top>
00058 <td><p class=tiny>copyright © 2000 xiph.org</p></td>
00059 <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>
00060 </tr><tr>
00061 <td><p class=tiny>libogg documentation</p></td>
00062 <td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td>
00063 </tr>
00064 </table>
00065
00066 </body>
00067
00068 </html>
