AudioEffect class abstract
Subclasses of AudioEffect can be inserted into an AudioPipeline to modify the audio signal outputted by an AudioPlayer. The same audio effect instance cannot be set on multiple players at the same time.
An AudioEffect is disabled by default. For an AudioEffect to take effect, in addition to being part of an AudioPipeline attached to an AudioPlayer you must also enable the effect via setEnabled.
- Implementers
Constructors
Properties
- enabled → bool
-
Whether the effect is enabled. When
true
, and if the effect is part of an AudioPipeline attached to an AudioPlayer, the effect will modify the audio player's output. Whenfalse
, the audio pipeline will still reserve platform resources for the effect but the effect will be bypassed.no setter -
enabledStream
→ Stream<
bool> -
A stream of the current enabled value.
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
setEnabled(
bool enabled) → Future< void> -
Set the
enabled
status of this audio effect. -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited