ov_test_open.html 1.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182
  1. <html>
  2. <head>
  3. <title>Tremor - function - ov_test_open</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_test_open</h1>
  14. <p><i>declared in "ivorbisfile.h";</i></p>
  15. <p>
  16. Finish opening a file partially opened with <a href="ov_test.html">ov_test()</a>
  17. or <a href="ov_test_callbacks.html">ov_test_callbacks()</a>.
  18. <p>
  19. <table border=0 color=black cellspacing=0 cellpadding=7>
  20. <tr bgcolor=#cccccc>
  21. <td>
  22. <pre><b>
  23. int ov_test_open(<a href="OggVorbis_File.html">OggVorbis_File</a> *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. Once this has been called, the same <tt>OggVorbis_File</tt>
  33. struct should be passed to all the libvorbisidec functions.</dd>
  34. </dl>
  35. <h3>Return Values</h3>
  36. <blockquote>
  37. <li>
  38. 0 for success</li>
  39. <li>less than zero for failure:</li>
  40. <ul>
  41. <li>OV_EREAD - A read from media returned an error.</li>
  42. <li>OV_ENOTVORBIS - Bitstream is not Vorbis data.</li>
  43. <li>OV_EVERSION - Vorbis version mismatch.</li>
  44. <li>OV_EBADHEADER - Invalid Vorbis bitstream header.</li>
  45. <li>OV_EFAULT - Internal logic fault; indicates a bug or heap/stack corruption.</li>
  46. </ul>
  47. </blockquote>
  48. <p>
  49. <br><br>
  50. <hr noshade>
  51. <table border=0 width=100%>
  52. <tr valign=top>
  53. <td><p class=tiny>copyright &copy; 2002 Xiph.org</p></td>
  54. <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
  55. </tr><tr>
  56. <td><p class=tiny>Tremor documentation</p></td>
  57. <td align=right><p class=tiny>Tremor version 1.0 - 20020403</p></td>
  58. </tr>
  59. </table>
  60. </body>
  61. </html>