Merge branch_beta3 onto the mainline.
[platform/upstream/libvorbis.git] / doc / vorbisfile / ov_serialnumber.html
1 <html>
2
3 <head>
4 <title>vorbisfile - function - ov_serialnumber</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.25 - 20000615</p></td>
13 </tr>
14 </table>
15
16 <h1>ov_serialnumber</h1>
17
18 <p><i>declared in "vorbis/vorbisfile.h";</i></p>
19
20 <p>Returns the serialnumber of the specified logical bitstream.
21
22 <br><br>
23 <table border=0 color=black cellspacing=0 cellpadding=7>
24 <tr bgcolor=#cccccc>
25         <td>
26 <pre><b>
27 long ov_serialnumber(OggVorbis_File *vf,int i);
28 </b></pre>
29         </td>
30 </tr>
31 </table>
32
33 <h3>Parameters</h3>
34 <dl>
35 <dt><i>vf</i></dt>
36 <dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible vorbisfile
37 functions. Once this has been called, the same <tt>OggVorbis_File</tt>
38 struct should be passed to all the vorbisfile functions.</dd>
39 <dt><i>i</i></dt>
40 <dd><b>Link to the desired logical bitstream.  For nonseekable files, this argument is ignored.  To retrieve the <a href="vorbis_info.html">vorbis_info</a> struct for the current bitstream, this parameter should be set to -1.</b></dd>
41 </dl>
42
43
44 <h3>Return Values</h3>
45 <blockquote>
46 <li>
47 -1 if the specified logical bitstream <i>i</i> does not exist.</li>
48
49 <li>Returns the serial number of the logical bitstream <i>i</i> or the serial number of the current bitstream if the file is nonseekable.</li>
50 </blockquote>
51 <p>
52 <br><br>
53 <hr noshade>
54 <table border=0 width=100%>
55 <tr valign=top>
56 <td><p class=tiny>copyright &copy; 2000 vorbis team</p></td>
57 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td>
58 </tr><tr>
59 <td><p class=tiny>vorbisfile documentation</p></td>
60 <td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td>
61 </tr>
62 </table>
63
64
65 </body>
66
67 </html>