setLocalVoiceFormant abstract method

Future<void> setLocalVoiceFormant(
  1. double formantRatio
)

Sets the formant ratio to change the voice timbre.

Formant ratio is a parameter that affects the timbre of the voice. The smaller the formant ratio, the deeper the voice; the larger the value, the sharper the voice. After setting the formant ratio, all users in the channel can hear the effect. If you want to change both timbre and pitch, Agora recommends using it together with setLocalVoicePitch.

  • formantRatio Formant ratio. The range is -1.0, 1.0. The default value is 0.0, meaning the original timbre is not changed. Agora recommends using values in the range -0.4, 0.6. Effects outside this range may not sound ideal.

Returns When the method call succeeds, there is no return value; when fails, the AgoraRtcException exception is thrown. You need to catch the exception and handle it accordingly. See Error Codes for details and resolution suggestions.

Implementation

Future<void> setLocalVoiceFormant(double formantRatio);