diff options
Diffstat (limited to 'doc/vorbisenc/vorbis_info.html')
-rw-r--r-- | doc/vorbisenc/vorbis_info.html | 81 |
1 files changed, 81 insertions, 0 deletions
diff --git a/doc/vorbisenc/vorbis_info.html b/doc/vorbisenc/vorbis_info.html new file mode 100644 index 0000000..99d2bbe --- /dev/null +++ b/doc/vorbisenc/vorbis_info.html @@ -0,0 +1,81 @@ +<html> + +<head> +<title>vorbis - datatype - vorbis_info</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>libvorbisenc documentation</p></td> +<td align=right><p class=tiny>libvorbisenc release 1.1 - 20040709</p></td> +</tr> +</table> + +<h1>vorbis_info</h1> + +<p><i>declared in "vorbis/codec.h"</i></p> + +<p> +The vorbis_info structure contains information about a vorbis bitstream. + +<p> + +<table border=0 width=100% color=black cellspacing=0 cellpadding=7> +<tr bgcolor=#cccccc> + <td> +<pre><b>typedef struct vorbis_info{ + int version; + int channels; + long rate; + + long bitrate_upper; + long bitrate_nominal; + long bitrate_lower; + long bitrate_window; + + void *codec_setup; + +} vorbis_info;</b></pre> + </td> +</tr> +</table> + +<h3>Relevant Struct Members</h3> +<dl> +<dt><i>version</i></dt> +<dd>Vorbis encoder version used to create this bitstream.</dd> +<dt><i>channels</i></dt> +<dd>Int signifying number of channels in bitstream.</dd> +<dt><i>rate</i></dt> +<dd>Sampling rate of the bitstream.</dd> +<dt><i>bitrate_upper</i></dt> +<dd>Specifies the upper limit in a VBR bitstream. If the value matches the bitrate_nominal and bitrate_lower parameters, the stream is fixed bitrate. May be unset if no limit exists.</dd> +<dt><i>bitrate_nominal</i></dt> +<dd>Specifies the average bitrate for a VBR bitstream. May be unset. If the bitrate_upper and bitrate_lower parameters match, the stream is fixed bitrate.</dd> +<dt><i>bitrate_lower</i></dt> +<dd>Specifies the lower limit in a VBR bitstream. If the value matches the bitrate_nominal and bitrate_upper parameters, the stream is fixed bitrate. May be unset if no limit exists.</dd> +<dt><i>bitrate_window</i></dt> +<dd>Specifies the size of the bit reservoir in seconds relative to the nominal bitrate. May be unset.</dd> +<dt><i>codec_setup</i></dt> +<dd>Pointer to private encoder setup state.</dd> + +</dl> + + +<br><br> +<hr noshade> +<table border=0 width=100%> +<tr valign=top> +<td><p class=tiny>copyright © 2004 vorbis team</p></td> +<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team@vorbis.org">team@vorbis.org</a></p></td> +</tr><tr> +<td><p class=tiny>vorbisfile documentation</p></td> +<td align=right><p class=tiny>libvorbisenc release 1.1 - 20040709</p></td> +</tr> +</table> + +</body> + +</html> |