| 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.1.3 - 20040927</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. Each successive call returns the next complete packet built from those 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. If the function returns 0, more data is needed and another page should be submitted. A non-zero return value indicates successful return of a packet.</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 to be filled in with pointers to the new data. |
|---|
| 41 | This will typically be submitted to a codec for decode after this |
|---|
| 42 | function is called.</dd> |
|---|
| 43 | </dl> |
|---|
| 44 | |
|---|
| 45 | |
|---|
| 46 | <h3>Return Values</h3> |
|---|
| 47 | <blockquote> |
|---|
| 48 | <ul> |
|---|
| 49 | <li>-1 if we are out of sync and there is a gap in the data. Usually this will not be a fatal error. <i>op</i> contains a the first packet decodable after the hole.</li> |
|---|
| 50 | <li>0 if there is insufficient data available to complete a packet. <i>op</i> has not been updated. |
|---|
| 51 | <li>1 if a packet was assembled normally. <i>op</i> contains the next packet from the stream.</li> |
|---|
| 52 | </ul> |
|---|
| 53 | </blockquote> |
|---|
| 54 | |
|---|
| 55 | <br><br> |
|---|
| 56 | |
|---|
| 57 | <hr noshade> |
|---|
| 58 | |
|---|
| 59 | <table border=0 width=100%> |
|---|
| 60 | <tr valign=top> |
|---|
| 61 | <td><p class=tiny>copyright © 2004 xiph.org</p></td> |
|---|
| 62 | <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> |
|---|
| 63 | </tr><tr> |
|---|
| 64 | <td><p class=tiny>libogg documentation</p></td> |
|---|
| 65 | <td align=right><p class=tiny>libogg release 1.1.3 - 20040927</p></td> |
|---|
| 66 | </tr> |
|---|
| 67 | </table> |
|---|
| 68 | |
|---|
| 69 | </body> |
|---|
| 70 | |
|---|
| 71 | </html> |
|---|
