From 8f3471999e929bb99116fac52b94d572c42ba15e Mon Sep 17 00:00:00 2001 From: Aki Date: Wed, 29 Sep 2021 22:52:15 +0200 Subject: Squashed 'ogg/' content from commit 4380566a4 git-subtree-dir: ogg git-subtree-split: 4380566a44b8d5e85ad511c9c17eb04197863ec5 --- doc/libogg/ogg_stream_packetpeek.html | 85 +++++++++++++++++++++++++++++++++++ 1 file changed, 85 insertions(+) create mode 100644 doc/libogg/ogg_stream_packetpeek.html (limited to 'doc/libogg/ogg_stream_packetpeek.html') diff --git a/doc/libogg/ogg_stream_packetpeek.html b/doc/libogg/ogg_stream_packetpeek.html new file mode 100644 index 0000000..a6dc678 --- /dev/null +++ b/doc/libogg/ogg_stream_packetpeek.html @@ -0,0 +1,85 @@ + + + +libogg - function - ogg_stream_packetpeek + + + + + + + + + +

libogg documentation

libogg release 1.3.2 - 20140527

+ +

ogg_stream_packetpeek

+ +

declared in "ogg/ogg.h";

+ +

This function attempts to assemble a raw data packet and returns +it without advancing decoding.

+ +

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

+ +

+ + + + + +
+

+int ogg_stream_packetpeek(ogg_stream_state *os,ogg_packet *op);
+
+
+ +

Parameters

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

Return Values

+
+ +
+ + +

+ +
+ + + + + + + + + +

copyright © 2000-2014 Xiph.Org

Ogg Container Format

libogg documentation

libogg release 1.3.2 - 20140527

+ + + + + -- cgit v1.1