Struct GainController1 

pub struct GainController1 {
    pub mode: GainControllerMode,
    pub target_level_dbfs: u8,
    pub compression_gain_db: u8,
    pub enable_limiter: bool,
    pub analog_gain_controller: Option<AnalogGainController>,
}

Enables automatic gain control (AGC) functionality. The automatic gain control (AGC) component brings the signal to an appropriate range. This is done by applying a digital gain directly and, in the analog mode, prescribing an analog gain to be applied at the audio HAL. Recommended to be enabled on the client-side.

Fields

mode: GainControllerMode

AGC mode.

target_level_dbfs: u8

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: u8

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].

For updates after APM setup, the C++ upstream suggests using RuntimeSetting instead (which is not yet exposed in the Rust wrapper).

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.

analog_gain_controller: Option<AnalogGainController>

Analog gain controller configuration.

Trait Implementations

impl Clone for GainController1

fn clone(&self) -> GainController1

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GainController1

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

Formats the value using the given formatter.

impl Default for GainController1

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GainController1

where GainController1: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for GainController1

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for GainController1

fn eq(&self, other: &GainController1) -> 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 Serialize for GainController1

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for GainController1

impl StructuralPartialEq for GainController1