Home | History | Annotate | Download | only in vorbisfile 
      1 <html>
      2 
      3 <head>
      4 <title>Vorbisfile - function - ov_info</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.2.0 - 20070723</p></td>
     13 </tr>
     14 </table>
     15 
     16 <h1>ov_info</h1>
     17 
     18 <p><i>declared in "vorbis/vorbisfile.h";</i></p>
     19 
     20 <p>Returns the <a href="vorbis_info.html">vorbis_info</a> struct for the specified bitstream.  For nonseekable files, always returns the current vorbis_info struct.
     21 
     22 <br><br>
     23 <table border=0 color=black cellspacing=0 cellpadding=7>
     24 <tr bgcolor=#cccccc>
     25 	<td>
     26 <pre><b>
     27 vorbis_info *ov_info(<a href="OggVorbis_File.html">OggVorbis_File</a> *vf,int link);
     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 libvorbisfile
     37 functions. </dd>
     38 <dt><i>i</i></dt>
     39 <dd>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.</dd>
     40 </dl>
     41 
     42 
     43 <h3>Return Values</h3>
     44 <blockquote>
     45 <li>Returns the vorbis_info struct for the specified bitstream.  Returns vorbis_info for current bitstream if the file is nonseekable or i=-1.</li>
     46 <li>NULL if the specified bitstream does not exist or the file has been initialized improperly.</li>
     47 </blockquote>
     48 <p>
     49 
     50 <br><br>
     51 <hr noshade>
     52 <table border=0 width=100%>
     53 <tr valign=top>
     54 <td><p class=tiny>copyright &copy; 2007 Xiph.org</p></td>
     55 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</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.2.0 - 20070723</p></td>
     59 </tr>
     60 </table>
     61 
     62 </body>
     63 
     64 </html>
     65