diff options
Diffstat (limited to 'vorbis/doc/vorbisfile/ov_comment.html')
-rw-r--r-- | vorbis/doc/vorbisfile/ov_comment.html | 66 |
1 files changed, 66 insertions, 0 deletions
diff --git a/vorbis/doc/vorbisfile/ov_comment.html b/vorbis/doc/vorbisfile/ov_comment.html new file mode 100644 index 0000000..9f1b499 --- /dev/null +++ b/vorbis/doc/vorbisfile/ov_comment.html @@ -0,0 +1,66 @@ +<html> + +<head> +<title>Vorbisfile - 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>Vorbisfile documentation</p></td> +<td align=right><p class=tiny>vorbisfile version 1.3.2 - 20101101</p></td> +</tr> +</table> + +<h1>ov_comment</h1> + +<p><i>declared in "vorbis/vorbisfile.h";</i></p> + +<p>Returns a pointer to the <a href="../libvorbis/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 libvorbisfile +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="../libvorbis/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 © 2000-2010 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>Vorbisfile documentation</p></td> +<td align=right><p class=tiny>vorbisfile version 1.3.2 - 20101101</p></td> +</tr> +</table> + +</body> + +</html> |