doc/vorbisfile/ov_raw_seek.html

   1 <html>
   2
   3 <head>
   4 <title>vorbisfile - function - ov_raw_seek</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_raw_seek</h1>
  17
  18 <p><i>declared in "vorbis/vorbisfile.h";</i></p>
  19
  20 <p>Seeks to the offset specified (in compressed raw bytes) 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>When seek speed is a priority, this is the best vorbisfile seek funtion to use.
  25 <br><br>
  26 <table border=0 color=black cellspacing=0 cellpadding=7>
  27 <tr bgcolor=#cccccc>
  28         <td>
  29 <pre><b>
  30 int ov_raw_seek(OggVorbis_File *vf,long pos);
  31 </b></pre>
  32         </td>
  33 </tr>
  34 </table>
  35
  36 <h3>Parameters</h3>
  37 <dl>
  38 <dt><i>vf</i></dt>
  39 <dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible vorbisfile
  40 functions. Once this has been called, the same <tt>OggVorbis_File</tt>
  41 struct should be passed to all the vorbisfile functions.</dd>
  42 <dt><i>pos</i></dt>
  43 <dd>Position in compressed bytes to seek to in the bitstream.</dd>
  44 </dl>
  45
  46
  47 <h3>Return Values</h3>
  48 <blockquote>
  49 <li>
  50 0 indicates success</li>
  51 <li>nonzero indicates failure, described by several error codes:</li>
  52 <ul>
  53 <li>OV_ENOSEEK - Bitstream is not seekable.
  54 </li>
  55 <li>OV_EINVAL - Invalid argument value.
  56 </li>
  57 <li>OV_EBADLINK - Invalid stream section supplied to libvorbis/libvorbisfile, or the requested link is corrupt.
  58 </li>
  59 </ul>
  60 </blockquote>
  61 <p>
  62 <br><br>
  63 <hr noshade>
  64 <table border=0 width=100%>
  65 <tr valign=top>
  66 <td><p class=tiny>copyright &copy; 2000 vorbis team</p></td>
  67 <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>
  68 </tr><tr>
  69 <td><p class=tiny>vorbisfile documentation</p></td>
  70 <td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td>
  71 </tr>
  72 </table>
  73
  74
  75 </body>
  76
  77 </html>