ov_time_seek_page.html 2.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384
  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.2.0 - 20070723</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>This function does not 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 s);
  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>ms</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. <ul>
  41. <li>0 for success</li>
  42. <li>
  43. nonzero indicates failure, described by several error codes:
  44. <ul>
  45. <li>OV_ENOSEEK - Bitstream is not seekable.
  46. </li>
  47. <li>OV_EINVAL - Invalid argument value; possibly called with an OggVorbis_File structure that isn't open.
  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 libvorbisfile, or the requested link is corrupt.
  55. </li>
  56. </ul></li>
  57. </ul></blockquote>
  58. <br><br>
  59. <hr noshade>
  60. <table border=0 width=100%>
  61. <tr valign=top>
  62. <td><p class=tiny>copyright &copy; 2007 Xiph.org</p></td>
  63. <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
  64. </tr><tr>
  65. <td><p class=tiny>Vorbisfile documentation</p></td>
  66. <td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
  67. </tr>
  68. </table>
  69. </body>
  70. </html>