AudioEffectPreset

Preset audio effect options.

setAudioProfile profile Preset audio effects profile
  • roomAcousticsVirtualStereo
  • roomAcoustics3dVoice
  • roomAcousticsVirtualSurroundSound
audioProfileMusicHighQualityStereo or audioProfileMusicStandardStereoOther preset audio effects (excluding audioEffectOff)audioProfileMusicHighQuality or audioProfileMusicHighQualityStereo

Enumerations

audioEffectOff
Original sound, i.e., disables voice effects.
roomAcousticsKtv
KTV.
roomAcousticsVocalConcert
Concert.
roomAcousticsStudio
Studio.
roomAcousticsPhonograph
Phonograph.
roomAcousticsVirtualStereo
Virtual stereo, where the SDK renders mono audio into stereo sound.
roomAcousticsSpacial
Spacious.
roomAcousticsEthereal
Ethereal.
roomAcousticsVirtualSurroundSound
Virtual surround sound, where the SDK simulates surround sound based on stereo channels to create an immersive effect.
Note: To experience the expected effect of virtual surround sound, users need to use audio playback devices that support stereo.
roomAcousticsChorus
Chorus. Agora recommends using this in chorus scenarios to make vocals sound more spatial and three-dimensional.
roomAcoustics3dVoice
3D voice, where the SDK renders audio to surround the user. The surround cycle defaults to 10 seconds. After setting this effect, you can also call setAudioEffectParameters to modify the surround cycle.
Note: To experience the expected effect of 3D voice, users need to use audio playback devices that support stereo.
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
Pigsy.
voiceChangerEffectHulk
Hulk.
styleTransformationRnb
R&B.
styleTransformationPopular
Pop.
pitchCorrection
Electronic voice, where the SDK corrects the pitch based on the 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.