]> git.jsancho.org Git - lugaru.git/blob - libvorbis-1.0.1/doc/vorbisfile/ov_time_seek.html
Use const char * for string arguments to avoid deprecated conversion warnings.
[lugaru.git] / libvorbis-1.0.1 / doc / vorbisfile / ov_time_seek.html
1 <html>
2
3 <head>
4 <title>Vorbisfile - function - ov_time_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.68 - 20030307</p></td>
13 </tr>
14 </table>
15
16 <h1>ov_time_seek</h1>
17
18 <p><i>declared in "vorbis/vorbisfile.h";</i></p>
19
20 <p>For seekable
21 streams, this seeks to the given time. For implementing seeking in a player,
22 this is the only function generally needed. This also updates everything needed within the
23 decoder, so you can immediately call <a href="ov_read.html">ov_read()</a> and get data from
24 the newly seeked to position.  This function does not work for unseekable streams.
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_time_seek(<a href="OggVorbis_File.html">OggVorbis_File</a> *vf, double s);
32 </b></pre>
33         </td>
34 </tr>
35 </table>
36
37 <h3>Parameters</h3>
38 <dl>
39 <dt><i>vf</i></dt>
40 <dd>Pointer to our already opened and initialized OggVorbis_File structure.</dd>
41 <dt><i>ms</i></dt>
42 <dd>Location to seek to within the file, specified in seconds.</dd>
43 </dl>
44
45
46 <h3>Return Values</h3>
47 <blockquote>
48 <ul>
49 <li>0 for success</li>
50
51 <li>
52 nonzero 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
68 <br><br>
69 <hr noshade>
70 <table border=0 width=100%>
71 <tr valign=top>
72 <td><p class=tiny>copyright &copy; 2003 Xiph.org</p></td>
73 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
74 </tr><tr>
75 <td><p class=tiny>Vorbisfile documentation</p></td>
76 <td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
77 </tr>
78 </table>
79
80 </body>
81
82 </html>