00001 <html>
00002
00003 <head>
00004 <title>Tremor - function - ov_pcm_seek</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</h1>
00017
00018 <p><i>declared in "ivorbisfile.h";</i></p>
00019
00020 <p>Seeks to the offset specified (in pcm samples) within the physical bitstream. This function only works for seekable streams.
00021 <p>This also updates everything needed within the
00022 decoder, so you can immediately call <a href="ov_read.html">ov_read()</a> and get data from
00023 the newly seeked to position.
00024 <p>
00025
00026 <br><br>
00027 <table border=0 color=black cellspacing=0 cellpadding=7>
00028 <tr bgcolor=#cccccc>
00029 <td>
00030 <pre><b>
00031 int ov_pcm_seek(OggVorbis_File *vf,ogg_int64_t pos);
00032 </b></pre>
00033 </td>
00034 </tr>
00035 </table>
00036
00037 <h3>Parameters</h3>
00038 <dl>
00039 <dt><i>vf</i></dt>
00040 <dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible libvorbisidec
00041 functions.</dd>
00042 <dt><i>pos</i></dt>
00043 <dd>Position in pcm samples to seek to in the bitstream.</dd>
00044 </dl>
00045
00046
00047 <h3>Return Values</h3>
00048 <blockquote>
00049 <li>0 for success</li>
00050
00051 <li>
00052 nonzero indicates failure, described by several error codes:</li>
00053 <ul>
00054 <li>OV_ENOSEEK - Bitstream is not seekable.
00055 </li>
00056 <li>OV_EINVAL - Invalid argument value.
00057 </li>
00058 <li>OV_EREAD - A read from media returned an error.
00059 </li>
00060 <li>OV_EFAULT - Internal logic fault; indicates a bug or heap/stack
00061 corruption.
00062 </li>
00063 <li>OV_EBADLINK - Invalid stream section supplied to libvorbisidec, or the requested link is corrupt.
00064 </li>
00065 </ul></blockquote>
00066
00067 <br><br>
00068 <hr noshade>
00069 <table border=0 width=100%>
00070 <tr valign=top>
00071 <td><p class=tiny>copyright © 2002 Xiph.org</p></td>
00072 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
00073 </tr><tr>
00074 <td><p class=tiny>Tremor documentation</p></td>
00075 <td align=right><p class=tiny>Tremor version 1.0 - 20020403</p></td>
00076 </tr>
00077 </table>
00078
00079 </body>
00080
00081 </html>
