]> git.jsancho.org Git - lugaru.git/blob - libogg-1.0/doc/ogg/ogg_stream_packetout.html
Added (more or less) demo data files.
[lugaru.git] / libogg-1.0 / doc / ogg / ogg_stream_packetout.html
1 <html>
2
3 <head>
4 <title>libogg - function - ogg_stream_packetout</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.0 - 20000615</p></td>
13 </tr>
14 </table>
15
16 <h1>ogg_stream_packetout</h1>
17
18 <p><i>declared in "ogg/ogg.h";</i></p>
19
20 <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>
21 <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>
22
23 <br><br>
24 <table border=0 color=black cellspacing=0 cellpadding=7>
25 <tr bgcolor=#cccccc>
26         <td>
27 <pre><b>
28 int ogg_stream_packetout(ogg_stream_state *os,ogg_packet *op);
29 </b></pre>
30         </td>
31 </tr>
32 </table>
33
34 <h3>Parameters</h3>
35 <dl>
36 <dt><i>os</i></dt>
37 <dd>Pointer to a previously declared <a
38 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>
39 <dt><i>op</i></dt>
40 <dd>Pointer to the packet that will be submitted to the decoding layer after this function is called.</dd>
41 </dl>
42
43
44 <h3>Return Values</h3>
45 <blockquote>
46 <ul>
47 <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>
48 <li>1 in all other cases.</li>
49 </ul>
50 </blockquote>
51
52 <br><br>
53
54 <hr noshade>
55
56 <table border=0 width=100%>
57 <tr valign=top>
58 <td><p class=tiny>copyright &copy; 2000 xiph.org</p></td>
59 <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>
60 </tr><tr>
61 <td><p class=tiny>libogg documentation</p></td>
62 <td align=right><p class=tiny>libogg release 1.0 - 20000615</p></td>
63 </tr>
64 </table>
65
66 </body>
67
68 </html>