From 373dc625f82b47096893add42c4472e4a57ab7eb Mon Sep 17 00:00:00 2001 From: Aki Date: Wed, 9 Feb 2022 22:23:03 +0100 Subject: Moved third-party libraries to a separate subdirectory --- contrib/ogg/doc/libogg/ogg_stream_check.html | 71 ++++++++++++++++++++++++++++ 1 file changed, 71 insertions(+) create mode 100644 contrib/ogg/doc/libogg/ogg_stream_check.html (limited to 'contrib/ogg/doc/libogg/ogg_stream_check.html') diff --git a/contrib/ogg/doc/libogg/ogg_stream_check.html b/contrib/ogg/doc/libogg/ogg_stream_check.html new file mode 100644 index 0000000..64d171f --- /dev/null +++ b/contrib/ogg/doc/libogg/ogg_stream_check.html @@ -0,0 +1,71 @@ + + + +libogg - function - ogg_stream_check + + + + + + + + + +

libogg documentation

libogg release 1.3.2 - 20140527

+ +

ogg_stream_check

+ +

declared in "ogg/ogg.h";

+ +

This function is used to check the error or readiness condition of an ogg_stream_state structure. +

It is safe practice to ignore unrecoverable errors (such as an internal error caused by a malloc() failure) returned by ogg stream synchronization calls. Should an +internal error occur, the ogg_stream_state structure will be cleared (equivalent to a +call to +ogg_stream_clear) and subsequent calls +using this ogg_stream_state will be +noops. Error detection is then handled via a single call to +ogg_stream_check at the end of the operational block.

+ +

+ + + + +


+int ogg_stream_check(ogg_stream_state *os);
+

+ +

Parameters

os: Pointer to a previously declared ogg_stream_state struct.

+ + +

Return Values

+
+0 is returned if the ogg_stream_state structure is initialized and ready.
+
+nonzero is returned if the structure was never initialized, or if an unrecoverable internal error occurred in a previous call using the passed in ogg_stream_state struct.
+

+ +

+

+ + + + + + + + +

copyright © 2000-2014 Xiph.Org	Ogg Container Format
libogg documentation	libogg release 1.3.2 - 20140527

+ + + + + -- cgit v1.1