Skip to main content

MasterLimiter

Struct MasterLimiter 

Source
pub struct MasterLimiter {
    pub ceiling_db: f32,
    pub lookahead_ms: f32,
    pub release_ms: f32,
}
Expand description

Settings of the master bus’s limiter, enabled with MixerConfig::limiter.

The output is delayed by lookahead_ms, and the gain at each frame comes from the loudest frame within that window, so the gain is already down when a peak leaves the delay: the output never exceeds ceiling_db. The gain drops at once and recovers exponentially with a time constant of release_ms. A look-ahead of 0 adds no latency and still keeps every sample at or below the ceiling, at the cost of a sharper attack. Below the ceiling, the signal passes unchanged.

Fields§

§ceiling_db: f32

The highest output level, in dBFS, -24..=0. Default -1.

§lookahead_ms: f32

Delay that lets the gain anticipate peaks, 0..=10 ms. Default 0.

§release_ms: f32

Time constant of the gain’s recovery, 1..=2000 ms. Default 50, as Audio::limit.

Trait Implementations§

Source§

impl Clone for MasterLimiter

Source§

fn clone(&self) -> MasterLimiter

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for MasterLimiter

Source§

impl Debug for MasterLimiter

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for MasterLimiter

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl PartialEq for MasterLimiter

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for MasterLimiter

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.