• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2
3<head>
4<title>Tremor - function - ov_pcm_seek_page</title>
5<link rel=stylesheet href="style.css" type="text/css">
6</head>
7
8<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
9<table border=0 width=100%>
10<tr>
11<td><p class=tiny>Tremor documentation</p></td>
12<td align=right><p class=tiny>Tremor version 1.0 - 20020403</p></td>
13</tr>
14</table>
15
16<h1>ov_pcm_seek_page</h1>
17
18<p><i>declared in "ivorbisfile.h";</i></p>
19
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.
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.
22<p>This also updates everything needed within the
23decoder, so you can immediately call <a href="ov_read.html">ov_read()</a> and get data from
24the newly seeked to position.
25<p>
26
27<br><br>
28<table border=0 color=black cellspacing=0 cellpadding=7>
29<tr bgcolor=#cccccc>
30	<td>
31<pre><b>
32int ov_pcm_seek_page(OggVorbis_File *vf,ogg_int64_t pos);
33</b></pre>
34	</td>
35</tr>
36</table>
37
38<h3>Parameters</h3>
39<dl>
40<dt><i>vf</i></dt>
41<dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible libvorbisidec
42functions.</dd>
43<dt><i>pos</i></dt>
44<dd>Position in pcm samples to seek to in the bitstream.</dd>
45</dl>
46
47
48<h3>Return Values</h3>
49<blockquote>
50<li>
510 for success</li>
52
53<li>
54nonzero indicates failure, described by several error codes:</li>
55<ul>
56<li>OV_ENOSEEK - Bitstream is not seekable.
57</li>
58<li>OV_EINVAL - Invalid argument value.
59</li>
60<li>OV_EREAD - A read from media returned an error.
61</li>
62<li>OV_EFAULT - Internal logic fault; indicates a bug or heap/stack
63		corruption.
64</li>
65<li>OV_EBADLINK - Invalid stream section supplied to libvorbisidec, or the requested link is corrupt.
66</li>
67</ul></blockquote>
68
69<br><br>
70<hr noshade>
71<table border=0 width=100%>
72<tr valign=top>
73<td><p class=tiny>copyright &copy; 2002 Xiph.org</p></td>
74<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
75</tr><tr>
76<td><p class=tiny>Tremor documentation</p></td>
77<td align=right><p class=tiny>Tremor version 1.0 - 20020403</p></td>
78</tr>
79</table>
80
81</body>
82
83</html>
84