summaryrefslogtreecommitdiffhomepage
path: root/contrib/vorbis/doc/vorbisfile/ov_pcm_seek_page_lap.html
diff options
context:
space:
mode:
Diffstat (limited to 'contrib/vorbis/doc/vorbisfile/ov_pcm_seek_page_lap.html')
-rw-r--r--contrib/vorbis/doc/vorbisfile/ov_pcm_seek_page_lap.html112
1 files changed, 0 insertions, 112 deletions
diff --git a/contrib/vorbis/doc/vorbisfile/ov_pcm_seek_page_lap.html b/contrib/vorbis/doc/vorbisfile/ov_pcm_seek_page_lap.html
deleted file mode 100644
index d9694e8..0000000
--- a/contrib/vorbis/doc/vorbisfile/ov_pcm_seek_page_lap.html
+++ /dev/null
@@ -1,112 +0,0 @@
-<html>
-
-<head>
-<title>Vorbisfile - function - ov_pcm_seek_page_lap</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_lap</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 variant of <a
-href="ov_pcm_seek_page.html">ov_pcm_seek_page</a> also automatically
-crosslaps the transition from the previous playback position into the
-new playback position in order to eliminate clicking and boundary
-discontinuities. Otherwise, usage and behavior is identical to <a
-href="ov_pcm_seek_page.html">ov_pcm_seek_page</a>.
-
-<p>This function is faster than <a
-href="ov_pcm_seek_lap.html">ov_pcm_seek_lap</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>ov_pcm_seek_page_lap 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>ov_pcm_seek_page_lap will lap between logical stream links of
-differing numbers of channels. Any extra channels from the origin of
-the seek are ignored; playback of these channels simply ends. Extra
-channels at the destination are lapped from silence.
-ov_pcm_seek_page_lap will also lap between logical stream links of
-differing sample rates. In this case, the sample rates are ignored
-(no implicit resampling is done to match playback). It is up to the
-application developer to decide if this behavior makes any sense in a
-given context; in practical use, these default behaviors perform
-sensibly.
-
-<p>This function only works for seekable streams.
-
-<br><br>
-<table border=0 color=black cellspacing=0 cellpadding=7>
-<tr bgcolor=#cccccc>
- <td>
-<pre><b>
-int ov_pcm_seek_page_lap(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_EOF - Indicates stream is at end of file immediately after a seek
- (making crosslap impossible as there's no preceeding decode state to crosslap).
- </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="http://www.xiph.org/ogg/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>