examples/sfexamples/oggvorbiscodec/src/libvorbis/doc/vorbisfile/ov_serialnumber.html

00001 <html>
00002 
00003 <head>
00004 <title>Vorbisfile - function - ov_serialnumber</title>
00005 <link rel=stylesheet href="style.css" type="text/css">
00006 </head>
00007 
00008 <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
00009 <table border=0 width=100%>
00010 <tr>
00011 <td><p class=tiny>Vorbisfile documentation</p></td>
00012 <td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
00013 </tr>
00014 </table>
00015 
00016 <h1>ov_serialnumber</h1>
00017 
00018 <p><i>declared in "vorbis/vorbisfile.h";</i></p>
00019 
00020 <p>Returns the serialnumber of the specified logical bitstream link number within the overall physical bitstream.
00021 
00022 <br><br>
00023 <table border=0 color=black cellspacing=0 cellpadding=7>
00024 <tr bgcolor=#cccccc>
00025         <td>
00026 <pre><b>
00027 long ov_serialnumber(OggVorbis_File *vf,int i);
00028 </b></pre>
00029         </td>
00030 </tr>
00031 </table>
00032 
00033 <h3>Parameters</h3>
00034 <dl>
00035 <dt><i>vf</i></dt>
00036 <dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible libvorbisfile
00037 functions.</dd>
00038 <dt><i>i</i></dt>
00039 <dd>Link to the desired logical bitstream.  For nonseekable files, this argument is ignored.  To retrieve the serial number of the current bitstream, this parameter should be set to -1.</dd>
00040 </dl>
00041 
00042 
00043 <h3>Return Values</h3>
00044 <blockquote>
00045 <li>
00046 -1 if the specified logical bitstream <i>i</i> does not exist.</li>
00047 
00048 <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>
00049 </blockquote>
00050 <p>
00051 
00052 
00053 <br><br>
00054 <hr noshade>
00055 <table border=0 width=100%>
00056 <tr valign=top>
00057 <td><p class=tiny>copyright &copy; 2003 Xiph.org</p></td>
00058 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
00059 </tr><tr>
00060 <td><p class=tiny>Vorbisfile documentation</p></td>
00061 <td align=right><p class=tiny>vorbisfile version 1.68 - 20030307</p></td>
00062 </tr>
00063 </table>
00064 
00065 </body>
00066 
00067 </html>

Generated by  doxygen 1.6.2