00001 <html>
00002
00003 <head>
00004 <title>Tremor - function - ov_time_seek_page</title>
00005 <link rel=stylesheet href="style.css" type="text/css">
00006 </head>
00007
00008 <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
00009 <table border=0 width=100%>
00010 <tr>
00011 <td><p class=tiny>Tremor documentation</p></td>
00012 <td align=right><p class=tiny>Tremor version 1.0 - 20020403</p></td>
00013 </tr>
00014 </table>
00015
00016 <h1>ov_time_seek_page</h1>
00017
00018 <p><i>declared in "ivorbisfile.h";</i></p>
00019
00020 <p>For seekable
00021 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.
00022 <p>This function also updates everything needed within the
00023 decoder, so you can immediately call <a href="ov_read.html">ov_read()</a> and get data from
00024 the newly seeked to position.
00025 <p>This function does not work for unseekable streams.
00026
00027 <br><br>
00028 <table border=0 color=black cellspacing=0 cellpadding=7>
00029 <tr bgcolor=#cccccc>
00030 <td>
00031 <pre><b>
00032 int ov_time_seek_page(<a href="OggVorbis_File.html">OggVorbis_File</a> *vf, ogg_int64_t ms);
00033 </b></pre>
00034 </td>
00035 </tr>
00036 </table>
00037
00038 <h3>Parameters</h3>
00039 <dl>
00040 <dt><i>vf</i></dt>
00041 <dd>Pointer to our already opened and initialized OggVorbis_File structure.</dd>
00042 <dt><i>ms</i></dt>
00043 <dd>Location to seek to within the file, specified in milliseconds.</dd>
00044 </dl>
00045
00046
00047 <h3>Return Values</h3>
00048 <blockquote>
00049 <li>
00050 0 for success</li>
00051
00052 <li>
00053 nonzero indicates failure, described by several error codes:</li>
00054 <ul>
00055 <li>OV_ENOSEEK - Bitstream is not seekable.
00056 </li>
00057 <li>OV_EINVAL - Invalid argument value.
00058 </li>
00059 <li>OV_EREAD - A read from media returned an error.
00060 </li>
00061 <li>OV_EFAULT - Internal logic fault; indicates a bug or heap/stack
00062 corruption.
00063 </li>
00064 <li>OV_EBADLINK - Invalid stream section supplied to libvorbisidec, or the requested link is corrupt.
00065 </li>
00066 </ul></blockquote>
00067
00068
00069 <br><br>
00070 <hr noshade>
00071 <table border=0 width=100%>
00072 <tr valign=top>
00073 <td><p class=tiny>copyright © 2002 Xiph.org</p></td>
00074 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
00075 </tr><tr>
00076 <td><p class=tiny>Tremor documentation</p></td>
00077 <td align=right><p class=tiny>Tremor version 1.0 - 20020403</p></td>
00078 </tr>
00079 </table>
00080
00081 </body>
00082
00083 </html>
