examples/sfexamples/oggvorbiscodec/src/tremor/doc/ov_raw_seek.html

00001 <html>
00002 
00003 <head>
00004 <title>Tremor - function - ov_raw_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_raw_seek</h1>
00017 
00018 <p><i>declared in "ivorbisfile.h";</i></p>
00019 
00020 <p>Seeks to the offset specified (in compressed raw bytes) 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>When seek speed is a priority, this is the best seek funtion to use.
00025 <br><br>
00026 <table border=0 color=black cellspacing=0 cellpadding=7>
00027 <tr bgcolor=#cccccc>
00028         <td>
00029 <pre><b>
00030 int ov_raw_seek(OggVorbis_File *vf,long pos);
00031 </b></pre>
00032         </td>
00033 </tr>
00034 </table>
00035 
00036 <h3>Parameters</h3>
00037 <dl>
00038 <dt><i>vf</i></dt>
00039 <dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible libvorbisidec
00040 functions.</dd>
00041 <dt><i>pos</i></dt>
00042 <dd>Position in compressed bytes to seek to in the bitstream.</dd>
00043 </dl>
00044 
00045 
00046 <h3>Return Values</h3>
00047 <blockquote>
00048 <li>0 indicates success</li>
00049 <li>nonzero indicates failure, described by several error codes:</li>
00050 <ul>
00051 <li>OV_ENOSEEK - Bitstream is not seekable.
00052 </li>
00053 <li>OV_EINVAL - Invalid argument value.
00054 </li>
00055 <li>OV_EBADLINK - Invalid stream section supplied to libvorbisidec, or the requested link is corrupt. 
00056 </li>
00057 </ul>
00058 </blockquote>
00059 <p>
00060 
00061 <br><br>
00062 <hr noshade>
00063 <table border=0 width=100%>
00064 <tr valign=top>
00065 <td><p class=tiny>copyright &copy; 2002 Xiph.org</p></td>
00066 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
00067 </tr><tr>
00068 <td><p class=tiny>Tremor documentation</p></td>
00069 <td align=right><p class=tiny>Tremor version 1.0 - 20020403</p></td>
00070 </tr>
00071 </table>
00072 
00073 </body>
00074 
00075 </html>

Generated by  doxygen 1.6.2