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.