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
9<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
10<table border=0 width=100%>
11<tr>
12<td><p class=tiny>Vorbisfile documentation</p></td>
13<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
14</tr>
15</table>
16
17<h1>ov_comment</h1>
18
19<p><i>declared in "vorbis/vorbisfile.h";</i></p>
20
21<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.
22<p>
23
24<br><br>
25<table border=0 color=black cellspacing=0 cellpadding=7>
26<tr bgcolor=#cccccc>
27	<td>
28<pre><b>
29vorbis_comment *ov_comment(OggVorbis_File *vf,int link);
30</b></pre>
31	</td>
32</tr>
33</table>
34
35<h3>Parameters</h3>
36<dl>
37<dt><i>vf</i></dt>
38<dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible libvorbisfile
39functions.</dd>
40<dt><i>i</i></dt>
41<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>
42</dl>
43
44
45<h3>Return Values</h3>
46<blockquote>
47<li>Returns the vorbis_comment struct for the specified bitstream.</li>
48<li>NULL if the specified bitstream does not exist or the file has been initialized improperly.</li>
49</blockquote>
50<p>
51
52<br><br>
53<hr noshade>
54<table border=0 width=100%>
55<tr valign=top>
56<td><p class=tiny>copyright &copy; 2007 Xiph.org</p></td>
57<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
58</tr><tr>
59<td><p class=tiny>Vorbisfile documentation</p></td>
60<td align=right><p class=tiny>vorbisfile version 1.2.0 - 20070723</p></td>
61</tr>
62</table>
63
64</body>
65
66</html>
67