Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: downloads/libvorbis-1.2.0/doc/vorbisfile/ov_pcm_seek.html @ 16

Last change on this file since 16 was 16, checked in by landauf, 17 years ago

added libvorbis

File size: 2.2 KB
RevLine 
[16]1<html>
2
3<head>
4<title>Vorbisfile - 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>Vorbisfile documentation</p></td>
12<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
13</tr>
14</table>
15
16<h1>ov_pcm_seek</h1>
17
18<p><i>declared in "vorbis/vorbisfile.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
22decoder, so you can immediately call <a href="ov_read.html">ov_read()</a> and get data from
23the 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>
31int 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 libvorbisfile
41functions.</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<ul>
50<li>0 for success</li>
51
52<li>
53nonzero indicates failure, described by several error codes:
54  <ul>
55  <li>OV_ENOSEEK - Bitstream is not seekable.
56  </li>
57  <li>OV_EINVAL - Invalid argument value; possibly called with an OggVorbis_File structure that isn't open.
58  </li>
59  <li>OV_EREAD - A read from media returned an error.
60  </li>
61  <li>OV_EFAULT - Internal logic fault; indicates a bug or heap/stack
62                corruption.
63  </li>
64  <li>OV_EBADLINK - Invalid stream section supplied to libvorbisfile, or the requested link is corrupt.
65  </li>
66  </ul></li>
67</ul></blockquote>
68
69<br><br>
70<hr noshade>
71<table border=0 width=100%>
72<tr valign=top>
73<td><p class=tiny>copyright &copy; 2007 Xiph.org</p></td>
74<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
75</tr><tr>
76<td><p class=tiny>Vorbisfile documentation</p></td>
77<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
78</tr>
79</table>
80
81</body>
82
83</html>
Note: See TracBrowser for help on using the repository browser.