AudioEffectState class abstract

Audio effect related state data provided by AudioEffectStore

A comprehensive snapshot of the current audio effect session state. This structure contains all relevant information about voice changer effects, reverb effects, and ear monitor state.

Note: The state is updated automatically when audio effect settings change. Subscribe to audioEffectState to receive real-time updates.

Usage Example

// Update voice changer UI
store.audioEffectState.audioChangerType.addListener(() {
    updateChangerTypeUI(store.audioEffectState.audioChangerType.value);
});

// Update reverb UI
store.audioEffectState.audioReverbType.addListener(() {
    updateReverbTypeUI(store.audioEffectState.audioReverbType.value);
});

// Update ear monitor UI
store.audioEffectState.isEarMonitorOpened.addListener(() {
    updateEarMonitorUI(store.audioEffectState.isEarMonitorOpened.value);
});

State Property Overview

Property Type Description
audioChangerType ValueListenable<AudioChangerType> Current voice changer effect type
audioReverbType ValueListenable<AudioReverbType> Current reverb effect type
isEarMonitorOpened ValueListenable<bool> Whether ear monitor is enabled
earMonitorVolume ValueListenable<int> Ear monitor volume (0-100)

Constructors

AudioEffectState()

Properties

audioChangerType ValueListenable<AudioChangerType>
Voice changer state.
no setter
audioReverbType ValueListenable<AudioReverbType>
Reverb state.
no setter
earMonitorVolume ValueListenable<int>
Ear monitor volume, range 0 - 100. @note If the volume is still too low after setting it to 100, you can set the volume to a maximum of 150, but a volume exceeding 100 may cause distortion, please operate with caution.
no setter
hashCode int
The hash code for this object.
no setterinherited
isEarMonitorOpened ValueListenable<bool>
Ear monitor enabled.
no setter
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
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited