examples/SFExamples/oggvorbiscodec/src/libogg/doc/ogg/vorbis_info.html

00001 <html>
00002 
00003 <head>
00004 <title>Vorbisfile - 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>Vorbisfile documentation</p></td>
00012 <td align=right><p class=tiny>libVorbisfile version 1.65 - 20020702</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 basic information about the audio in a vorbis bitstream.
00022 <p>
00023 
00024 <table border=0 width=100% color=black cellspacing=0 cellpadding=7>
00025 <tr bgcolor=#cccccc>
00026         <td>
00027 <pre><b>typedef struct vorbis_info{
00028   int version;
00029   int channels;
00030   long rate;
00031   
00032   long bitrate_upper;
00033   long bitrate_nominal;
00034   long bitrate_lower;
00035   long bitrate_window;
00036 
00037   void *codec_setup;
00038 
00039 } vorbis_info;</b></pre>
00040         </td>
00041 </tr>
00042 </table>
00043 
00044 <h3>Relevant Struct Members</h3>
00045 <dl>
00046 <dt><i>version</i></dt>
00047 <dd>Vorbis encoder version used to create this bitstream.</dd>
00048 <dt><i>channels</i></dt>
00049 <dd>Int signifying number of channels in bitstream.</dd>
00050 <dt><i>rate</i></dt>
00051 <dd>Sampling rate of the bitstream.</dd>
00052 <dt><i>bitrate_upper</i></dt>
00053 <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>
00054 <dt><i>bitrate_nominal</i></dt>
00055 <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>
00056 <dt><i>bitrate_lower</i></dt>
00057 <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>
00058 <dt><i>bitrate_window</i></dt>
00059 <dd>Currently unset.</dd>
00060 
00061 <dt><i>codec_setup</i></dt>
00062 <dd>Internal structure that contains the detailed/unpacked configuration for decoding the current Vorbis bitstream.</dd>
00063 </dl>
00064 
00065 
00066 <br><br>
00067 <hr noshade>
00068 <table border=0 width=100%>
00069 <tr valign=top>
00070 <td><p class=tiny>copyright &copy; 2002 Xiph.org</p></td>
00071 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
00072 </tr><tr>
00073 <td><p class=tiny>Vorbisfile documentation</p></td>
00074 <td align=right><p class=tiny>libVorbisfile version 1.65 - 20020702</p></td>
00075 </tr>
00076 </table>
00077 
00078 </body>
00079 
00080 </html>

Generated by  doxygen 1.6.2