examples/sfexamples/oggvorbiscodec/src/libvorbis/doc/vorbisfile/ov_time_seek.html

00001 <html>
00002 
00003 <head>
00004 <title>Vorbisfile - function - ov_time_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>Vorbisfile documentation</p></td>
00012 <td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
00013 </tr>
00014 </table>
00015 
00016 <h1>ov_time_seek</h1>
00017 
00018 <p><i>declared in "vorbis/vorbisfile.h";</i></p>
00019 
00020 <p>For seekable
00021 streams, this seeks to the given time. For implementing seeking in a player,
00022 this is the only function generally needed. 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.  This function does not work for unseekable streams.
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_time_seek(<a href="OggVorbis_File.html">OggVorbis_File</a> *vf, double s);
00032 </b></pre>
00033         </td>
00034 </tr>
00035 </table>
00036 
00037 <h3>Parameters</h3>
00038 <dl>
00039 <dt><i>vf</i></dt>
00040 <dd>Pointer to our already opened and initialized OggVorbis_File structure.</dd>
00041 <dt><i>ms</i></dt>
00042 <dd>Location to seek to within the file, specified in seconds.</dd>
00043 </dl>
00044 
00045 
00046 <h3>Return Values</h3>
00047 <blockquote>
00048 <ul>
00049 <li>0 for success</li>
00050 
00051 <li>
00052 nonzero indicates failure, described by several error codes:
00053   <ul>
00054   <li>OV_ENOSEEK - Bitstream is not seekable.
00055   </li>
00056   <li>OV_EINVAL - Invalid argument value; possibly called with an OggVorbis_File structure that isn't open.
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 libvorbisfile, or the requested link is corrupt. 
00064   </li>
00065   </ul></li>
00066 </ul></blockquote>
00067 
00068 <br><br>
00069 <hr noshade>
00070 <table border=0 width=100%>
00071 <tr valign=top>
00072 <td><p class=tiny>copyright &copy; 2003 Xiph.org</p></td>
00073 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
00074 </tr><tr>
00075 <td><p class=tiny>Vorbisfile documentation</p></td>
00076 <td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
00077 </tr>
00078 </table>
00079 
00080 </body>
00081 
00082 </html>

Generated by  doxygen 1.6.2