Home | History | Annotate | Download | only in vorbisfile 
      1 <html>
      2 
      3 <head>
      4 <title>Vorbisfile - function - ov_time_seek_page</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.2.0 - 20070723</p></td>
     13 </tr>
     14 </table>
     15 
     16 <h1>ov_time_seek_page</h1>
     17 
     18 <p><i>declared in "vorbis/vorbisfile.h";</i></p>
     19 
     20 <p>For seekable
     21 streams, this seeks to closest full page preceding the given time.  This function is faster than <a href="ov_time_seek.html">ov_time_seek</a> because it doesn't seek through the last few samples to reach an exact time, but it is also less accurate.  This should be used when speed is important.
     22 <p>This function 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.  
     25 <p>This function does not work for unseekable streams.
     26 
     27 <br><br>
     28 <table border=0 color=black cellspacing=0 cellpadding=7>
     29 <tr bgcolor=#cccccc>
     30 	<td>
     31 <pre><b>
     32 int ov_time_seek_page(<a href="OggVorbis_File.html">OggVorbis_File</a> *vf, double s);
     33 </b></pre>
     34 	</td>
     35 </tr>
     36 </table>
     37 
     38 <h3>Parameters</h3>
     39 <dl>
     40 <dt><i>vf</i></dt>
     41 <dd>Pointer to our already opened and initialized OggVorbis_File structure.</dd>
     42 <dt><i>ms</i></dt>
     43 <dd>Location to seek to within the file, specified in seconds.</dd>
     44 </dl>
     45 
     46 
     47 <h3>Return Values</h3>
     48 <blockquote>
     49 <ul>
     50 <li>0 for success</li>
     51 
     52 <li>
     53 nonzero indicates failure, described by several error codes:
     54   <ul>
     55   <li>OV_ENOSEEK - Bitstream is not seekable.
     56   </li>
     57   <li>OV_EINVAL - Invalid argument value; possibly called with an OggVorbis_File structure that isn't open.
     58   </li>
     59   <li>OV_EREAD - A read from media returned an error.
     60   </li>
     61   <li>OV_EFAULT - Internal logic fault; indicates a bug or heap/stack 
     62 		corruption.
     63   </li>
     64   <li>OV_EBADLINK - Invalid stream section supplied to libvorbisfile, or the requested link is corrupt. 
     65   </li>
     66   </ul></li>
     67 </ul></blockquote>
     68 
     69 <br><br>
     70 <hr noshade>
     71 <table border=0 width=100%>
     72 <tr valign=top>
     73 <td><p class=tiny>copyright &copy; 2007 Xiph.org</p></td>
     74 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
     75 </tr><tr>
     76 <td><p class=tiny>Vorbisfile documentation</p></td>
     77 <td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
     78 </tr>
     79 </table>
     80 
     81 </body>
     82 
     83 </html>
     84