ov_time_seek_page.html 2.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485
  1. <html>
  2. <head>
  3. <title>vorbisfile - function - ov_time_seek_page</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>vorbisfile documentation</p></td>
  10. <td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td>
  11. </tr>
  12. </table>
  13. <h1>ov_time_seek_page</h1>
  14. <p><i>declared in "vorbis/vorbisfile.h";</i></p>
  15. <p>For seekable
  16. streams, this seeks to closest full page preceding the given time. This function is faster than <a href="ov_time_seek.html">ov_time_seek</a> because it doesn't seek through the last few samples to reach an exact time, but it is also less accurate. This should be used when speed is important.
  17. <p>This function also updates everything needed within the
  18. decoder, so you can immediately call <a href="ov_read.html">ov_read()</a> and get data from
  19. the newly seeked to position.
  20. <p>For obvious reasons, this doesn't work for unseekable streams.
  21. <br><br>
  22. <table border=0 color=black cellspacing=0 cellpadding=7>
  23. <tr bgcolor=#cccccc>
  24. <td>
  25. <pre><b>
  26. int ov_time_seek_page(<a href="OggVorbis_File.html">OggVorbis_File</a> *vf, double seconds);
  27. </b></pre>
  28. </td>
  29. </tr>
  30. </table>
  31. <h3>Parameters</h3>
  32. <dl>
  33. <dt><i>vf</i></dt>
  34. <dd>Pointer to our already opened and initialized OggVorbis_File structure.</dd>
  35. <dt><i>seconds</i></dt>
  36. <dd>Location to seek to within the file, specified in seconds.</dd>
  37. </dl>
  38. <h3>Return Values</h3>
  39. <blockquote>
  40. <li>
  41. 0 for success</li>
  42. <li>
  43. nonzero indicates failure, described by several error codes:</li>
  44. <ul>
  45. <li>OV_ENOSEEK - Bitstream is not seekable.
  46. </li>
  47. <li>OV_EINVAL - Invalid argument value.
  48. </li>
  49. <li>OV_EREAD - A read from media returned an error.
  50. </li>
  51. <li>OV_EFAULT - Internal logic fault; indicates a bug or heap/stack
  52. corruption.
  53. </li>
  54. <li>OV_EBADLINK - Invalid stream section supplied to libvorbis/libvorbisfile, or the requested link is corrupt.
  55. </li>
  56. </ul></blockquote>
  57. <br><br>
  58. <hr noshade>
  59. <table border=0 width=100%>
  60. <tr valign=top>
  61. <td><p class=tiny>copyright &copy; 2000 vorbis team</p></td>
  62. <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td>
  63. </tr><tr>
  64. <td><p class=tiny>vorbisfile documentation</p></td>
  65. <td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td>
  66. </tr>
  67. </table>
  68. </body>
  69. </html>