examples/sfexamples/oggvorbiscodec/src/libvorbis/doc/vorbisenc/vorbis_info.html

00001 <html>
00002 
00003 <head>
00004 <title>vorbis - datatype - vorbis_info</title>
00005 <link rel=stylesheet href="style.css" type="text/css">
00006 </head>
00007 
00008 <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
00009 <table border=0 width=100%>
00010 <tr>
00011 <td><p class=tiny>libvorbisenc documentation</p></td>
00012 <td align=right><p class=tiny>libvorbisenc release 1.1 - 20040709</p></td>
00013 </tr>
00014 </table>
00015 
00016 <h1>vorbis_info</h1>
00017 
00018 <p><i>declared in "vorbis/codec.h"</i></p>
00019 
00020 <p>
00021 The vorbis_info structure contains information about a vorbis bitstream.
00022 
00023 <p>
00024 
00025 <table border=0 width=100% color=black cellspacing=0 cellpadding=7>
00026 <tr bgcolor=#cccccc>
00027         <td>
00028 <pre><b>typedef struct vorbis_info{
00029   int version;
00030   int channels;
00031   long rate;
00032   
00033   long bitrate_upper;
00034   long bitrate_nominal;
00035   long bitrate_lower;
00036   long bitrate_window;
00037 
00038   void *codec_setup;
00039 
00040 } vorbis_info;</b></pre>
00041         </td>
00042 </tr>
00043 </table>
00044 
00045 <h3>Relevant Struct Members</h3>
00046 <dl>
00047 <dt><i>version</i></dt>
00048 <dd>Vorbis encoder version used to create this bitstream.</dd>
00049 <dt><i>channels</i></dt>
00050 <dd>Int signifying number of channels in bitstream.</dd>
00051 <dt><i>rate</i></dt>
00052 <dd>Sampling rate of the bitstream.</dd>
00053 <dt><i>bitrate_upper</i></dt>
00054 <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>
00055 <dt><i>bitrate_nominal</i></dt>
00056 <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>
00057 <dt><i>bitrate_lower</i></dt>
00058 <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>
00059 <dt><i>bitrate_window</i></dt>
00060 <dd>Specifies the size of the bit reservoir in seconds relative to the nominal bitrate.  May be unset.</dd>
00061 <dt><i>codec_setup</i></dt>
00062 <dd>Pointer to private encoder setup state.</dd>
00063 
00064 </dl>
00065 
00066 
00067 <br><br>
00068 <hr noshade>
00069 <table border=0 width=100%>
00070 <tr valign=top>
00071 <td><p class=tiny>copyright &copy; 2004 vorbis team</p></td>
00072 <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>
00073 </tr><tr>
00074 <td><p class=tiny>vorbisfile documentation</p></td>
00075 <td align=right><p class=tiny>libvorbisenc release 1.1 - 20040709</p></td>
00076 </tr>
00077 </table>
00078 
00079 </body>
00080 
00081 </html>

Generated by  doxygen 1.6.2