Struct kira::track::effect::compressor::CompressorBuilder

#[non_exhaustive]
pub struct CompressorBuilder {
    pub threshold: Value<f64>,
    pub ratio: Value<f64>,
    pub attack_duration: Value<Duration>,
    pub release_duration: Value<Duration>,
    pub makeup_gain: Value<f64>,
    pub mix: Value<f64>,
}

Configures a compressor.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

threshold: Value<f64>

The volume above which volume will start to be decreased (in dBFS).

ratio: Value<f64>

How much the signal will be compressed.

A ratio of 2.0 (or 2 to 1) means an increase of 3dB will become an increase of 1.5dB. Ratios between 0.0 and 1.0 will actually expand the audio.

attack_duration: Value<Duration>

How much time it takes for the volume attenuation to ramp up once the input volume exceeds the threshold.

release_duration: Value<Duration>

How much time it takes for the volume attenuation to relax once the input volume dips below the threshold.

makeup_gain: Value<f64>

The amount to change the volume after processing (in dB).

This can be used to compensate for the decrease in volume resulting from compression. This is only applied to the wet signal, nto the dry signal.

mix: Value<f64>

How much dry (unprocessed) signal should be blended with the wet (processed) signal. 0.0 means only the dry signal will be heard. 1.0 means only the wet signal will be heard.

Implementations

impl CompressorBuilder

pub fn new() -> Self

Creates a new CompressorBuilder with the default settings.

pub fn threshold(self, threshold: impl Into<Value<f64>>) -> Self

Sets the volume above which volume will start to be decreased (in dBFS).

pub fn ratio(self, ratio: impl Into<Value<f64>>) -> Self

Sets how much the signal will be compressed.

A ratio of 2.0 (or 2 to 1) means an increase of 3dB will become an increase of 1.5dB. Ratios between 0.0 and 1.0 will actually expand the audio.

pub fn attack_duration( self, attack_duration: impl Into<Value<Duration>> ) -> Self

Sets how much time it takes for the volume attenuation to ramp up once the input volume exceeds the threshold.

pub fn release_duration( self, release_duration: impl Into<Value<Duration>> ) -> Self

Sets how much time it takes for the volume attenuation to relax once the input volume dips below the threshold.

pub fn makeup_gain(self, makeup_gain: impl Into<Value<f64>>) -> Self

Sets the amount to change the volume after processing (in dB).

This can be used to compensate for the decrease in volume resulting from compression. This is only applied to the wet signal, nto the dry signal.

pub fn mix(self, mix: impl Into<Value<f64>>) -> Self

Sets how much dry (unprocessed) signal should be blended with the wet (processed) signal. 0.0 means only the dry signal will be heard. 1.0 means only the wet signal will be heard.

Trait Implementations

impl Default for CompressorBuilder

fn default() -> Self

Returns the “default value” for a type.

impl EffectBuilder for CompressorBuilder

type Handle = CompressorHandle

Allows the user to control the effect from gameplay code.

fn build(self) -> (Box<dyn Effect>, Self::Handle)

Creates the effect and a handle to the effect.