4 <title>vorbis - datatype - ov_ectl_ratemanage_arg</title>
5 <link rel=stylesheet href="style.css" type="text/css">
8 <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
9 <table border=0 width=100%>
11 <td><p class=tiny>libvorbisenc documentation</p></td>
12 <td align=right><p class=tiny>libvorbisenc release 1.1 - 20040709</p></td>
16 <h1>ov_ectl_ratemanage_arg</h1>
18 <p><i>declared in "vorbis/vorbisenc.h"</i></p>
22 The ov_ectl_ratemanage_arg structure is used with <a
23 href="vorbis_encode_ctl.html">vorbis_encode_ctl()</a> and the OV_ECTL_RATEMANAGE_GET,
24 OV_ECTL_RATEMANAGE_SET, OV_ECTL_RATEMANAGE_AVG,
25 OV_ECTL_RATEMANAGE_HARD calls in order to query and modify specifics
26 of the encoder's bitrate management configuration. Note that this is
27 a deprecated interface; please use vorbis_encode_ctl() with the <a
28 href="ov_ectl_ratemanage2_arg.html">ov_ectl_ratemanage2_arg</a> struct
29 and OV_ECTL_RATEMANAGE2_GET and OV_ECTL_RATEMANAGE2_SET calls in new
34 <table border=0 width=100% color=black cellspacing=0 cellpadding=7>
37 <pre><b>struct ovectl_ratemanage_arg {
38 int management_active;
40 long bitrate_hard_min;
41 long bitrate_hard_max;
42 double bitrate_hard_window;
46 double bitrate_av_window;
47 double bitrate_av_window_center;
53 <h3>Relevant Struct Members</h3>
56 <dt><i>management_active</i></dt>
57 <dd>nonzero if bitrate management is active</dd>
59 <dt><i>bitrate_hard_min</i></dt>
60 <dd>hard lower limit (in kilobits per second) below which the stream bitrate will never be allowed for any given bitrate_hard_window seconds of time.</dd>
61 <dt><i>bitrate_hard_max</i></dt>
62 <dd>hard upper limit (in kilobits per second) above which the stream bitrate will never be allowed for any given bitrate_hard_window seconds of time.</dd>
63 <dt><i>bitrate_hard_window</i></dt>
64 <dd>the window period (in seconds) used to regulate the hard bitrate minimum and maximum</dd>
66 <dt><i>bitrate_av_lo</i></dt>
67 <dd>soft lower limit (in kilobits per second) below which the average bitrate tracker will start nudging the bitrate higher.</dd>
68 <dt><i>bitrate_av_hi</i></dt>
69 <dd>soft upper limit (in kilobits per second) above which the average bitrate tracker will start nudging the bitrate lower.</dd>
70 <dt><i>bitrate_av_window</i></dt>
71 <dd>the window period (in seconds) used to regulate the average bitrate minimum and maximum.</dd>
72 <dt><i>bitrate_av_window_center</i></dt>
73 <dd>Regulates the relative centering of the average and hard windows; in libvorbis 1.0 and 1.0.1, the hard window regulation overlapped but followed the average window regulation. In libvorbis 1.1 a bit-reservoir interface replaces the old windowing interface; the older windowing interface is simulated and this field has no effect.</dd>
80 <table border=0 width=100%>
82 <td><p class=tiny>copyright © 2004 vorbis team</p></td>
83 <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>
85 <td><p class=tiny>vorbisfile documentation</p></td>
86 <td align=right><p class=tiny>libvorbisenc release 1.1 - 20040709</p></td>