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