Introduction
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.
Important:
Use the AudioEffectStore.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.
Warning:
Due to the very high hardware latency of Bluetooth earphones, the ear monitor feature cannot be enabled when the anchor is wearing Bluetooth earphones. Please prompt the anchor to wear wired earphones in the user interface.
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
Subscribable Data
AudioEffectState fields are described below:
|
audioChangerType | | Voice changer state. |
audioReverbType | | Reverb state. |
isEarMonitorOpened | StateFlow<Boolean> | Ear monitor enabled. |
earMonitorVolume | StateFlow<Int> | Ear monitor volume, range 0 - 100.
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. |
API List
|
| Get singleton instance. |
| Set voice changer effect. |
| Set reverb effect. |
| Enable/disable ear monitor. |
| Set ear monitor volume. |
| Reset to default state. |
Getting Instance
AudioEffectStore.shared
Get singleton instance
Voice Changer Settings
setAudioChangerType
Set voice changer effect
abstract fun setAudioChangerType(type: AudioChangerType)
Through this interface, you can set the voice changer effect for human voice.
Voice changer effects can be applied to human voice, and the voice is processed secondarily through acoustic algorithms to obtain a timbre different from the original sound.
Version
Supported since version 3.5.
Notes
Note:
The set effect will automatically become invalid after leaving the room. If you need the corresponding effect for the next room entry, you need to call this interface again to set it.
Parameters
|
type | | Required | Voice changer effect type. |
Reverb Settings
setAudioReverbType
Set reverb effect
abstract fun setAudioReverbType(type: AudioReverbType)
Through this interface, you can set the reverb effect for human voice.
Reverb effects can be applied to human voice, and the sound is processed through acoustic algorithms to simulate the presence in various different environments.
Version
Supported since version 3.5.
Notes
Note:
The set effect will automatically become invalid after leaving the room. If you need the corresponding effect for the next room entry, you need to call this interface again to set it.
Parameters
|
type | | Required | Reverb effect type. |
Ear Monitor Settings
setVoiceEarMonitorEnable
Enable/disable ear monitor
abstract fun setVoiceEarMonitorEnable(enable: Boolean)
After the anchor enables ear monitor, they can hear their own voice captured by the microphone in the earphones. This effect is suitable for anchor singing application scenarios.
Version
Supported since version 3.5.
Notes
Warning:
Due to the very high hardware latency of Bluetooth earphones, this effect cannot be enabled when the anchor is wearing Bluetooth earphones. Please try to prompt the anchor to wear wired earphones in the user interface.
Parameters
|
enable | Boolean | Required | Whether to enable ear monitor. |
setVoiceEarMonitorVolume
Set ear monitor volume
abstract fun setVoiceEarMonitorVolume(volume: Int)
Through this interface, you can set the volume of the sound in the ear monitor effect.
Version
Supported since version 3.5.
Notes
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.
Parameters
|
volume | Int | Required | Ear monitor volume, range 0 - 100. |
Reset
reset
Reset to default state
Reset all audio effect settings to default values, including disabling voice changer effect, disabling reverb effect, disabling ear monitor, and resetting ear monitor volume.
Version
Supported since version 3.5.
Data Structures
AudioChangerType
Voice changer effect type
|
NONE | 0 | Disable effect. |
CHILD | 1 | Child. |
LITTLE_GIRL | 2 | Little girl. |
MAN | 3 | Uncle. |
HEAVY_METAL | 4 | Heavy metal. |
COLD | 5 | Cold. |
FOREIGNER | 6 | Foreign accent. |
TRAPPED_BEAST | 7 | Trapped beast. |
FATSO | 8 | Otaku. |
STRONG_CURRENT | 9 | Strong current. |
HEAVY_MACHINERY | 10 | Heavy machinery. |
ETHEREAL | 11 | Ethereal. |
AudioReverbType
Reverb effect type
|
NONE | 0 | Disable effect. |
KTV | 1 | KTV. |
SMALL_ROOM | 2 | Small room. |
AUDITORIUM | 3 | Auditorium. |
DEEP | 4 | Deep. |
LOUD | 5 | Loud. |
METALLIC | 6 | Metallic. |
MAGNETIC | 7 | Magnetic. |
AudioEffectState
Audio effect related state data provided by AudioEffectStore
|
audioChangerType | | Voice changer state. |
audioReverbType | | Reverb state. |
isEarMonitorOpened | StateFlow<Boolean> | Ear monitor enabled. |
earMonitorVolume | StateFlow<Int> | Ear monitor volume, range 0 - 100.
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. |
Usage Example
val store = AudioEffectStore.shared()
lifecycleScope.launch {
store.audioEffectState.audioChangerType.collect { type ->
println("Current voice changer: $type")
}
}
lifecycleScope.launch {
store.audioEffectState.audioReverbType.collect { type ->
println("Current reverb: $type")
}
}
store.setAudioChangerType(AudioChangerType.LITTLE_GIRL)
store.setAudioReverbType(AudioReverbType.KTV)
store.setVoiceEarMonitorEnable(true)
store.setVoiceEarMonitorVolume(80)