aboutsummaryrefslogtreecommitdiff
path: root/Tremor/doc/ov_pcm_seek_page.html
diff options
context:
space:
mode:
authorThe Android Open Source Project <initial-contribution@android.com>2009-03-03 18:28:40 -0800
committerThe Android Open Source Project <initial-contribution@android.com>2009-03-03 18:28:40 -0800
commit9260d09499b620470f639ec024af8ee6ac18bf64 (patch)
tree4b825dc642cb6eb9a060e54bf8d69288fbee4904 /Tremor/doc/ov_pcm_seek_page.html
parent0ad0141e864cfbb130db4f22e279d421832e7336 (diff)
downloadtremor-9260d09499b620470f639ec024af8ee6ac18bf64.tar.gz
auto import from //depot/cupcake/@135843
Diffstat (limited to 'Tremor/doc/ov_pcm_seek_page.html')
-rw-r--r--Tremor/doc/ov_pcm_seek_page.html83
1 files changed, 0 insertions, 83 deletions
diff --git a/Tremor/doc/ov_pcm_seek_page.html b/Tremor/doc/ov_pcm_seek_page.html
deleted file mode 100644
index 44468a8..0000000
--- a/Tremor/doc/ov_pcm_seek_page.html
+++ /dev/null
@@ -1,83 +0,0 @@
-<html>
-
-<head>
-<title>Tremor - 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>Tremor documentation</p></td>
-<td align=right><p class=tiny>Tremor version 1.0 - 20020403</p></td>
-</tr>
-</table>
-
-<h1>ov_pcm_seek_page</h1>
-
-<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.
-<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 libvorbisidec
-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>
-<li>
-0 for success</li>
-
-<li>
-nonzero indicates failure, described by several error codes:</li>
-<ul>
-<li>OV_ENOSEEK - Bitstream is not seekable.
-</li>
-<li>OV_EINVAL - Invalid argument value.
-</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 libvorbisidec, or the requested link is corrupt.
-</li>
-</ul></blockquote>
-
-<br><br>
-<hr noshade>
-<table border=0 width=100%>
-<tr valign=top>
-<td><p class=tiny>copyright &copy; 2002 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>Tremor documentation</p></td>
-<td align=right><p class=tiny>Tremor version 1.0 - 20020403</p></td>
-</tr>
-</table>
-
-</body>
-
-</html>