annotate src/libvorbis-1.3.3/doc/vorbisfile/ov_time_seek_page.html @ 56:af97cad61ff0

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