cannam@86: cannam@86: cannam@86: cannam@86: libogg - function - ogg_stream_packetpeek cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86:

libogg documentation

libogg release 1.3.0 - 20110804

cannam@86: cannam@86:

ogg_stream_packetpeek

cannam@86: cannam@86:

declared in "ogg/ogg.h";

cannam@86: cannam@86:

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

cannam@86: cannam@86:

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

cannam@86: cannam@86:

cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86:

cannam@86:


cannam@86: int ogg_stream_packetpeek(ogg_stream_state *os,ogg_packet *op);
cannam@86:

cannam@86:

cannam@86: cannam@86:

Parameters

cannam@86:

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

cannam@86: cannam@86: cannam@86:

Return Values

cannam@86:

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

cannam@86: cannam@86: cannam@86:

cannam@86: cannam@86:

cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86:

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

cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: