Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

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

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

added libvorbis

File size: 2.2 KB
Line 
1<html>
2
3<head>
4<title>Vorbisfile - function - ov_raw_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_raw_seek</h1>
17
18<p><i>declared in "vorbis/vorbisfile.h";</i></p>
19
20<p>Seeks to the offset specified (in compressed raw bytes) 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>When seek speed is a priority, this is the best seek funtion to use.
25<br><br>
26<table border=0 color=black cellspacing=0 cellpadding=7>
27<tr bgcolor=#cccccc>
28        <td>
29<pre><b>
30int ov_raw_seek(OggVorbis_File *vf,long pos);
31</b></pre>
32        </td>
33</tr>
34</table>
35
36<h3>Parameters</h3>
37<dl>
38<dt><i>vf</i></dt>
39<dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible libvorbisfile
40functions.</dd>
41<dt><i>pos</i></dt>
42<dd>Position in compressed bytes to seek to in the bitstream.</dd>
43</dl>
44
45
46<h3>Return Values</h3>
47<blockquote>
48<ul>
49<li>0 for success</li>
50
51<li>
52nonzero indicates failure, described by several error codes:
53  <ul>
54  <li>OV_ENOSEEK - Bitstream is not seekable.
55  </li>
56  <li>OV_EINVAL - Invalid argument value; possibly called with an OggVorbis_File structure that isn't open.
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 libvorbisfile, or the requested link is corrupt.
64  </li>
65  </ul></li>
66</ul></blockquote>
67<p>
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.