AudioEffectPreset

Preset audio effects.

To get better audio effects, Agora recommends calling setAudioProfile and setting the profile parameter as recommended below before using the preset audio effects.


Preset audio effects	profile
RoomAcousticsVirtualStereo RoomAcoustics3dVoice RoomAcousticsVirtualSurroundSound	AudioProfileMusicHighQualityStereo or AudioProfileMusicStandardStereo
Other preset audio effects (except for AudioEffectOff)	AudioProfileMusicHighQuality or AudioProfileMusicHighQualityStereo

Enumerator

AudioEffectOff: Turn off voice effects, that is, use the original voice.
RoomAcousticsKtv: The voice effect typical of a KTV venue.
RoomAcousticsVocalConcert: The voice effect typical of a concert hall.
RoomAcousticsStudio: The voice effect typical of a recording studio.
RoomAcousticsPhonograph: The voice effect typical of a vintage phonograph.
RoomAcousticsVirtualStereo: The virtual stereo effect, which renders monophonic audio as stereo audio.
RoomAcousticsSpacial: A more spatial voice effect.
RoomAcousticsEthereal: A more ethereal voice effect.
RoomAcousticsVirtualSurroundSound: Virtual surround sound, that is, the SDK generates a simulated surround sound field on the basis of stereo channels, thereby creating a surround sound effect.
Attention: If the virtual surround sound is enabled, users need to use stereo audio playback devices to hear the anticipated audio effect.
RoomAcousticsChorus: The audio effect of chorus. Agora recommends using this effect in chorus scenarios to enhance the sense of depth and dimension in the vocals.
RoomAcoustics3dVoice: A 3D voice effect that makes the voice appear to be moving around the user. The default cycle period is 10 seconds. After setting this effect, you can call setAudioEffectParameters to modify the movement period.

Attention: If the 3D voice effect is enabled, users need to use stereo audio playback devices to hear the anticipated voice effect.
VoiceChangerEffectUncle: A middle-aged man's voice.

Attention: Agora recommends using this preset to process a male-sounding voice; otherwise, you may not hear the anticipated voice effect.
VoiceChangerEffectOldman: An older man's voice.

Attention: Agora recommends using this preset to process a male-sounding voice; otherwise, you may not hear the anticipated voice effect.
VoiceChangerEffectBoy: A boy's voice.

Attention: Agora recommends using this preset to process a male-sounding voice; otherwise, you may not hear the anticipated voice effect.
VoiceChangerEffectSister: A young woman's voice.

Attention: Agora recommends using this preset to process a female-sounding voice; otherwise, you may not hear the anticipated voice effect.
VoiceChangerEffectGirl: A girl's voice.

Attention: Agora recommends using this preset to process a female-sounding voice; otherwise, you may not hear the anticipated voice effect.
VoiceChangerEffectPigking: The voice of Pig King, a character in Journey to the West who has a voice like a growling bear.
VoiceChangerEffectHulk: The Hulk's voice.
StyleTransformationRnb: The voice effect typical of R&B music.
StyleTransformationPopular: The voice effect typical of popular music.
PitchCorrection: A pitch correction effect that corrects the user's pitch based on the pitch of the natural C major scale. After setting this voice effect, you can call setAudioEffectParameters to adjust the basic mode of tuning and the pitch of the main tone.