doc/libogg/ogg_sync_check.html

   1 <html>
   2
   3 <head>
   4 <title>libogg - function - ogg_sync_check</title>
   5 <link rel=stylesheet href="style.css" type="text/css">
   6 </head>
   7
   8 <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
   9 <table border=0 width=100%>
  10 <tr>
  11 <td><p class=tiny>libogg documentation</p></td>
  12 <td align=right><p class=tiny>libogg release 1.3.2 - 20140527</p></td>
  13 </tr>
  14 </table>
  15
  16 <h1>ogg_sync_check</h1>
  17
  18 <p><i>declared in "ogg/ogg.h";</i></p>
  19
  20 <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.
  21 <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
  22 internal error occur, the <a href="ogg_sync_state.html">ogg_sync_state</a> structure will be cleared (equivalent to a
  23 call to
  24 <a href="ogg_sync_clear.html">ogg_sync_clear</a>) and subsequent calls
  25 using this <a href="ogg_sync_state.html">ogg_sync_state</a> will be
  26 noops. Error detection is then handled via a single call to
  27 ogg_sync_check at the end of the operational block. </p>
  28
  29 <br><br>
  30 <table border=0 color=black cellspacing=0 cellpadding=7>
  31 <tr bgcolor=#cccccc>
  32         <td>
  33 <pre><b>
  34 int ogg_sync_check(<a href="ogg_sync_state.html">ogg_sync_state</a> *oy);
  35 </b></pre>
  36         </td>
  37 </tr>
  38 </table>
  39
  40 <h3>Parameters</h3>
  41 <dl>
  42 <dt><i>oy</i></dt>
  43 <dd>Pointer to a previously declared <a href="ogg_sync_state.html">ogg_sync_state</a> struct.</dd>
  44 </dl>
  45
  46
  47 <h3>Return Values</h3>
  48 <blockquote>
  49 <li>
  50 0 is returned if the <a href="ogg_sync_state.html">ogg_sync_state</a> structure is initialized and ready.</li>
  51 <li>
  52 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>
  53 </blockquote>
  54 <p>
  55
  56 <br><br>
  57 <hr noshade>
  58 <table border=0 width=100%>
  59 <tr valign=top>
  60 <td><p class=tiny>copyright &copy; 2000-2014 Xiph.Org</p></td>
  61 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/">Ogg Container Format</a></p></td>
  62 </tr><tr>
  63 <td><p class=tiny>libogg documentation</p></td>
  64 <td align=right><p class=tiny>libogg release 1.3.2 - 20140527</p></td>
  65 </tr>
  66 </table>
  67
  68
  69 </body>
  70
  71 </html>