Struct webrtc_audio_processing::GainControl
source · [−]pub struct GainControl {
pub mode: GainControlMode,
pub target_level_dbfs: i32,
pub compression_gain_db: i32,
pub enable_limiter: bool,
}
Expand description
Gain control configuration.
Fields
mode: GainControlMode
Determines what type of gain control is applied.
target_level_dbfs: i32
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: i32
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
sourceimpl Clone for GainControl
impl Clone for GainControl
sourcefn clone(&self) -> GainControl
fn clone(&self) -> GainControl
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for GainControl
impl Debug for GainControl
sourceimpl From<GainControl> for GainControl
impl From<GainControl> for GainControl
sourcefn from(other: GainControl) -> GainControl
fn from(other: GainControl) -> GainControl
Converts to this type from the input type.
sourceimpl PartialEq<GainControl> for GainControl
impl PartialEq<GainControl> for GainControl
sourcefn eq(&self, other: &GainControl) -> bool
fn eq(&self, other: &GainControl) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &GainControl) -> bool
fn ne(&self, other: &GainControl) -> bool
This method tests for !=
.
impl StructuralPartialEq for GainControl
Auto Trait Implementations
impl RefUnwindSafe for GainControl
impl Send for GainControl
impl Sync for GainControl
impl Unpin for GainControl
impl UnwindSafe for GainControl
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more