FirequalizerEffect class final

Configuration for the firequalizer audio effect.

Apply FIR Equalization using arbitrary frequency response.

The filter accepts the following option:

Parameters:

accuracy: Set filter accuracy in Hz. Lower value means more accurate. Default is 5. (range 3..1e10, default 5.0)
delay: Set filter delay in seconds. Higher value means more accurate. Default is 0.01. (range 0.0..1e10, default 0.01)
dumpfile: Set file for dumping, suitable for gnuplot. (range 0..0, default "")
dumpscale: Set scale for dumpfile. Acceptable values are same with scale option. Default is linlog. (range 0..3, default SCALE_LINLOG)
fft2: Enable 2-channel convolution using complex FFT. This improves speed significantly. Default is disabled. (range 0..1, default 0)
fixed: If enabled, use fixed number of audio samples. This improves speed when filtering with large delay. Default is disabled. (range 0..1, default 0)
gain: Set gain curve equation (in dB). The expression can contain variables: (range 0..0, default "gain_interpolate(f)", runtime-tunable)
gainEntry: Set gain entry for gain_interpolate function. The expression can contain functions: (range 0..0, default "", runtime-tunable)
minPhase: Enable minimum phase impulse response. Default is disabled. (range 0..1, default 0)
multi: Enable multichannels evaluation on gain. Default is disabled. (range 0..1, default 0)
scale: Set scale used by gain. Acceptable values are: (range 0..3, default SCALE_LINLOG)
wfunc: Set window function. Acceptable values are: (range 0..9, default WFUNC_HANN)
zeroPhase: Enable zero phase mode by subtracting timestamp to compensate delay. Default is disabled. (range 0..1, default 0)

Inheritance

Available extensions

Constructors

FirequalizerEffect({bool enabled = true, double accuracy = 5.0, double delay = 0.01, String dumpfile = '', FirequalizerScale dumpscale = FirequalizerScale.linlog, bool fft2 = false, bool fixed = false, String gain = 'gain_interpolate(f)', String gainEntry = '', bool minPhase = false, bool multi = false, FirequalizerScale scale = FirequalizerScale.linlog, FirequalizerWfunc wfunc = FirequalizerWfunc.hann, bool zeroPhase = false}): Creates an FirequalizerEffect with the given parameter values.
const

accuracy → double: set accuracy
final
delay → double: set delay
final
dumpfile → String: set dump file
final
dumpscale → FirequalizerScale: set dump scale
final
enabled → bool: Whether this effect is applied. false keeps it in the list, with its settings, without inserting it in the chain.
final
fft2 → bool: set 2-channels fft
final
filter → AudioFilter: The filter this stage runs, as a typed identifier (null for a RawAudioEffect).
no setteroverride
filterName → String: The lavfi filter this stage runs, e.g. equalizer.
no setteroverride
fixed → bool: set fixed frame samples
final
gain → String: set gain curve
final
gainEntries → List<FirequalizerEntry>: Available on FirequalizerEffect, provided by the FirequalizerEntriesX extension
Decoded gain entries, sorted by ascending frequency.
no setter
gainEntry → String: set gain entry
final
hashCode → int: The hash code for this object.
no setteroverride
minPhase → bool: set minimum phase mode
final
multi → bool: set multi channels mode
final
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
scale → FirequalizerScale: set gain scale
final
wfunc → FirequalizerWfunc: set window function
final
zeroPhase → bool: set zero phase mode
final

copyWith({bool? enabled, double? accuracy, double? delay, String? dumpfile, FirequalizerScale? dumpscale, bool? fft2, bool? fixed, String? gain, String? gainEntry, bool? minPhase, bool? multi, FirequalizerScale? scale, FirequalizerWfunc? wfunc, bool? zeroPhase}) → FirequalizerEffect: Returns a copy of this FirequalizerEffect 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
withGainEntries(List<FirequalizerEntry> entries) → FirequalizerEffect: Available on FirequalizerEffect, provided by the FirequalizerEntriesX extension
Returns a copy whose gainEntry reflects entries (ascending frequency order). Empty input clears the filter's response.