ov_clear.html 1.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364
  1. <html>
  2. <head>
  3. <title>Tremor - function - ov_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>Tremor documentation</p></td>
  10. <td align=right><p class=tiny>Tremor version 1.0 - 20020403</p></td>
  11. </tr>
  12. </table>
  13. <h1>ov_clear</h1>
  14. <p><i>declared in "ivorbisfile.h";</i></p>
  15. <p> After a bitstream has been opened using <a href="ov_open.html">ov_open()</a>/<a href="ov_open_callbacks.html">ov_open_callbacks()</a> and decoding is complete, the application must call <tt>ov_clear()</tt> to clear
  16. the decoder's buffers and close the file.<p>
  17. <tt>ov_clear()</tt> must also be called after a successful call to <a href="ov_test.html">ov_test()</a> or <a href="ov_test_callbacks.html">ov_test_callbacks()</a>.<p>
  18. <br><br>
  19. <table border=0 color=black cellspacing=0 cellpadding=7>
  20. <tr bgcolor=#cccccc>
  21. <td>
  22. <pre><b>
  23. int ov_clear(OggVorbis_File *vf);
  24. </b></pre>
  25. </td>
  26. </tr>
  27. </table>
  28. <h3>Parameters</h3>
  29. <dl>
  30. <dt><i>vf</i></dt>
  31. <dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible libvorbisidec
  32. functions. After <tt>ov_clear</tt> has been called, the structure is deallocated and can no longer be used.</dd>
  33. </dl>
  34. <h3>Return Values</h3>
  35. <blockquote>
  36. <li>0 for success</li>
  37. </blockquote>
  38. <br><br>
  39. <hr noshade>
  40. <table border=0 width=100%>
  41. <tr valign=top>
  42. <td><p class=tiny>copyright &copy; 2002 Xiph.org</p></td>
  43. <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
  44. </tr><tr>
  45. <td><p class=tiny>Tremor documentation</p></td>
  46. <td align=right><p class=tiny>Tremor version 1.0 - 20020403</p></td>
  47. </tr>
  48. </table>
  49. </body>
  50. </html>