Struct GainControl

#[repr(C)]
pub struct GainControl {
    pub enable: bool,
    pub mode: GainControl_Mode,
    pub target_level_dbfs: c_int,
    pub compression_gain_db: c_int,
    pub enable_limiter: bool,
}

Gain control configuration.

Fields

enable: bool

Whether to use gain control.

mode: GainControl_Mode

Determines what type of gain control is applied.

target_level_dbfs: c_int

Sets the target peak level (or envelope) of the AGC in dBFs (decibels from digital full-scale). The convention is to use positive values. For instance, passing in a value of 3 corresponds to -3 dBFs, or a target level 3 dB below full-scale. Limited to [0, 31].

compression_gain_db: c_int

Sets the maximum gain the digital compression stage may apply, in dB. A higher number corresponds to greater compression, while a value of 0 will leave the signal uncompressed. Limited to [0, 90].

enable_limiter: bool

When enabled, the compression stage will hard limit the signal to the target level. Otherwise, the signal will be compressed but not limited above the target level.

Trait Implementations

impl Clone for GainControl

fn clone(&self) -> GainControl

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GainControl

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for GainControl

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for GainControl

fn eq(&self, other: &GainControl) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for GainControl

impl StructuralPartialEq for GainControl