annotate src/libvorbis-1.3.3/doc/vorbisfile/ov_info.html @ 169:223a55898ab9 tip default

Add null config files
author Chris Cannam <cannam@all-day-breakfast.com>
date Mon, 02 Mar 2020 14:03:47 +0000
parents 98c1576536ae
children
rev   line source
cannam@86 1 <html>
cannam@86 2
cannam@86 3 <head>
cannam@86 4 <title>Vorbisfile - function - ov_info</title>
cannam@86 5 <link rel=stylesheet href="style.css" type="text/css">
cannam@86 6 </head>
cannam@86 7
cannam@86 8 <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
cannam@86 9 <table border=0 width=100%>
cannam@86 10 <tr>
cannam@86 11 <td><p class=tiny>Vorbisfile documentation</p></td>
cannam@86 12 <td align=right><p class=tiny>vorbisfile version 1.3.2 - 20101101</p></td>
cannam@86 13 </tr>
cannam@86 14 </table>
cannam@86 15
cannam@86 16 <h1>ov_info</h1>
cannam@86 17
cannam@86 18 <p><i>declared in "vorbis/vorbisfile.h";</i></p>
cannam@86 19
cannam@86 20 <p>Returns the <a href="../libvorbis/vorbis_info.html">vorbis_info</a> struct for the specified bitstream. For nonseekable files, always returns the current vorbis_info struct.
cannam@86 21
cannam@86 22 <br><br>
cannam@86 23 <table border=0 color=black cellspacing=0 cellpadding=7>
cannam@86 24 <tr bgcolor=#cccccc>
cannam@86 25 <td>
cannam@86 26 <pre><b>
cannam@86 27 vorbis_info *ov_info(<a href="OggVorbis_File.html">OggVorbis_File</a> *vf,int link);
cannam@86 28 </b></pre>
cannam@86 29 </td>
cannam@86 30 </tr>
cannam@86 31 </table>
cannam@86 32
cannam@86 33 <h3>Parameters</h3>
cannam@86 34 <dl>
cannam@86 35 <dt><i>vf</i></dt>
cannam@86 36 <dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible libvorbisfile
cannam@86 37 functions. </dd>
cannam@86 38 <dt><i>i</i></dt>
cannam@86 39 <dd>Link to the desired logical bitstream. For nonseekable files, this argument is ignored. To retrieve the <a href="../libvorbis/vorbis_info.html">vorbis_info</a> struct for the current bitstream, this parameter should be set to -1.</dd>
cannam@86 40 </dl>
cannam@86 41
cannam@86 42
cannam@86 43 <h3>Return Values</h3>
cannam@86 44 <blockquote>
cannam@86 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>
cannam@86 46 <li>NULL if the specified bitstream does not exist or the file has been initialized improperly.</li>
cannam@86 47 </blockquote>
cannam@86 48 <p>
cannam@86 49
cannam@86 50 <br><br>
cannam@86 51 <hr noshade>
cannam@86 52 <table border=0 width=100%>
cannam@86 53 <tr valign=top>
cannam@86 54 <td><p class=tiny>copyright &copy; 2000-2010 Xiph.Org</p></td>
cannam@86 55 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
cannam@86 56 </tr><tr>
cannam@86 57 <td><p class=tiny>Vorbisfile documentation</p></td>
cannam@86 58 <td align=right><p class=tiny>vorbisfile version 1.3.2 - 20101101</p></td>
cannam@86 59 </tr>
cannam@86 60 </table>
cannam@86 61
cannam@86 62 </body>
cannam@86 63
cannam@86 64 </html>