diff options
author | Monty <xiphmont@xiph.org> | 2009-05-27 04:50:41 +0000 |
---|---|---|
committer | Monty <xiphmont@xiph.org> | 2009-05-27 04:50:41 +0000 |
commit | 03f6a49de9eb639c241e98d1b45b6c114aff1e2c (patch) | |
tree | c068d2afeed290d4960389617b476e7e1de9d028 /doc/libogg/ogg_sync_check.html | |
parent | 22f8dcde1fb2ca6316d25f187d340d9b29591294 (diff) | |
download | ogg-git-03f6a49de9eb639c241e98d1b45b6c114aff1e2c.tar.gz |
Commit doc updates relating to async error interface
svn path=/trunk/ogg/; revision=16049
Diffstat (limited to 'doc/libogg/ogg_sync_check.html')
-rw-r--r-- | doc/libogg/ogg_sync_check.html | 71 |
1 files changed, 71 insertions, 0 deletions
diff --git a/doc/libogg/ogg_sync_check.html b/doc/libogg/ogg_sync_check.html new file mode 100644 index 0000000..b1ed8ce --- /dev/null +++ b/doc/libogg/ogg_sync_check.html @@ -0,0 +1,71 @@ +<html> + +<head> +<title>libogg - function - ogg_sync_check</title> +<link rel=stylesheet href="style.css" type="text/css"> +</head> + +<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff"> +<table border=0 width=100%> +<tr> +<td><p class=tiny>libogg documentation</p></td> +<td align=right><p class=tiny>libogg release 1.1.4 - 20090520</p></td> +</tr> +</table> + +<h1>ogg_sync_check</h1> + +<p><i>declared in "ogg/ogg.h";</i></p> + +<p>This function is used to check the error or readiness condition of an <a href="ogg_sync_state.html">ogg_sync_state</a> structure. +<p>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 <a href="ogg_sync_state.html">ogg_sync_state</a>structure will be cleared (equivalent to a +call to +<a href="ogg_sync_clear.html">ogg_sync_clear</a>) and subsequent calls +using this <a href="ogg_sync_state.html">ogg_sync_state</a> will be +noops. Error detection is then handled via a single call to +ogg_sync_check at the end of the operational block. </p> + +<br><br> +<table border=0 color=black cellspacing=0 cellpadding=7> +<tr bgcolor=#cccccc> + <td> +<pre><b> +int ogg_sync_check(<a href="ogg_sync_state.html">ogg_sync_state</a> *oy); +</b></pre> + </td> +</tr> +</table> + +<h3>Parameters</h3> +<dl> +<dt><i>oy</i></dt> +<dd>Pointer to a previously declared <a href="ogg_sync_state.html">ogg_sync_state</a> struct.</dd> +</dl> + + +<h3>Return Values</h3> +<blockquote> +<li> +0 is returned if the <a href="ogg_sync_state.html">ogg_sync_state</a> structure is initialized and ready.</li> +<li> +nonzero is returned if the structure was never initialized, or if an unrecoverable internal error occurred in a previous call using the passed in <a href="ogg_sync_state.html">ogg_sync_state</a> struct.</li> +</blockquote> +<p> + +<br><br> +<hr noshade> +<table border=0 width=100%> +<tr valign=top> +<td><p class=tiny>copyright © 2000-2009 Xiph.Org</p></td> +<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/">Ogg Container Format</a></p></td> +</tr><tr> +<td><p class=tiny>libogg documentation</p></td> +<td align=right><p class=tiny>libogg release 1.1.4 - 20090527</p></td> +</tr> +</table> + + +</body> + +</html> |