|
cannam@86
|
1 <html>
|
|
cannam@86
|
2
|
|
cannam@86
|
3 <head>
|
|
cannam@86
|
4 <title>Vorbisfile - function - ov_bitrate</title>
|
|
cannam@86
|
5 <link rel=stylesheet href="style.css" type="text/css">
|
|
cannam@86
|
6 </head>
|
|
cannam@86
|
7
|
|
cannam@86
|
8 <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
|
|
cannam@86
|
9 <table border=0 width=100%>
|
|
cannam@86
|
10 <tr>
|
|
cannam@86
|
11 <td><p class=tiny>Vorbisfile documentation</p></td>
|
|
cannam@86
|
12 <td align=right><p class=tiny>vorbisfile version 1.3.2 - 20101101</p></td>
|
|
cannam@86
|
13 </tr>
|
|
cannam@86
|
14 </table>
|
|
cannam@86
|
15
|
|
cannam@86
|
16 <h1>ov_bitrate</h1>
|
|
cannam@86
|
17
|
|
cannam@86
|
18 <p><i>declared in "vorbis/vorbisfile.h";</i></p>
|
|
cannam@86
|
19
|
|
cannam@86
|
20 <p>This function returns the average bitrate for the specified logical bitstream. This may be different from the <a href=ov_info.html>ov_info->nominal_bitrate</a> value, as it is based on the actual average for this bitstream if the file is seekable.
|
|
cannam@86
|
21 <p>Nonseekable files will return the nominal bitrate setting or the average of the upper and lower bounds, if any of these values are set.
|
|
cannam@86
|
22 <p>
|
|
cannam@86
|
23
|
|
cannam@86
|
24 <br><br>
|
|
cannam@86
|
25 <table border=0 color=black cellspacing=0 cellpadding=7>
|
|
cannam@86
|
26 <tr bgcolor=#cccccc>
|
|
cannam@86
|
27 <td>
|
|
cannam@86
|
28 <pre><b>
|
|
cannam@86
|
29 long ov_bitrate(OggVorbis_File *vf,int i);
|
|
cannam@86
|
30 </b></pre>
|
|
cannam@86
|
31 </td>
|
|
cannam@86
|
32 </tr>
|
|
cannam@86
|
33 </table>
|
|
cannam@86
|
34
|
|
cannam@86
|
35 <h3>Parameters</h3>
|
|
cannam@86
|
36 <dl>
|
|
cannam@86
|
37 <dt><i>vf</i></dt>
|
|
cannam@86
|
38 <dd>A pointer to the OggVorbis_File structure--this is used for ALL the externally visible libvorbisfile
|
|
cannam@86
|
39 functions.</dd>
|
|
cannam@86
|
40 <dt><i>i</i></dt>
|
|
cannam@86
|
41 <dd>Link to the desired logical bitstream. For nonseekable files, this argument is ignored. To retrieve the bitrate for the entire bitstream, this parameter should be set to -1.</dd>
|
|
cannam@86
|
42 </dl>
|
|
cannam@86
|
43
|
|
cannam@86
|
44
|
|
cannam@86
|
45 <h3>Return Values</h3>
|
|
cannam@86
|
46 <blockquote>
|
|
cannam@86
|
47 <li>OV_EINVAL indicates that an invalid argument value was submitted or that the stream represented by <tt>vf</tt> is not open.</li>
|
|
cannam@86
|
48 <li>OV_FALSE means the call returned a 'false' status, which in this case most likely indicates that the file is nonseekable and the upper, lower, and nominal bitrates were unset.
|
|
cannam@86
|
49 <li><i>n</i> indicates the bitrate for the given logical bitstream or the entire
|
|
cannam@86
|
50 physical bitstream. If the file is open for random (seekable) access, it will
|
|
cannam@86
|
51 find the *actual* average bitrate. If the file is streaming (nonseekable), it
|
|
cannam@86
|
52 returns the nominal bitrate (if set) or else the average of the
|
|
cannam@86
|
53 upper/lower bounds (if set).</li>
|
|
cannam@86
|
54 </blockquote>
|
|
cannam@86
|
55 <p>
|
|
cannam@86
|
56
|
|
cannam@86
|
57
|
|
cannam@86
|
58 <br><br>
|
|
cannam@86
|
59 <hr noshade>
|
|
cannam@86
|
60 <table border=0 width=100%>
|
|
cannam@86
|
61 <tr valign=top>
|
|
cannam@86
|
62 <td><p class=tiny>copyright © 2000-2010 Xiph.Org</p></td>
|
|
cannam@86
|
63 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
|
|
cannam@86
|
64 </tr><tr>
|
|
cannam@86
|
65 <td><p class=tiny>Vorbisfile documentation</p></td>
|
|
cannam@86
|
66 <td align=right><p class=tiny>vorbisfile version 1.3.2 - 20101101</p></td>
|
|
cannam@86
|
67 </tr>
|
|
cannam@86
|
68 </table>
|
|
cannam@86
|
69
|
|
cannam@86
|
70 </body>
|
|
cannam@86
|
71
|
|
cannam@86
|
72 </html>
|
