00001 <html>
00002
00003 <head>
00004 <title>Tremor - function - ov_pcm_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_pcm_seek_page</h1>
00017
00018 <p><i>declared in "ivorbisfile.h";</i></p>
00019
00020 <p>Seeks to the closest page preceding the specified location (in pcm samples) within the physical bitstream. This function only works for seekable streams.
00021 <p>This function is faster than <a href="ov_pcm_seek.html">ov_pcm_seek</a> because the function can begin decoding at a page boundary rather than seeking through any remaining samples before the specified location. However, it is less accurate.
00022 <p>This 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>
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_pcm_seek_page(OggVorbis_File *vf,ogg_int64_t pos);
00033 </b></pre>
00034 </td>
00035 </tr>
00036 </table>
00037
00038 <h3>Parameters</h3>
00039 <dl>
00040 <dt><i>vf</i></dt>
00041 <dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible libvorbisidec
00042 functions.</dd>
00043 <dt><i>pos</i></dt>
00044 <dd>Position in pcm samples to seek to in the bitstream.</dd>
00045 </dl>
00046
00047
00048 <h3>Return Values</h3>
00049 <blockquote>
00050 <li>
00051 0 for success</li>
00052
00053 <li>
00054 nonzero indicates failure, described by several error codes:</li>
00055 <ul>
00056 <li>OV_ENOSEEK - Bitstream is not seekable.
00057 </li>
00058 <li>OV_EINVAL - Invalid argument value.
00059 </li>
00060 <li>OV_EREAD - A read from media returned an error.
00061 </li>
00062 <li>OV_EFAULT - Internal logic fault; indicates a bug or heap/stack
00063 corruption.
00064 </li>
00065 <li>OV_EBADLINK - Invalid stream section supplied to libvorbisidec, or the requested link is corrupt.
00066 </li>
00067 </ul></blockquote>
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>
