setVoiceBeautifierPreset method

@override Future<void> setVoiceBeautifierPreset(VoiceBeautifierPreset preset)

Sets an SDK preset voice beautifier effect.

Since v3.2.1

Call this method to set an SDK preset voice beautifier effect for the local user who sends an audio stream. After setting a voice beautifier effect, all users in the channel can hear the effect.

You can set different voice beautifier effects for different scenarios. See Set the Voice Beautifier and Audio Effects.

To achieve better audio effect quality, Agora recommends calling RtcEngine.setAudioProfile and setting the scenario parameter to GameStreaming(3) and the profile parameter to MusicHighQuality(4) or MusicHighQualityStereo(5) before calling this method.

Note

• You can call this method either before or after joining a channel.
• Do not set the profile parameter of setAudioProfile to SpeechStandard(1); otherwise, this method call fails.
• This method works best with the human voice. Agora does not recommend using this method for audio containing music.
• After calling this method, Agora recommends not calling the following methods, because they can override setVoiceBeautifierPreset:
  • RtcEngine.setAudioEffectPreset
  • RtcEngine.setAudioEffectParameters
  • RtcEngine.setLocalVoiceReverbPreset
  • RtcEngine.setLocalVoiceChanger
  • RtcEngine.setLocalVoicePitch
  • RtcEngine.setLocalVoiceEqualization
  • RtcEngine.setLocalVoiceReverb

Parameter preset The options for SDK preset voice beautifier effects. See VoiceBeautifierPreset.

Implementation

@override
Future<void> setVoiceBeautifierPreset(VoiceBeautifierPreset preset) {
  return _invokeMethod('setVoiceBeautifierPreset', {
    'preset': VoiceBeautifierPresetConverter(preset).value(),
  });
}