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