AudioEffectStore class abstract

Audio effect setting related interfaces, managing voice changer, reverb, and ear monitor features for anchors.

AudioEffectStore Audio effect management class for handling anchor audio effect related business. AudioEffectStore provides a complete set of audio effect management APIs, including voice changer effects, reverb effects, and ear monitor functionality. Through this class, anchors can adjust their voice effects in real-time during live streaming to enhance the experience.

Key Features

• Voice Changer Effects：Supports multiple voice changer effects such as child, little girl, uncle, etc.
• Reverb Effects：Supports multiple reverb effects such as KTV, small room, auditorium, etc.
• Ear Monitor：Anchors can hear their own voice in earphones, suitable for singing scenarios
• Volume Control：Supports fine-grained ear monitor volume adjustment

Important: Use the shared singleton to get the AudioEffectStore instance. The set effects will automatically become invalid after leaving the room, and need to be set again for the next room entry.

Note: Audio effect state updates are delivered through the audioEffectState publisher. Subscribe to it to receive real-time updates about voice changer, reverb, and ear monitor states.

Usage Example

// Get singleton instance
final store = AudioEffectStore.shared;

// Subscribe to state changes
store.audioEffectState.audioChangerType.addListener(() {
    print("Current voice changer: ${store.audioEffectState.audioChangerType.value}");
});

store.audioEffectState.audioReverbType.addListener(() {
    print("Current reverb: ${store.audioEffectState.audioReverbType.value}");
});

// Set voice changer effect
store.setAudioChangerType(AudioChangerType.littleGirl);

// Set reverb effect
store.setAudioReverbType(AudioReverbType.ktv);

// Enable ear monitor
store.setVoiceEarMonitorEnable(true);
store.setVoiceEarMonitorVolume(80);

Topics

Getting Instance

• shared : Get singleton instance

Observing State

• audioEffectState : Audio effect state data

Voice Changer Settings

• setAudioChangerType : Set voice changer effect

Reverb Settings

• setAudioReverbType : Set reverb effect

Ear Monitor Settings

• setVoiceEarMonitorEnable : Enable/disable ear monitor
• setVoiceEarMonitorVolume : Set ear monitor volume

Reset

• reset : Reset to default state

See Also

• AudioChangerType
• AudioReverbType
• AudioEffectState