AudioEffectPreset

Preset audio effect options.

setAudioProfile profile Preset audio effects profile
  • RoomAcousticsVirtualStereo
  • RoomAcoustics3dVoice
  • RoomAcousticsVirtualSurroundSound
AudioProfileMusicHighQualityStereo or AudioProfileMusicStandardStereoOther preset effects (excluding AudioEffectOff)AudioProfileMusicHighQuality or AudioProfileMusicHighQualityStereo

Enumerations

AudioEffectOff
Original sound, disables voice effects.
RoomAcousticsKtv
KTV.
RoomAcousticsVocalConcert
Concert.
RoomAcousticsStudio
Studio.
RoomAcousticsPhonograph
Phonograph.
RoomAcousticsVirtualStereo
Virtual stereo, where the SDK renders mono audio into stereo effect.
RoomAcousticsSpacial
Spacious.
RoomAcousticsEthereal
Ethereal.
RoomAcousticsVirtualSurroundSound
Virtual surround sound, where the SDK generates a simulated surround sound field based on stereo to create a surround effect.
Note: To hear the expected effect, users must use audio playback devices that support stereo when virtual surround sound is enabled.
RoomAcousticsChorus
Chorus. Recommended by Agora for chorus scenarios to enhance vocal spatiality.
RoomAcoustics3dVoice
3D voice, where the SDK renders audio to surround the user. The default surround cycle is 10 seconds. After setting this effect, you can also call setAudioEffectParameters to modify the surround cycle.
Note: To hear the expected effect, users must use audio playback devices that support stereo when 3D voice is enabled.
VoiceChangerEffectUncle
Deep male voice.
Note: Recommended for processing male voices; otherwise, the effect may not be as expected.
VoiceChangerEffectOldman
Elderly male.
Note: Recommended for processing male voices; otherwise, the effect may not be as expected.
VoiceChangerEffectBoy
Boy.
Note: Recommended for processing male voices; otherwise, the effect may not be as expected.
VoiceChangerEffectSister
Young woman.
Note: Recommended for processing female voices; otherwise, the effect may not be as expected.
VoiceChangerEffectGirl
Girl.
Note: Recommended for processing female voices; otherwise, the effect may not be as expected.
VoiceChangerEffectPigking
Pig King.
VoiceChangerEffectHulk
Hulk.
StyleTransformationRnb
R&B.
StyleTransformationPopular
Pop.
PitchCorrection
Auto-tune, where the SDK corrects the actual pitch based on a natural major scale with C as the tonic. After setting this effect, you can also call setAudioEffectParameters to adjust the base scale and tonic pitch.