ogg_sync_clear.html 1.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
  1. <html>
  2. <head>
  3. <title>libogg - function - ogg_sync_clear</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_sync_clear</h1>
  14. <p><i>declared in "ogg/ogg.h";</i></p>
  15. <p>This function is used to free the internal storage of an <a href="ogg_sync_state.html">ogg_sync_state</a> struct and resets the struct to the initial state. To free the entire struct, <a href="ogg_sync_destroy.html">ogg_sync_destroy</a> should be used instead. In situations where the struct needs to be reset but the internal storage does not need to be freed, <a href="ogg_sync_reset.html">ogg_sync_reset</a> should be used.
  16. <br><br>
  17. <table border=0 color=black cellspacing=0 cellpadding=7>
  18. <tr bgcolor=#cccccc>
  19. <td>
  20. <pre><b>
  21. int ogg_sync_clear(<a href="ogg_sync_state.html">ogg_sync_state</a> *oy);
  22. </b></pre>
  23. </td>
  24. </tr>
  25. </table>
  26. <h3>Parameters</h3>
  27. <dl>
  28. <dt><i>oy</i></dt>
  29. <dd>Pointer to a previously declared <a href="ogg_sync_state.html">ogg_sync_state</a> struct.</dd>
  30. </dl>
  31. <h3>Return Values</h3>
  32. <blockquote>
  33. <li>
  34. 0 is always returned.</li>
  35. </blockquote>
  36. <p>
  37. <br><br>
  38. <hr noshade>
  39. <table border=0 width=100%>
  40. <tr valign=top>
  41. <td><p class=tiny>copyright &copy; 2000-2019 Xiph.Org Foundation</p></td>
  42. <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/">Ogg Container Format</a></p></td>
  43. </tr><tr>
  44. <td><p class=tiny>libogg documentation</p></td>
  45. <td align=right><p class=tiny>libogg release 1.3.4 - 20190830</p></td>
  46. </tr>
  47. </table>
  48. </body>
  49. </html>