Update website links in the documentation.
[platform/upstream/libvorbis.git] / doc / vorbisfile / ov_time_seek_page.html
index b3b9616..a76750a 100644 (file)
@@ -1,15 +1,15 @@
 <html>
 
 <head>
-<title>vorbisfile - function - ov_time_seek_page</title>
+<title>Vorbisfile - function - ov_time_seek_page</title>
 <link rel=stylesheet href="style.css" type="text/css">
 </head>
 
 <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
 <table border=0 width=100%>
 <tr>
-<td><p class=tiny>vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td>
+<td><p class=tiny>Vorbisfile documentation</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.3.2 - 20101101</p></td>
 </tr>
 </table>
 
 <p><i>declared in "vorbis/vorbisfile.h";</i></p>
 
 <p>For seekable
-streams, this seeks to closest full page preceding the given time.  This function is faster than <a href="ov_time_seek.html">ov_time_seek</a> because it doesn't seek through the last few samples to reach an exact time, but it is also less accurate.  This should be used when speed is important.\r
+streams, this seeks to closest full page preceding the given time.  This function is faster than <a href="ov_time_seek.html">ov_time_seek</a> because it doesn't seek through the last few samples to reach an exact time, but it is also less accurate.  This should be used when speed is important.
 <p>This function also updates everything needed within the
 decoder, so you can immediately call <a href="ov_read.html">ov_read()</a> and get data from
-the newly seeked to position.  \r
-<p>For obvious reasons, this doesn't work for unseekable streams.
+the newly seeked to position.  
+<p>This function does not work for unseekable streams.
 
 <br><br>
 <table border=0 color=black cellspacing=0 cellpadding=7>
 <tr bgcolor=#cccccc>
        <td>
 <pre><b>
-int ov_time_seek_page(<a href="OggVorbis_File.html">OggVorbis_File</a> *vf, double seconds);
+int ov_time_seek_page(<a href="OggVorbis_File.html">OggVorbis_File</a> *vf, double s);
 </b></pre>
        </td>
 </tr>
@@ -39,46 +39,45 @@ int ov_time_seek_page(<a href="OggVorbis_File.html">OggVorbis_File</a> *vf, doub
 <dl>
 <dt><i>vf</i></dt>
 <dd>Pointer to our already opened and initialized OggVorbis_File structure.</dd>
-<dt><i>seconds</i></dt>
+<dt><i>pos</i></dt>
 <dd>Location to seek to within the file, specified in seconds.</dd>
 </dl>
 
 
 <h3>Return Values</h3>
 <blockquote>
-<li>
-0 for success</li>
+<ul>
+<li>0 for success</li>
 
 <li>
-nonzero indicates failure, described by several error codes:</li>\r
-<ul>\r
-<li>OV_ENOSEEK - Bitstream is not seekable.\r
-</li>\r
-<li>OV_EINVAL - Invalid argument value.\r
-</li>\r
-<li>OV_EREAD - A read from media returned an error.\r
-</li>\r
-<li>OV_EFAULT - Internal logic fault; indicates a bug or heap/stack \r
-               corruption.\r
-</li>\r
-<li>OV_EBADLINK - Invalid stream section supplied to libvorbis/libvorbisfile, or the requested link is corrupt. \r
-</li>\r
+nonzero indicates failure, described by several error codes:
+  <ul>
+  <li>OV_ENOSEEK - Bitstream is not seekable.
+  </li>
+  <li>OV_EINVAL - Invalid argument value; possibly called with an OggVorbis_File structure that isn't open.
+  </li>
+  <li>OV_EREAD - A read from media returned an error.
+  </li>
+  <li>OV_EFAULT - Internal logic fault; indicates a bug or heap/stack 
+               corruption.
+  </li>
+  <li>OV_EBADLINK - Invalid stream section supplied to libvorbisfile, or the requested link is corrupt. 
+  </li>
+  </ul></li>
 </ul></blockquote>
 
-
 <br><br>
 <hr noshade>
 <table border=0 width=100%>
 <tr valign=top>
-<td><p class=tiny>copyright &copy; 2000 vorbis team</p></td>
-<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td>
+<td><p class=tiny>copyright &copy; 2000-2010 Xiph.Org</p></td>
+<td align=right><p class=tiny><a href="https://xiph.org/vorbis/">Ogg Vorbis</a></p></td>
 </tr><tr>
-<td><p class=tiny>vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td>
+<td><p class=tiny>Vorbisfile documentation</p></td>
+<td align=right><p class=tiny>vorbisfile version 1.3.2 - 20101101</p></td>
 </tr>
 </table>
 
-
 </body>
 
 </html>