|
cannam@86
|
1 <html>
|
|
cannam@86
|
2
|
|
cannam@86
|
3 <head>
|
|
cannam@86
|
4 <title>libogg - function - ogg_stream_packetpeek</title>
|
|
cannam@86
|
5 <link rel=stylesheet href="style.css" type="text/css">
|
|
cannam@86
|
6 </head>
|
|
cannam@86
|
7
|
|
cannam@86
|
8 <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
|
|
cannam@86
|
9 <table border=0 width=100%>
|
|
cannam@86
|
10 <tr>
|
|
cannam@86
|
11 <td><p class=tiny>libogg documentation</p></td>
|
|
cannam@86
|
12 <td align=right><p class=tiny>libogg release 1.3.0 - 20110804</p></td>
|
|
cannam@86
|
13 </tr>
|
|
cannam@86
|
14 </table>
|
|
cannam@86
|
15
|
|
cannam@86
|
16 <h1>ogg_stream_packetpeek</h1>
|
|
cannam@86
|
17
|
|
cannam@86
|
18 <p><i>declared in "ogg/ogg.h";</i></p>
|
|
cannam@86
|
19
|
|
cannam@86
|
20 <p>This function attempts to assemble a raw data packet and returns
|
|
cannam@86
|
21 it without advancing decoding.</p>
|
|
cannam@86
|
22
|
|
cannam@86
|
23 <p>In a typical situation, this would be called
|
|
cannam@86
|
24 speculatively after <a
|
|
cannam@86
|
25 href="ogg_stream_pagein.html">ogg_stream_pagein()</a> to check
|
|
cannam@86
|
26 the packet contents before handing it off to a codec for
|
|
cannam@86
|
27 decompression. To advance page decoding and remove
|
|
cannam@86
|
28 the packet from the sync structure, call
|
|
cannam@86
|
29 <a href="ogg_stream_packetout.html">ogg_stream_packetout()</a>.</p>
|
|
cannam@86
|
30
|
|
cannam@86
|
31 <br><br>
|
|
cannam@86
|
32
|
|
cannam@86
|
33 <table border=0 color=black cellspacing=0 cellpadding=7>
|
|
cannam@86
|
34 <tr bgcolor=#cccccc>
|
|
cannam@86
|
35 <td>
|
|
cannam@86
|
36 <pre><b>
|
|
cannam@86
|
37 int ogg_stream_packetpeek(ogg_stream_state *os,ogg_packet *op);
|
|
cannam@86
|
38 </b></pre>
|
|
cannam@86
|
39 </td>
|
|
cannam@86
|
40 </tr>
|
|
cannam@86
|
41 </table>
|
|
cannam@86
|
42
|
|
cannam@86
|
43 <h3>Parameters</h3>
|
|
cannam@86
|
44 <dl>
|
|
cannam@86
|
45 <dt><i>os</i></dt>
|
|
cannam@86
|
46 <dd>Pointer to a previously declared
|
|
cannam@86
|
47 <a href="ogg_stream_state.html">ogg_stream_state</a> struct. Before this
|
|
cannam@86
|
48 function is called, an <a href="ogg_page.html">ogg_page</a> should be
|
|
cannam@86
|
49 submitted to the stream using
|
|
cannam@86
|
50 <a href="ogg_stream_pagein.html">ogg_stream_pagein()</a>.</dd>
|
|
cannam@86
|
51 <dt><i>op</i></dt>
|
|
cannam@86
|
52 <dd>Pointer to the next packet available in the bitstream, if
|
|
cannam@86
|
53 any. A NULL value may be passed in the case of a simple "is there a
|
|
cannam@86
|
54 packet?" check.</dd>
|
|
cannam@86
|
55 </dl>
|
|
cannam@86
|
56
|
|
cannam@86
|
57
|
|
cannam@86
|
58 <h3>Return Values</h3>
|
|
cannam@86
|
59 <blockquote>
|
|
cannam@86
|
60 <ul>
|
|
cannam@86
|
61 <li>-1 if there's no packet available due to lost sync or a hole in the data.</li>
|
|
cannam@86
|
62 <li>0 if there is insufficient data available to complete a packet, or on unrecoverable internal error occurred.</li>
|
|
cannam@86
|
63 <li>1 if a packet is available.</li>
|
|
cannam@86
|
64 </ul>
|
|
cannam@86
|
65 </blockquote>
|
|
cannam@86
|
66
|
|
cannam@86
|
67
|
|
cannam@86
|
68 <br><br>
|
|
cannam@86
|
69
|
|
cannam@86
|
70 <hr noshade>
|
|
cannam@86
|
71
|
|
cannam@86
|
72 <table border=0 width=100%>
|
|
cannam@86
|
73 <tr valign=top>
|
|
cannam@86
|
74 <td><p class=tiny>copyright © 2000-2011 Xiph.Org</p></td>
|
|
cannam@86
|
75 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/">Ogg Container Format</a></p></td>
|
|
cannam@86
|
76 </tr><tr>
|
|
cannam@86
|
77 <td><p class=tiny>libogg documentation</p></td>
|
|
cannam@86
|
78 <td align=right><p class=tiny>libogg release 1.3.0 - 20110804</p></td>
|
|
cannam@86
|
79 </tr>
|
|
cannam@86
|
80 </table>
|
|
cannam@86
|
81
|
|
cannam@86
|
82
|
|
cannam@86
|
83 </body>
|
|
cannam@86
|
84
|
|
cannam@86
|
85 </html>
|
