Numerous corrections and updates to libVorbisfile docs
[platform/upstream/libvorbis.git] / doc / vorbisfile / seeking.html
1 <html>\r
2 \r
3 <head>\r
4 <title>Vorbisfile - Seeking</title>\r
5 <link rel=stylesheet href="style.css" type="text/css">\r
6 </head>\r
7 \r
8 <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">\r
9 <table border=0 width=100%>\r
10 <tr>\r
11 <td><p class=tiny>Vorbisfile documentation</p></td>\r
12 <td align=right><p class=tiny>libVorbisfile version 1.65 - 20020702</p></td>\r
13 </tr>\r
14 </table>\r
15 \r
16 <h1>Seeking</h1>\r
17 <p>Seeking functions allow you to specify a specific point in the stream to begin or continue decoding.\r
18 <p>\r
19 All libvorbisfile seeking routines are declared in "vorbis/vorbisfile.h".\r
20 \r
21 <p>Certain seeking functions are best suited to different situations.\r
22 When speed is important and exact positioning isn't required,\r
23 page-level seeking should be used.  Note also that Vorbis files do not\r
24 necessarily start at a sample number or time offset of zero.  Do not\r
25 be surprised if a file begins at a positive offset of several minutes\r
26 or hours, such as would happen if a large stream (such as a concert\r
27 recording) is chopped into multiple separate files.  Requesting to\r
28 seek to a position before the beginning of such a file will seek to\r
29 the position where audio begins.<p>\r
30 \r
31 </ul>\r
32 \r
33 <table border=1 color=black width=50% cellspacing=0 cellpadding=7>\r
34 <tr bgcolor=#cccccc>\r
35         <td><b>function</b></td>\r
36         <td><b>purpose</b></td>\r
37 </tr>\r
38 <tr valign=top>\r
39         <td><a href="ov_raw_seek.html">ov_raw_seek</a></td>\r
40         <td>This function seeks to a position specified in the compressed bitstream, specified in bytes.</td>\r
41 </tr>\r
42 <tr valign=top>\r
43         <td><a href="ov_pcm_seek.html">ov_pcm_seek</a></td>\r
44         <td>This function seeks to a specific audio sample number, specified in pcm samples.</td>\r
45 </tr>\r
46 <tr valign=top>\r
47         <td><a href="ov_pcm_seek_page.html">ov_pcm_seek_page</a></td>\r
48         <td>This function seeks to the closest page preceding the specified audio sample number, specified in pcm samples.</td>\r
49 </tr>\r
50 <tr valign=top>\r
51         <td><a href="ov_time_seek.html">ov_time_seek</a></td>\r
52         <td>This function seeks to the specific time location in the bitstream, specified in integer milliseconds.  Note that this differs from the reference vorbisfile implementation, which takes seconds as a float. </td>\r
53 </tr>\r
54 <tr valign=top>\r
55         <td><a href="ov_time_seek_page.html">ov_time_seek_page</a></td>\r
56         <td>This function seeks to the closest page preceding the specified time position in the bitstream, specified in integer milliseconds.</td>\r
57 </tr>\r
58 </table>\r
59 \r
60 <br><br>\r
61 <hr noshade>\r
62 <table border=0 width=100%>\r
63 <tr valign=top>\r
64 <td><p class=tiny>copyright &copy; 2002 Xiph.org</p></td>\r
65 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>\r
66 </tr><tr>\r
67 <td><p class=tiny>Vorbisfile documentation</p></td>\r
68 <td align=right><p class=tiny>libVorbisfile version 1.65 - 20020702</p></td>\r
69 </tr>\r
70 </table>\r
71 \r
72 </body>\r
73 \r
74 </html>\r