ogg_stream_check.html 2.3 KB

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