Enum AudioEffect 

pub enum AudioEffect {
    Eq {
        bands: Vec<EqBand>,
    },
    Compressor {
        threshold_db: f32,
        ratio: f32,
        attack_ms: f32,
        release_ms: f32,
        lookahead_ms: f32,
    },
    Reverb {
        room_size: f32,
        damping: f32,
        mix: f32,
    },
}

A serializable single-input audio effect applied to a clip or track bus.

Sidechain ducking is not an entry here because it consumes a second input. It is authored per track through Ducking.

Variants

Eq

Cascaded biquad sections.

Fields

bands: Vec<EqBand>

Ordered filter sections, 1 to MAX_EQ_BANDS of them.

Compressor

Lookahead dynamic range compression.

Fields

threshold_db: f32

Level above which gain reduction begins, in decibels from MIN_LEVEL_DB to 0.

ratio: f32

Downward ratio, from one (unity) to MAX_COMPRESSOR_RATIO.

attack_ms: f32

Attack time in milliseconds, positive and at most MAX_ENVELOPE_MS.

release_ms: f32

Release time in milliseconds, positive and at most MAX_ENVELOPE_MS.

lookahead_ms: f32

Lookahead in milliseconds, at most MAX_LOOKAHEAD_MS. Reported as graph latency.

Reverb

Schroeder reverberation.

Fields

room_size: f32

Room size, in 0..=1.

damping: f32

High-frequency damping, in 0..=1.

mix: f32

Wet mix, in 0..=1.

Implementations

impl AudioEffect

pub fn delay_ticks(&self) -> u64

What this effect counts toward MAX_AUDIO_DELAY_MS, in ticks (a millisecond is 120), rounded up: a compressor its lookahead_ms, a reverb REVERB_DELAY_MS. A tick count is exact, so the effects of a project add up to the same number in any order.

pub fn lookahead_ticks(&self) -> u64

How early a mixer reads this effect’s input, in ticks, rounded up: a compressor’s lookahead_ms.

Trait Implementations

impl Clone for AudioEffect

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AudioEffect

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AudioEffect

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for AudioEffect

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for AudioEffect

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for AudioEffect