00001 <html>
00002
00003 <head>
00004 <title>Vorbisfile - function - ov_time_seek_lap</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_lap</h1>
00017
00018 <p><i>declared in "vorbis/vorbisfile.h";</i></p>
00019
00020 <p>For seekable
00021 streams, ov_time_seek_lap seeks to the given time. This variant of <a
00022 href="ov_time_seek.html">ov_time_seek</a> also automatically
00023 crosslaps the transition from the previous playback position into the
00024 new playback position in order to eliminate clicking and boundary
00025 discontinuities. Otherwise, usage and behavior is identical to <a
00026 href="ov_time_seek.html">ov_time_seek</a>.
00027
00028 <p>ov_time_seek_lap also updates everything needed within the decoder,
00029 so you can immediately call <a href="ov_read.html">ov_read()</a> and
00030 get data from the newly seeked to position.
00031
00032 <p>ov_time_seek_lap will lap between logical stream links of differing
00033 numbers of channels. Any extra channels from the origin of the seek
00034 are ignored; playback of these channels simply ends. Extra channels at
00035 the destination are lapped from silence. ov_time_seek_lap will also
00036 lap between logical stream links of differing sample rates. In this
00037 case, the sample rates are ignored (no implicit resampling is done to
00038 match playback). It is up to the application developer to decide if
00039 this behavior makes any sense in a given context; in practical use,
00040 these default behaviors perform sensibly.
00041
00042 <p> This function does not work for unseekable streams.
00043
00044
00045 <br><br>
00046 <table border=0 color=black cellspacing=0 cellpadding=7>
00047 <tr bgcolor=#cccccc>
00048 <td>
00049 <pre><b>
00050 int ov_time_seek_lap(<a href="OggVorbis_File.html">OggVorbis_File</a> *vf, double s);
00051 </b></pre>
00052 </td>
00053 </tr>
00054 </table>
00055
00056 <h3>Parameters</h3>
00057 <dl>
00058 <dt><i>vf</i></dt>
00059 <dd>Pointer to our already opened and initialized OggVorbis_File structure.</dd>
00060 <dt><i>ms</i></dt>
00061 <dd>Location to seek to within the file, specified in seconds.</dd>
00062 </dl>
00063
00064
00065 <h3>Return Values</h3>
00066 <blockquote>
00067 <ul>
00068 <li>0 for success</li>
00069
00070 <li>
00071 nonzero indicates failure, described by several error codes:
00072 <ul>
00073 <li>OV_ENOSEEK - Bitstream is not seekable.
00074 </li>
00075 <li>OV_EINVAL - Invalid argument value; possibly called with an OggVorbis_File structure that isn't open.
00076 </li>
00077 <li>OV_EREAD - A read from media returned an error.
00078 </li>
00079 <li>OV_EFAULT - Internal logic fault; indicates a bug or heap/stack
00080 corruption.
00081 </li>
00082 <li>OV_EOF - Indicates stream is at end of file immediately after a seek
00083 (making crosslap impossible as there's no preceeding decode state to crosslap).
00084 </li>
00085 <li>OV_EBADLINK - Invalid stream section supplied to libvorbisfile, or the requested link is corrupt.
00086 </li>
00087 </ul></li>
00088 </ul></blockquote>
00089
00090
00091 <br><br>
00092 <hr noshade>
00093 <table border=0 width=100%>
00094 <tr valign=top>
00095 <td><p class=tiny>copyright © 2003 Xiph.org</p></td>
00096 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
00097 </tr><tr>
00098 <td><p class=tiny>Vorbisfile documentation</p></td>
00099 <td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
00100 </tr>
00101 </table>
00102
00103 </body>
00104
00105 </html>
