Tremor/doc/ov_time_seek.html

   1 <html>
   2
   3 <head>
   4 <title>Tremor - function - ov_time_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_time_seek</h1>
  17
  18 <p><i>declared in "ivorbisfile.h";</i></p>
  19
  20 <p>For seekable
  21 streams, this seeks to the given time. For implementing seeking in a player,
  22 this is the only function generally needed. This also updates everything needed within the
  23 decoder, so you can immediately call <a href="ov_read.html">ov_read()</a> and get data from
  24 the newly seeked to position.  This function does not work for unseekable streams.
  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_time_seek(<a href="OggVorbis_File.html">OggVorbis_File</a> *vf, ogg_int64_t ms);
  32 </b></pre>
  33         </td>
  34 </tr>
  35 </table>
  36
  37 <h3>Parameters</h3>
  38 <dl>
  39 <dt><i>vf</i></dt>
  40 <dd>Pointer to our already opened and initialized OggVorbis_File structure.</dd>
  41 <dt><i>ms</i></dt>
  42 <dd>Location to seek to within the file, specified in milliseconds.</dd>
  43 </dl>
  44
  45
  46 <h3>Return Values</h3>
  47 <blockquote>
  48 <li>
  49 0 for success</li>
  50
  51 <li>
  52 Nonzero for failure</li>
  53 </blockquote>
  54
  55
  56 <br><br>
  57 <hr noshade>
  58 <table border=0 width=100%>
  59 <tr valign=top>
  60 <td><p class=tiny>copyright &copy; 2002 Xiph.org</p></td>
  61 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
  62 </tr><tr>
  63 <td><p class=tiny>Tremor documentation</p></td>
  64 <td align=right><p class=tiny>Tremor version 1.0 - 20020403</p></td>
  65 </tr>
  66 </table>
  67
  68 </body>
  69
  70 </html>