blob: 44468a8b88998f61c621865b1e66c08e2d63f43b [file] [log] [blame]
<title>Tremor - function - ov_pcm_seek_page</title>
<link rel=stylesheet href="style.css" type="text/css">
<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
<table border=0 width=100%>
<td><p class=tiny>Tremor documentation</p></td>
<td align=right><p class=tiny>Tremor version 1.0 - 20020403</p></td>
<p><i>declared in "ivorbisfile.h";</i></p>
<p>Seeks to the closest page preceding the specified location (in pcm samples) within the physical bitstream. This function only works for seekable streams.
<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.
<p>This 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.
<table border=0 color=black cellspacing=0 cellpadding=7>
<tr bgcolor=#cccccc>
int ov_pcm_seek_page(OggVorbis_File *vf,ogg_int64_t pos);
<dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible libvorbisidec
<dd>Position in pcm samples to seek to in the bitstream.</dd>
<h3>Return Values</h3>
0 for success</li>
nonzero indicates failure, described by several error codes:</li>
<li>OV_ENOSEEK - Bitstream is not seekable.
<li>OV_EINVAL - Invalid argument value.
<li>OV_EREAD - A read from media returned an error.
<li>OV_EFAULT - Internal logic fault; indicates a bug or heap/stack
<li>OV_EBADLINK - Invalid stream section supplied to libvorbisidec, or the requested link is corrupt.
<hr noshade>
<table border=0 width=100%>
<tr valign=top>
<td><p class=tiny>copyright &copy; 2002</p></td>
<td align=right><p class=tiny><a href="">Ogg Vorbis</a></p></td>
<td><p class=tiny>Tremor documentation</p></td>
<td align=right><p class=tiny>Tremor version 1.0 - 20020403</p></td>