doc/vorbisfile/ov_comment.html

   1 <html>
   2
   3 <head>
   4 <title>vorbisfile - function - ov_bitrate</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_comment</h1>
  17
  18 <p><i>declared in "vorbis/vorbisfile.h";</i></p>
  19
  20 <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.
  21 <p>
  22
  23 <br><br>
  24 <table border=0 color=black cellspacing=0 cellpadding=7>
  25 <tr bgcolor=#cccccc>
  26         <td>
  27 <pre><b>
  28 vorbis_comment *ov_comment(OggVorbis_File *vf,int link);
  29 </b></pre>
  30         </td>
  31 </tr>
  32 </table>
  33
  34 <h3>Parameters</h3>
  35 <dl>
  36 <dt><i>vf</i></dt>
  37 <dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible vorbisfile
  38 functions.</dd>
  39 <dt><i>i</i></dt>
  40 <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>
  41 </dl>
  42
  43
  44 <h3>Return Values</h3>
  45 <blockquote>
  46 <li>Returns the vorbis_comment struct for the specified bitstream.</li>
  47 <li>NULL if the specified bitstream does not exist or the file has been initialized improperly.</li>
  48 </blockquote>
  49 <p>
  50 <br><br>
  51 <hr noshade>
  52 <table border=0 width=100%>
  53 <tr valign=top>
  54 <td><p class=tiny>copyright &copy; 2000 vorbis team</p></td>
  55 <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>
  56 </tr><tr>
  57 <td><p class=tiny>vorbisfile documentation</p></td>
  58 <td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td>
  59 </tr>
  60 </table>
  61
  62
  63 </body>
  64
  65 </html>