ov_pcm_seek.html 2.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283
  1. <html>
  2. <head>
  3. <title>vorbisfile - function - ov_bitrate</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_pcm_seek</h1>
  14. <p><i>declared in "vorbis/vorbisfile.h";</i></p>
  15. <p>Seeks to the offset specified (in pcm samples) within the physical bitstream. This function only works for seekable streams.
  16. <p>This also updates everything needed within the
  17. decoder, so you can immediately call <a href="ov_read.html">ov_read()</a> and get data from
  18. the newly seeked to position.
  19. <p>
  20. <br><br>
  21. <table border=0 color=black cellspacing=0 cellpadding=7>
  22. <tr bgcolor=#cccccc>
  23. <td>
  24. <pre><b>
  25. int ov_pcm_seek(OggVorbis_File *vf,int64_t pos);
  26. </b></pre>
  27. </td>
  28. </tr>
  29. </table>
  30. <h3>Parameters</h3>
  31. <dl>
  32. <dt><i>vf</i></dt>
  33. <dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible vorbisfile
  34. functions.</dd>
  35. <dt><i>pos</i></dt>
  36. <dd>Position in pcm samples to seek to in the bitstream.</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>