Merge tag 'v1.3.7' into tizen
[platform/upstream/libvorbis.git] / doc / vorbisfile / seeking.html
index 391667c..d479984 100644 (file)
@@ -9,7 +9,7 @@
 <table border=0 width=100%>\r
 <tr>\r
 <td><p class=tiny>Vorbisfile documentation</p></td>\r
-<td align=right><p class=tiny>libVorbisfile version 1.65 - 20020702</p></td>\r
+<td align=right><p class=tiny>vorbisfile version 1.3.2 - 20101101</p></td>\r
 </tr>\r
 </table>\r
 \r
@@ -26,7 +26,18 @@ be surprised if a file begins at a positive offset of several minutes
 or hours, such as would happen if a large stream (such as a concert\r
 recording) is chopped into multiple separate files.  Requesting to\r
 seek to a position before the beginning of such a file will seek to\r
-the position where audio begins.<p>\r
+the position where audio begins.\r
+\r
+<p>As of vorbisfile version 1.68, seeking also optionally provides\r
+automatic crosslapping to eliminate clicks and other discontinuity\r
+artifacts at seeking boundaries.  This fetaure is of particular\r
+interest to player and game developers implementing dynamic music and\r
+audio engines, or others looking for smooth transitions within a\r
+single sample or across multiple samples.<p>\r
+\r
+<p>Naturally, seeking is available only within a seekable file or\r
+stream.  Seeking functions will return <tt>OV_ENOSEEK</tt> on\r
+nonseekable files and streams.\r
 \r
 </ul>\r
 \r
@@ -49,11 +60,33 @@ the position where audio begins.<p>
 </tr>\r
 <tr valign=top>\r
        <td><a href="ov_time_seek.html">ov_time_seek</a></td>\r
-       <td>This function seeks to the specific time location in the bitstream, specified in integer milliseconds.  Note that this differs from the reference vorbisfile implementation, which takes seconds as a float. </td>\r
+       <td>This function seeks to the specific time location in the bitstream, specified in seconds </td>\r
 </tr>\r
 <tr valign=top>\r
        <td><a href="ov_time_seek_page.html">ov_time_seek_page</a></td>\r
-       <td>This function seeks to the closest page preceding the specified time position in the bitstream, specified in integer milliseconds.</td>\r
+       <td>This function seeks to the closest page preceding the specified time position in the bitstream</td>\r
+</tr>\r
+\r
+</tr>\r
+<tr valign=top>\r
+       <td><a href="ov_raw_seek_lap.html">ov_raw_seek_lap</a></td>\r
+       <td>This function seeks to a position specified in the compressed bitstream, specified in bytes.  The boundary between the old and new playback positions is crosslapped to eliminate discontinuities. </td>\r
+</tr>\r
+<tr valign=top>\r
+       <td><a href="ov_pcm_seek_lap.html">ov_pcm_seek_lap</a></td>\r
+       <td>This function seeks to a specific audio sample number, specified in pcm samples.  The boundary between the old and new playback positions is crosslapped to eliminate discontinuities.</td>\r
+</tr>\r
+<tr valign=top>\r
+       <td><a href="ov_pcm_seek_page_lap.html">ov_pcm_seek_page_lap</a></td>\r
+       <td>This function seeks to the closest page preceding the specified audio sample number, specified in pcm samples.  The boundary between the old and new playback positions is crosslapped to eliminate discontinuities.</td>\r
+</tr>\r
+<tr valign=top>\r
+       <td><a href="ov_time_seek_lap.html">ov_time_seek_lap</a></td>\r
+       <td>This function seeks to the specific time location in the bitstream, specified in seconds.  The boundary between the old and new playback positions is crosslapped to eliminate discontinuities. </td>\r
+</tr>\r
+<tr valign=top>\r
+       <td><a href="ov_time_seek_page_lap.html">ov_time_seek_page_lap</a></td>\r
+       <td>This function seeks to the closest page preceding the specified time position in the bitstream.  The boundary between the old and new playback positions is crosslapped to eliminate discontinuities.</td>\r
 </tr>\r
 </table>\r
 \r
@@ -61,11 +94,11 @@ the position where audio begins.<p>
 <hr noshade>\r
 <table border=0 width=100%>\r
 <tr valign=top>\r
-<td><p class=tiny>copyright &copy; 2002 Xiph.org</p></td>\r
-<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>\r
+<td><p class=tiny>copyright &copy; 2000-2010 Xiph.Org</p></td>\r
+<td align=right><p class=tiny><a href="https://xiph.org/vorbis/">Ogg Vorbis</a></p></td>\r
 </tr><tr>\r
 <td><p class=tiny>Vorbisfile documentation</p></td>\r
-<td align=right><p class=tiny>libVorbisfile version 1.65 - 20020702</p></td>\r
+<td align=right><p class=tiny>vorbisfile version 1.3.2 - 20101101</p></td>\r
 </tr>\r
 </table>\r
 \r