TremoloEffect class final

Configuration for the tremolo audio effect.

Sinusoidal amplitude modulation.

The filter accepts the following options:

Parameters:

  • d: Depth of modulation as a percentage. Range is 0.0 - 1.0. Default value is 0.5. (range 0.0..1.0, default 0.5)
  • f: Modulation frequency in Hertz. Modulation frequencies in the subharmonic range (20 Hz or lower) will result in a tremolo effect. This filter may also be used as a ring modulator by specifying a modulation frequency higher than 20 Hz. Range is 0.1 - 20000.0. Default value is 5.0 Hz. (range 0.1..20000.0, default 5.0)
Inheritance

Constructors

TremoloEffect({bool enabled = true, double d = 0.5, double f = 5.0})
Creates an TremoloEffect with the given parameter values.
const

Properties

d → double
set depth as percentage
final
enabled → bool
Whether this effect is applied. false keeps it in the list, with its settings, without inserting it in the chain.
final
f → double
set frequency in hertz
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
hashCode → int
The hash code for this object.
no setteroverride
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

copyWith({bool? enabled, double? d, double? f}) → TremoloEffect
Returns a copy of this TremoloEffect 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

Operators

operator ==(Object other) → bool
The equality operator.
override

Constants

dDefault → const double
Default value for d.
dMax → const double
Maximum value for d.
dMin → const double
Minimum value for d.
fDefault → const double
Default value for f.
fMax → const double
Maximum value for f.
fMin → const double
Minimum value for f.