annotate src/libvorbis-1.3.3/doc/vorbisfile/ov_pcm_seek_page.html @ 83:ae30d91d2ffe

Replace these with versions built using an older toolset (so as to avoid ABI compatibilities when linking on Ubuntu 14.04 for packaging purposes)
author Chris Cannam
date Fri, 07 Feb 2020 11:51:13 +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_pcm_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_pcm_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>Seeks to the closest page preceding the specified location (in pcm samples) within the physical bitstream. This function only works for seekable streams.
Chris@1 21 <p>This function is faster than <a href="ov_pcm_seek.html">ov_pcm_seek</a> because the function can begin decoding at a page boundary rather than seeking through any remaining samples before the specified location. However, it is less accurate.
Chris@1 22 <p>This 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>
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_pcm_seek_page(OggVorbis_File *vf,ogg_int64_t pos);
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>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible libvorbisfile
Chris@1 42 functions.</dd>
Chris@1 43 <dt><i>pos</i></dt>
Chris@1 44 <dd>Position in pcm samples to seek to in the bitstream.</dd>
Chris@1 45 </dl>
Chris@1 46
Chris@1 47
Chris@1 48 <h3>Return Values</h3>
Chris@1 49 <blockquote>
Chris@1 50 <ul>
Chris@1 51 <li>0 for success</li>
Chris@1 52
Chris@1 53 <li>
Chris@1 54 nonzero indicates failure, described by several error codes:
Chris@1 55 <ul>
Chris@1 56 <li>OV_ENOSEEK - Bitstream is not seekable.
Chris@1 57 </li>
Chris@1 58 <li>OV_EINVAL - Invalid argument value; possibly called with an OggVorbis_File structure that isn't open.
Chris@1 59 </li>
Chris@1 60 <li>OV_EREAD - A read from media returned an error.
Chris@1 61 </li>
Chris@1 62 <li>OV_EFAULT - Internal logic fault; indicates a bug or heap/stack
Chris@1 63 corruption.
Chris@1 64 </li>
Chris@1 65 <li>OV_EBADLINK - Invalid stream section supplied to libvorbisfile, or the requested link is corrupt.
Chris@1 66 </li>
Chris@1 67 </ul></li>
Chris@1 68 </ul></blockquote>
Chris@1 69
Chris@1 70 <br><br>
Chris@1 71 <hr noshade>
Chris@1 72 <table border=0 width=100%>
Chris@1 73 <tr valign=top>
Chris@1 74 <td><p class=tiny>copyright &copy; 2000-2010 Xiph.Org</p></td>
Chris@1 75 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
Chris@1 76 </tr><tr>
Chris@1 77 <td><p class=tiny>Vorbisfile documentation</p></td>
Chris@1 78 <td align=right><p class=tiny>vorbisfile version 1.3.2 - 20101101</p></td>
Chris@1 79 </tr>
Chris@1 80 </table>
Chris@1 81
Chris@1 82 </body>
Chris@1 83
Chris@1 84 </html>