annotate src/libvorbis-1.3.3/doc/vorbisfile/ov_time_seek_page.html @ 148:b4bfdf10c4b3

Update Win64 capnp builds to v0.6
author Chris Cannam <cannam@all-day-breakfast.com>
date Mon, 22 May 2017 18:56:49 +0100
parents 98c1576536ae
children
rev   line source
cannam@86 1 <html>
cannam@86 2
cannam@86 3 <head>
cannam@86 4 <title>Vorbisfile - function - ov_time_seek_page</title>
cannam@86 5 <link rel=stylesheet href="style.css" type="text/css">
cannam@86 6 </head>
cannam@86 7
cannam@86 8 <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
cannam@86 9 <table border=0 width=100%>
cannam@86 10 <tr>
cannam@86 11 <td><p class=tiny>Vorbisfile documentation</p></td>
cannam@86 12 <td align=right><p class=tiny>vorbisfile version 1.3.2 - 20101101</p></td>
cannam@86 13 </tr>
cannam@86 14 </table>
cannam@86 15
cannam@86 16 <h1>ov_time_seek_page</h1>
cannam@86 17
cannam@86 18 <p><i>declared in "vorbis/vorbisfile.h";</i></p>
cannam@86 19
cannam@86 20 <p>For seekable
cannam@86 21 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.
cannam@86 22 <p>This function also updates everything needed within the
cannam@86 23 decoder, so you can immediately call <a href="ov_read.html">ov_read()</a> and get data from
cannam@86 24 the newly seeked to position.
cannam@86 25 <p>This function does not work for unseekable streams.
cannam@86 26
cannam@86 27 <br><br>
cannam@86 28 <table border=0 color=black cellspacing=0 cellpadding=7>
cannam@86 29 <tr bgcolor=#cccccc>
cannam@86 30 <td>
cannam@86 31 <pre><b>
cannam@86 32 int ov_time_seek_page(<a href="OggVorbis_File.html">OggVorbis_File</a> *vf, double s);
cannam@86 33 </b></pre>
cannam@86 34 </td>
cannam@86 35 </tr>
cannam@86 36 </table>
cannam@86 37
cannam@86 38 <h3>Parameters</h3>
cannam@86 39 <dl>
cannam@86 40 <dt><i>vf</i></dt>
cannam@86 41 <dd>Pointer to our already opened and initialized OggVorbis_File structure.</dd>
cannam@86 42 <dt><i>pos</i></dt>
cannam@86 43 <dd>Location to seek to within the file, specified in seconds.</dd>
cannam@86 44 </dl>
cannam@86 45
cannam@86 46
cannam@86 47 <h3>Return Values</h3>
cannam@86 48 <blockquote>
cannam@86 49 <ul>
cannam@86 50 <li>0 for success</li>
cannam@86 51
cannam@86 52 <li>
cannam@86 53 nonzero indicates failure, described by several error codes:
cannam@86 54 <ul>
cannam@86 55 <li>OV_ENOSEEK - Bitstream is not seekable.
cannam@86 56 </li>
cannam@86 57 <li>OV_EINVAL - Invalid argument value; possibly called with an OggVorbis_File structure that isn't open.
cannam@86 58 </li>
cannam@86 59 <li>OV_EREAD - A read from media returned an error.
cannam@86 60 </li>
cannam@86 61 <li>OV_EFAULT - Internal logic fault; indicates a bug or heap/stack
cannam@86 62 corruption.
cannam@86 63 </li>
cannam@86 64 <li>OV_EBADLINK - Invalid stream section supplied to libvorbisfile, or the requested link is corrupt.
cannam@86 65 </li>
cannam@86 66 </ul></li>
cannam@86 67 </ul></blockquote>
cannam@86 68
cannam@86 69 <br><br>
cannam@86 70 <hr noshade>
cannam@86 71 <table border=0 width=100%>
cannam@86 72 <tr valign=top>
cannam@86 73 <td><p class=tiny>copyright &copy; 2000-2010 Xiph.Org</p></td>
cannam@86 74 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
cannam@86 75 </tr><tr>
cannam@86 76 <td><p class=tiny>Vorbisfile documentation</p></td>
cannam@86 77 <td align=right><p class=tiny>vorbisfile version 1.3.2 - 20101101</p></td>
cannam@86 78 </tr>
cannam@86 79 </table>
cannam@86 80
cannam@86 81 </body>
cannam@86 82
cannam@86 83 </html>