libogg - datatype - ogg_packet

libogg documentation | libogg version 1.25 - 20000615

# ogg_packet

declared in "ogg/ogg.h"

The ogg_packet struct encapsulates the data for a single raw packet of data.

    typedef struct {
      unsigned char *packet;
      long  bytes;
      long  b_o_s;
      long  e_o_s;

      ogg_int64_t  frameno;
      ogg_int64_t  packetno;       /* sequence number for decode; the framing
                                 knows where there's a hole in the data,
                                 but we need coupling so that the codec
                                 (which is in a seperate abstraction
                                 layer) also knows about the gap */

    } ogg_packet;

### Relevant Struct Members

packet
  Pointer to data in form of a packet.
bytes
  Indicates size in bytes of the data within this page. Pages can be of arbitrary size.
b_o_s
  Flag indicating whether this page is at the beginning of a bitstream. `1` indicates beginning page, `0` indicates any other position in the stream.
e_o_s
  Flag indicating whether this page is at the end of a bitstream. `1` indicates ending page, `0` indicates any other position in the stream.
frameno
  Sequential number indicating precise position within stream.
packetno
  Sequential number of this packet. Used within the decoder for internal ordering.

copyright © 2000 xiph.org | Ogg Vorbis team@xiph.org
libogg documentation | libogg version 1.25 - 20000615