00001 <html>
00002
00003 <head>
00004 <title>libogg - function - ogg_stream_packetpeek</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 version 1.26 - 20010527</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 attempts to assemble a raw data packet and returns
00021 it without advancing decoding.</p>
00022
00023 <p>In a typical situation, this would be called
00024 speculatively after <a
00025 href="ogg_stream_pagein.html">ogg_stream_pagein()</a> to check
00026 the packet contents before handing it off to a codec for
00027 decompression. To advance page decoding and remove
00028 the packet from the sync structure, call
00029 <a href="ogg_stream_packetout.html">ogg_stream_packetout()</a>.</p>
00030
00031 <br><br>
00032
00033 <table border=0 color=black cellspacing=0 cellpadding=7>
00034 <tr bgcolor=#cccccc>
00035 <td>
00036 <pre><b>
00037 int ogg_stream_packetpeek(ogg_stream_state *os,ogg_packet *op);
00038 </b></pre>
00039 </td>
00040 </tr>
00041 </table>
00042
00043 <h3>Parameters</h3>
00044 <dl>
00045 <dt><i>os</i></dt>
00046 <dd>Pointer to a previously declared
00047 <a href="ogg_stream_state.html">ogg_stream_state</a> struct. Before this
00048 function is called, an <a href="ogg_page.html">ogg_page</a> should be
00049 submitted to the stream using
00050 <a href="ogg_stream_pagein.html">ogg_stream_pagein()</a>.</dd>
00051 <dt><i>op</i></dt>
00052 <dd>Pointer to the next packet available in the bitstream, if
00053 any. A NULL value may be passed in the case of a simple "is there a
00054 packet?" check.</dd>
00055 </dl>
00056
00057
00058 <h3>Return Values</h3>
00059 <blockquote>
00060 <ul>
00061 <li>-1 if there's no packet available due to lost sync or a hole
00062 in the data.</li>
00063 <li>1 if a packet is available.</li>
00064 </ul>
00065 </blockquote>
00066
00067
00068 <br><br>
00069
00070 <hr noshade>
00071
00072 <table border=0 width=100%>
00073 <tr valign=top>
00074 <td><p class=tiny>copyright © 2001 xiph.org</p></td>
00075 <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>
00076 </tr><tr>
00077 <td><p class=tiny>libogg documentation</p></td>
00078 <td align=right><p class=tiny>libogg version 1.26 - 20010527</p></td>
00079 </tr>
00080 </table>
00081
00082
00083 </body>
00084
00085 </html>
