McompandEffect class final

Configuration for the mcompand audio effect.

Multiband Compress or expand the audio's dynamic range.

The input audio is divided into bands using 4th order Linkwitz-Riley IIRs. This is akin to the crossover of a loudspeaker, and results in flat frequency response when absent compander action.

It accepts the following parameters:

Parameters:

• args: This option syntax is: attack,decay,[attack,decay..] soft-knee points crossover_frequency [delay [initial_volume [gain]]] | attack,decay ... For explanation of each item refer to compand filter documentation. (range 0..0, default "0.005,0.1 6 -47/-40,-34/-34,-17/-33 100 | 0.003,0.05 6 -47/-40,-34/-34,-17/-33 400 | 0.000625,0.0125 6 -47/-40,-34/-34,-15/-33 1600 | 0.0001,0.025 6 -47/-40,-34/-34,-31/-31,-0/-30 6400 | 0,0.025 6 -38/-31,-28/-28,-0/-25 22000")

Inheritance

• Object
• AudioEffect
• McompandEffect

Available extensions

• McompandBandsX

Constructors

McompandEffect({bool enabled = true, String args = '0.005,0.1 6 -47/-40,-34/-34,-17/-33 100 | 0.003,0.05 6 -47/-40,-34/-34,-17/-33 400 | 0.000625,0.0125 6 -47/-40,-34/-34,-15/-33 1600 | 0.0001,0.025 6 -47/-40,-34/-34,-31/-31,-0/-30 6400 | 0,0.025 6 -38/-31,-28/-28,-0/-25 22000'})

Creates an McompandEffect with the given parameter values.

const

Properties

args → String

set parameters for each band

final

bands → List<McompandBand>

Available on McompandEffect, provided by the McompandBandsX extension

Decoded list of bands, sorted by ascending crossover.

no setter

enabled → bool

Whether this effect is applied. false keeps it in the list, with its settings, without inserting it in the chain.

final

filter → AudioFilter

The filter this stage runs, as a typed identifier (null for a RawAudioEffect).

no setter, override

filterName → String

The lavfi filter this stage runs, e.g. equalizer.

no setter, override

hashCode → int

The hash code for this object.

no setter, override

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

copyWith({bool? enabled, String? args}) → McompandEffect

Returns a copy of this McompandEffect with the given fields replaced.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toFilterString() → String

Returns the audio chain entry for this effect. Only non-default parameters are emitted.

override

toString() → String

A string representation of this object.

override

withBands(List<McompandBand> bands) → McompandEffect

Available on McompandEffect, provided by the McompandBandsX extension

Returns a copy whose args reflects bands (ascending crossover order, lossless serialisation).

Operators

operator ==(Object other) → bool

The equality operator.

override