Tremor/doc/ov_raw_seek.html

   1 <html>
   2
   3 <head>
   4 <title>Tremor - 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>Tremor documentation</p></td>
  12 <td align=right><p class=tiny>Tremor version 1.0 - 20020403</p></td>
  13 </tr>
  14 </table>
  15
  16 <h1>ov_raw_seek</h1>
  17
  18 <p><i>declared in "ivorbisfile.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 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 libvorbisidec
  40 functions.</dd>
  41 <dt><i>pos</i></dt>
  42 <dd>Position in compressed bytes to seek to in the bitstream.</dd>
  43 </dl>
  44
  45
  46 <h3>Return Values</h3>
  47 <blockquote>
  48 <li>0 indicates success</li>
  49 <li>nonzero indicates failure, described by several error codes:</li>
  50 <ul>
  51 <li>OV_ENOSEEK - Bitstream is not seekable.
  52 </li>
  53 <li>OV_EINVAL - Invalid argument value.
  54 </li>
  55 <li>OV_EBADLINK - Invalid stream section supplied to libvorbisidec, or the requested link is corrupt.
  56 </li>
  57 </ul>
  58 </blockquote>
  59 <p>
  60
  61 <br><br>
  62 <hr noshade>
  63 <table border=0 width=100%>
  64 <tr valign=top>
  65 <td><p class=tiny>copyright &copy; 2002 Xiph.org</p></td>
  66 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
  67 </tr><tr>
  68 <td><p class=tiny>Tremor documentation</p></td>
  69 <td align=right><p class=tiny>Tremor version 1.0 - 20020403</p></td>
  70 </tr>
  71 </table>
  72
  73 </body>
  74
  75 </html>