etlegacy-libs/vorbis/doc/vorbisfile/ov_pcm_seek_page.html

<html>

<head>
<title>Vorbisfile - function - ov_pcm_seek_page</title>
<link rel=stylesheet href="style.css" type="text/css">
</head>

<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
<table border=0 width=100%>
<tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
<td align=right><p class=tiny>vorbisfile version 1.3.2 - 20101101</p></td>
</tr>
</table>

<h1>ov_pcm_seek_page</h1>

<p><i>declared in "vorbis/vorbisfile.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.
<p>

<br><br>
<table border=0 color=black cellspacing=0 cellpadding=7>
<tr bgcolor=#cccccc>
	<td>
<pre><b>
int ov_pcm_seek_page(OggVorbis_File *vf,ogg_int64_t pos);
</b></pre>
	</td>
</tr>
</table>

<h3>Parameters</h3>
<dl>
<dt><i>vf</i></dt>
<dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible libvorbisfile
functions.</dd>
<dt><i>pos</i></dt>
<dd>Position in pcm samples to seek to in the bitstream.</dd>
</dl>


<h3>Return Values</h3>
<blockquote>
<ul>
<li>0 for success</li>

<li>
nonzero indicates failure, described by several error codes:
  <ul>
  <li>OV_ENOSEEK - Bitstream is not seekable.
  </li>
  <li>OV_EINVAL - Invalid argument value; possibly called with an OggVorbis_File structure that isn't open.
  </li>
  <li>OV_EREAD - A read from media returned an error.
  </li>
  <li>OV_EFAULT - Internal logic fault; indicates a bug or heap/stack 
		corruption.
  </li>
  <li>OV_EBADLINK - Invalid stream section supplied to libvorbisfile, or the requested link is corrupt. 
  </li>
  </ul></li>
</ul></blockquote>

<br><br>
<hr noshade>
<table border=0 width=100%>
<tr valign=top>
<td><p class=tiny>copyright &copy; 2000-2010 Xiph.Org</p></td>
<td align=right><p class=tiny><a href="https://xiph.org/vorbis/">Ogg Vorbis</a></p></td>
</tr><tr>
<td><p class=tiny>Vorbisfile documentation</p></td>
<td align=right><p class=tiny>vorbisfile version 1.3.2 - 20101101</p></td>
</tr>
</table>

</body>

</html>
Added Ogg 1.3.0 library 2013-01-24 15:44:19 +00:00			`<html>`

			`<head>`
			`<title>Vorbisfile - function - ov_pcm_seek_page</title>`
			`<link rel=stylesheet href="style.css" type="text/css">`
			`</head>`

			`<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">`
			`<table border=0 width=100%>`
			`<tr>`
			`<td><p class=tiny>Vorbisfile documentation</p></td>`
			`<td align=right><p class=tiny>vorbisfile version 1.3.2 - 20101101</p></td>`
			`</tr>`
			`</table>`

			`<h1>ov_pcm_seek_page</h1>`

			`<p><i>declared in "vorbis/vorbisfile.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.`
			`<p>`

			`<br><br>`
			`<table border=0 color=black cellspacing=0 cellpadding=7>`
			`<tr bgcolor=#cccccc>`
			`<td>`
			`<pre><b>`
			`int ov_pcm_seek_page(OggVorbis_File *vf,ogg_int64_t pos);`
			`</b></pre>`
			`</td>`
			`</tr>`
			`</table>`

			`<h3>Parameters</h3>`
			`<dl>`
			`<dt><i>vf</i></dt>`
			`<dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible libvorbisfile`
			`functions.</dd>`
			`<dt><i>pos</i></dt>`
			`<dd>Position in pcm samples to seek to in the bitstream.</dd>`
			`</dl>`


			`<h3>Return Values</h3>`
			`<blockquote>`
			`<ul>`
			`<li>0 for success</li>`

			`<li>`
			`nonzero indicates failure, described by several error codes:`
			`<ul>`
			`<li>OV_ENOSEEK - Bitstream is not seekable.`
			`</li>`
			`<li>OV_EINVAL - Invalid argument value; possibly called with an OggVorbis_File structure that isn't open.`
			`</li>`
			`<li>OV_EREAD - A read from media returned an error.`
			`</li>`
			`<li>OV_EFAULT - Internal logic fault; indicates a bug or heap/stack`
			`corruption.`
			`</li>`
			`<li>OV_EBADLINK - Invalid stream section supplied to libvorbisfile, or the requested link is corrupt.`
			`</li>`
			`</ul></li>`
			`</ul></blockquote>`

			`<br><br>`
			`<hr noshade>`
			`<table border=0 width=100%>`
			`<tr valign=top>`
			`<td><p class=tiny>copyright © 2000-2010 Xiph.Org</p></td>`
libs: updated to libvorbis 1.3.7 2021-09-22 09:18:21 +00:00			`<td align=right><p class=tiny><a href="https://xiph.org/vorbis/">Ogg Vorbis</a></p></td>`
Added Ogg 1.3.0 library 2013-01-24 15:44:19 +00:00			`</tr><tr>`
			`<td><p class=tiny>Vorbisfile documentation</p></td>`
			`<td align=right><p class=tiny>vorbisfile version 1.3.2 - 20101101</p></td>`
			`</tr>`
			`</table>`

			`</body>`

			`</html>`