00001 <html>
00002
00003 <head>
00004 <title>libogg - datatype - ogg_packet</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 - 20011015</p></td>
00013 </tr>
00014 </table>
00015
00016 <h1>ogg_packet</h1>
00017
00018 <p><i>declared in "ogg/ogg.h"</i></p>
00019
00020 <p>
00021 The ogg_packet struct encapsulates the data for a single raw packet of data
00022 and is used to transfer data between the ogg framing layer and the handling codec.
00023 <p>
00024
00025 <table border=0 width=100% color=black cellspacing=0 cellpadding=7>
00026 <tr bgcolor=#cccccc>
00027 <td>
00028 <pre><b>
00029 typedef struct {
00030 unsigned char *packet;
00031 long bytes;
00032 long b_o_s;
00033 long e_o_s;
00034
00035 ogg_int64_t granulepos;
00036 ogg_int64_t packetno;
00037
00038 } ogg_packet;
00039 </b></pre>
00040 </td>
00041 </tr>
00042 </table>
00043
00044 <h3>Relevant Struct Members</h3>
00045 <dl>
00046 <dt><i>packet</i></dt>
00047 <dd>Pointer to the packet's data. This is treated as an opaque type by the ogg layer.</dd>
00048 <dt><i>bytes</i></dt>
00049 <dd>Indicates the size of the packet data in bytes. Packets can be of arbitrary size.</dd>
00050 <dt><i>b_o_s</i></dt>
00051 <dd>Flag indicating whether this packet begins a logical bitstream. <tt>1</tt> indicates this is the first packet, <tt>0</tt> indicates any other position in the stream.</dd>
00052 <dt><i>e_o_s</i></dt>
00053 <dd>Flag indicating whether this packet ends a bitstream. <tt>1</tt> indicates the last packet, <tt>0</tt> indicates any other position in the stream.</dd>
00054 <dt><i>granulepos</i></dt>
00055 <dd>A number indicating the position of this packet in the decoded data. This is the last sample, frame or other unit of information ('granule') that can be completely decoded from this packet.</dd>
00056 <dt><i>packetno</i></dt>
00057 <dd>Sequential number of this packet in the ogg bitstream.<dd>
00058 </dl>
00059
00060
00061 <br><br>
00062 <hr noshade>
00063 <table border=0 width=100%>
00064 <tr valign=top>
00065 <td><p class=tiny>copyright © 2001 xiph.org foundation</p></td>
00066 <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>
00067 </tr><tr>
00068 <td><p class=tiny>libogg documentation</p></td>
00069 <td align=right><p class=tiny>libogg - 20011015</p></td>
00070 </tr>
00071 </table>
00072
00073 </body>
00074
00075 </html>
