Chris@1: Chris@1: Chris@1: Chris@1: libogg - function - ogg_stream_packetpeek Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:

libogg documentation

libogg release 1.3.0 - 20110804

Chris@1: Chris@1:

ogg_stream_packetpeek

Chris@1: Chris@1:

declared in "ogg/ogg.h";

Chris@1: Chris@1:

This function attempts to assemble a raw data packet and returns Chris@1: it without advancing decoding.

Chris@1: Chris@1:

In a typical situation, this would be called Chris@1: speculatively after ogg_stream_pagein() to check Chris@1: the packet contents before handing it off to a codec for Chris@1: decompression. To advance page decoding and remove Chris@1: the packet from the sync structure, call Chris@1: ogg_stream_packetout().

Chris@1: Chris@1:

Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:

Chris@1:


Chris@1: int ogg_stream_packetpeek(ogg_stream_state *os,ogg_packet *op);
Chris@1:

Chris@1:

Chris@1: Chris@1:

Parameters

Chris@1:

os: Pointer to a previously declared Chris@1: ogg_stream_state struct. Before this Chris@1: function is called, an ogg_page should be Chris@1: submitted to the stream using Chris@1: ogg_stream_pagein().
op: Pointer to the next packet available in the bitstream, if Chris@1: any. A NULL value may be passed in the case of a simple "is there a Chris@1: packet?" check.

Chris@1: Chris@1: Chris@1:

Return Values

Chris@1:

Chris@1:
Chris@1:
-1 if there's no packet available due to lost sync or a hole in the data.
Chris@1:
0 if there is insufficient data available to complete a packet, or on unrecoverable internal error occurred.
Chris@1:
1 if a packet is available.
Chris@1:
Chris@1:

Chris@1: Chris@1: Chris@1:

Chris@1: Chris@1:

Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:

copyright © 2000-2011 Xiph.Org	Ogg Container Format
libogg documentation	libogg release 1.3.0 - 20110804

Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: