doc/vorbisfile/ov_pcm_seek.html

   1 <html>
   2
   3 <head>
   4 <title>vorbisfile - function - ov_bitrate</title>
   5 <link rel=stylesheet href="style.css" type="text/css">
   6 </head>
   7
   8 <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
   9 <table border=0 width=100%>
  10 <tr>
  11 <td><p class=tiny>vorbisfile documentation</p></td>
  12 <td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td>
  13 </tr>
  14 </table>
  15
  16 <h1>ov_pcm_seek</h1>
  17
  18 <p><i>declared in "vorbis/vorbisfile.h";</i></p>
  19
  20 <p>Seeks to the offset specified (in pcm samples) within the physical bitstream.  This function only works for seekable streams.
  21 <p>This also updates everything needed within the
  22 decoder, so you can immediately call <a href="ov_read.html">ov_read()</a> and get data from
  23 the newly seeked to position.
  24 <p>
  25
  26 <br><br>
  27 <table border=0 color=black cellspacing=0 cellpadding=7>
  28 <tr bgcolor=#cccccc>
  29         <td>
  30 <pre><b>
  31 int ov_pcm_seek(OggVorbis_File *vf,int64_t pos);
  32 </b></pre>
  33         </td>
  34 </tr>
  35 </table>
  36
  37 <h3>Parameters</h3>
  38 <dl>
  39 <dt><i>vf</i></dt>
  40 <dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible vorbisfile
  41 functions.</dd>
  42 <dt><i>pos</i></dt>
  43 <dd>Position in pcm samples to seek to in the bitstream.</dd>
  44 </dl>
  45
  46
  47 <h3>Return Values</h3>
  48 <blockquote>
  49 <li>
  50 0 for success</li>
  51
  52 <li>
  53 nonzero indicates failure, described by several error codes:</li>\r
  54 <ul>\r
  55 <li>OV_ENOSEEK - Bitstream is not seekable.\r
  56 </li>\r
  57 <li>OV_EINVAL - Invalid argument value.\r
  58 </li>\r
  59 <li>OV_EREAD - A read from media returned an error.\r
  60 </li>\r
  61 <li>OV_EFAULT - Internal logic fault; indicates a bug or heap/stack \r
  62                 corruption.\r
  63 </li>\r
  64 <li>OV_EBADLINK - Invalid stream section supplied to libvorbis/libvorbisfile, or the requested link is corrupt. \r
  65 </li>\r
  66 </ul></blockquote>
  67 <br><br>
  68 <hr noshade>
  69 <table border=0 width=100%>
  70 <tr valign=top>
  71 <td><p class=tiny>copyright &copy; 2000 vorbis team</p></td>
  72 <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>
  73 </tr><tr>
  74 <td><p class=tiny>vorbisfile documentation</p></td>
  75 <td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td>
  76 </tr>
  77 </table>
  78
  79
  80 </body>
  81
  82 </html>