Tremor/doc/ov_comment.html - platform/external/tremor - Git at Google

 <html>

 <head>
 <title>Tremor - function - ov_bitrate</title>
 <link rel=stylesheet href="style.css" type="text/css">
 </head>


 <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
 <table border=0 width=100%>
 <tr>
 <td><p class=tiny>Tremor documentation</p></td>
 <td align=right><p class=tiny>Tremor version 1.0 - 20020403</p></td>
 </tr>
 </table>

 <h1>ov_comment</h1>

 <p><i>declared in "ivorbisfile.h";</i></p>

 <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.
 <p>

 <br><br>
 <table border=0 color=black cellspacing=0 cellpadding=7>
 <tr bgcolor=#cccccc>
 	<td>
 <pre><b>
 vorbis_comment *ov_comment(OggVorbis_File *vf,int link);
 </b></pre>
 	</td>
 </tr>
 </table>

 <h3>Parameters</h3>
 <dl>
 <dt><i>vf</i></dt>
 <dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible libvorbisidec
 functions.</dd>
 <dt><i>i</i></dt>
 <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>
 </dl>


 <h3>Return Values</h3>
 <blockquote>
 <li>Returns the vorbis_comment struct for the specified bitstream.</li>
 <li>NULL if the specified bitstream does not exist or the file has been initialized improperly.</li>
 </blockquote>
 <p>

 <br><br>
 <hr noshade>
 <table border=0 width=100%>
 <tr valign=top>
 <td><p class=tiny>copyright &copy; 2002 Xiph.org</p></td>
 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
 </tr><tr>
 <td><p class=tiny>Tremor documentation</p></td>
 <td align=right><p class=tiny>Tremor version 1.0 - 20020403</p></td>
 </tr>
 </table>

 </body>

 </html>
	<html>

	<head>
	<title>Tremor - function - ov_bitrate</title>
	<link rel=stylesheet href="style.css" type="text/css">
	</head>


	<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
	<table border=0 width=100%>
	<tr>
	<td><p class=tiny>Tremor documentation</p></td>
	<td align=right><p class=tiny>Tremor version 1.0 - 20020403</p></td>
	</tr>
	</table>

	<h1>ov_comment</h1>

	<p><i>declared in "ivorbisfile.h";</i></p>

	<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.
	<p>

	<br><br>
	<table border=0 color=black cellspacing=0 cellpadding=7>
	<tr bgcolor=#cccccc>
	<td>
	<pre><b>
	vorbis_comment ov_comment(OggVorbis_File vf,int link);
	</b></pre>
	</td>
	</tr>
	</table>

	<h3>Parameters</h3>
	<dl>
	<dt><i>vf</i></dt>
	<dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible libvorbisidec
	functions.</dd>
	<dt><i>i</i></dt>
	<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>
	</dl>


	<h3>Return Values</h3>
	<blockquote>
	<li>Returns the vorbis_comment struct for the specified bitstream.</li>
	<li>NULL if the specified bitstream does not exist or the file has been initialized improperly.</li>
	</blockquote>
	<p>

	<br><br>
	<hr noshade>
	<table border=0 width=100%>
	<tr valign=top>
	<td><p class=tiny>copyright © 2002 Xiph.org</p></td>
	<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
	</tr><tr>
	<td><p class=tiny>Tremor documentation</p></td>
	<td align=right><p class=tiny>Tremor version 1.0 - 20020403</p></td>
	</tr>
	</table>

	</body>

	</html>