AgoraAudioEffectPreset Constants Reference

Declared in AgoraEnumerates.h

AgoraAudioEffectPreset

The options for SDK preset audio effects.

Definition

typedef NS_ENUM(NSInteger, AgoraAudioEffectPreset ) {
   AgoraAudioEffectOff = 0 x00000000,
   AgoraRoomAcousticsKTV = 0 x02010100,
   AgoraRoomAcousticsVocalConcert = 0 x02010200,
   AgoraRoomAcousticsStudio = 0 x02010300,
   AgoraRoomAcousticsPhonograph = 0 x02010400,
   AgoraRoomAcousticsVirtualStereo = 0 x02010500,
   AgoraRoomAcousticsSpacial = 0 x02010600,
   AgoraRoomAcousticsEthereal = 0 x02010700,
   AgoraRoomAcoustics3DVoice = 0 x02010800,
   AgoraVoiceChangerEffectUncle = 0 x02020100,
   AgoraVoiceChangerEffectOldMan = 0 x02020200,
   AgoraVoiceChangerEffectBoy = 0 x02020300,
   AgoraVoiceChangerEffectSister = 0 x02020400,
   AgoraVoiceChangerEffectGirl = 0 x02020500,
   AgoraVoiceChangerEffectPigKing = 0 x02020600,
   AgoraVoiceChangerEffectHulk = 0 x02020700,
   AgoraStyleTransformationRnB = 0 x02030100,
   AgoraStyleTransformationPopular = 0 x02030200,
   AgoraPitchCorrection = 0 x02040100,
};

Constants

AgoraAudioEffectOff

Turn off audio effects and use the original voice.

Declared In AgoraEnumerates.h.

AgoraRoomAcousticsKTV

An audio effect typical of a KTV venue.

Note

To achieve better audio effect quality, Agora recommends calling setAudioProfile and setting the profile parameter to AgoraAudioProfileMusicHighQuality(4) or AgoraAudioProfileMusicHighQualityStereo(5) before setting this enumerator.

Declared In AgoraEnumerates.h.

AgoraRoomAcousticsVocalConcert

An audio effect typical of a concert hall.

Note

To achieve better audio effect quality, Agora recommends calling setAudioProfile and setting the profile parameter to AgoraAudioProfileMusicHighQuality(4) or AgoraAudioProfileMusicHighQualityStereo(5) before setting this enumerator.

Declared In AgoraEnumerates.h.

AgoraRoomAcousticsStudio

An audio effect typical of a recording studio.

Note

To achieve better audio effect quality, Agora recommends calling setAudioProfile and setting the profile parameter to AgoraAudioProfileMusicHighQuality(4) or AgoraAudioProfileMusicHighQualityStereo(5) before setting this enumerator.

Declared In AgoraEnumerates.h.

AgoraRoomAcousticsPhonograph

An audio effect typical of a vintage phonograph.

Note

To achieve better audio effect quality, Agora recommends calling setAudioProfile and setting the profile parameter to AgoraAudioProfileMusicHighQuality(4) or AgoraAudioProfileMusicHighQualityStereo(5) before setting this enumerator.

Declared In AgoraEnumerates.h.

AgoraRoomAcousticsVirtualStereo

A virtual stereo effect that renders monophonic audio as stereo audio.

Note

Call setAudioProfile and set the profile parameter to AgoraAudioProfileMusicStandardStereo(3) or AgoraAudioProfileMusicHighQualityStereo(5) before setting this enumerator; otherwise, the enumerator setting does not take effect.

Declared In AgoraEnumerates.h.

AgoraRoomAcousticsSpacial

A more spatial audio effect.

Note

To achieve better audio effect quality, Agora recommends calling setAudioProfile and setting the profile parameter to AgoraAudioProfileMusicHighQuality(4) or AgoraAudioProfileMusicHighQualityStereo(5) before setting this enumerator.

Declared In AgoraEnumerates.h.

AgoraRoomAcousticsEthereal

A more ethereal audio effect.

Note

To achieve better audio effect quality, Agora recommends calling setAudioProfile and setting the profile parameter to AgoraAudioProfileMusicHighQuality(4) or AgoraAudioProfileMusicHighQualityStereo(5) before setting this enumerator.

Declared In AgoraEnumerates.h.

AgoraRoomAcoustics3DVoice

A 3D voice effect that makes the voice appear to be moving around the user. The default cycle period of the 3D voice effect is 10 seconds. To change the cycle period, call setAudioEffectParameters after this method.

Note

  • Call setAudioProfile and set the profile parameter to AgoraAudioProfileMusicStandardStereo(3) or AgoraAudioProfileMusicHighQualityStereo(5) before setting this enumerator; otherwise, the enumerator setting does not take effect.
  • If the 3D voice effect is enabled, users need to use stereo audio playback devices to hear the anticipated voice effect.

    • Declared In AgoraEnumerates.h.

    AgoraVoiceChangerEffectUncle

    The voice of a middle-aged man.

    Note

  • Agora recommends using this enumerator to process a male-sounding voice; otherwise, you may not hear the anticipated voice effect.
  • To achieve better audio effect quality, Agora recommends calling setAudioProfile and setting the profile parameter to AgoraAudioProfileMusicHighQuality(4) or AgoraAudioProfileMusicHighQualityStereo(5) before setting this enumerator.

    • Declared In AgoraEnumerates.h.

    AgoraVoiceChangerEffectOldMan

    The voice of an old man.

    Note

  • Agora recommends using this enumerator to process a male-sounding voice; otherwise, you may not hear the anticipated voice effect.
  • To achieve better audio effect quality, Agora recommends calling setAudioProfile and setting the profile parameter to AgoraAudioProfileMusicHighQuality(4) or AgoraAudioProfileMusicHighQualityStereo(5) before setting this enumerator.

    • Declared In AgoraEnumerates.h.

    AgoraVoiceChangerEffectBoy

    The voice of a boy.

    Note

  • Agora recommends using this enumerator to process a male-sounding voice; otherwise, you may not hear the anticipated voice effect.
  • To achieve better audio effect quality, Agora recommends calling setAudioProfile and setting the profile parameter to AgoraAudioProfileMusicHighQuality(4) or AgoraAudioProfileMusicHighQualityStereo(5) before setting this enumerator.

    • Declared In AgoraEnumerates.h.

    AgoraVoiceChangerEffectSister

    The voice of a young woman.

    Note

  • Agora recommends using this enumerator to process a female-sounding voice; otherwise, you may not hear the anticipated voice effect.
  • To achieve better audio effect quality, Agora recommends calling setAudioProfile and setting the profile parameter to AgoraAudioProfileMusicHighQuality(4) or AgoraAudioProfileMusicHighQualityStereo(5) before setting this enumerator.

    • Declared In AgoraEnumerates.h.

    AgoraVoiceChangerEffectGirl

    The voice of a girl.

    Note

  • Agora recommends using this enumerator to process a female-sounding voice; otherwise, you may not hear the anticipated voice effect.
  • To achieve better audio effect quality, Agora recommends calling setAudioProfile and setting the profile parameter to AgoraAudioProfileMusicHighQuality(4) or AgoraAudioProfileMusicHighQualityStereo(5) before setting this enumerator.

    • Declared In AgoraEnumerates.h.

    AgoraVoiceChangerEffectPigKing

    The voice of Pig King, a character in Journey to the West who has a voice like a growling bear.

    Note

    To achieve better audio effect quality, Agora recommends calling setAudioProfile and setting the profile parameter to AgoraAudioProfileMusicHighQuality(4) or AgoraAudioProfileMusicHighQualityStereo(5) before setting this enumerator.

    Declared In AgoraEnumerates.h.

    AgoraVoiceChangerEffectHulk

    The voice of Hulk.

    Note

    To achieve better audio effect quality, Agora recommends calling setAudioProfile and setting the profile parameter to AgoraAudioProfileMusicHighQuality(4) or AgoraAudioProfileMusicHighQualityStereo(5) before setting this enumerator.

    Declared In AgoraEnumerates.h.

    AgoraStyleTransformationRnB

    An audio effect typical of R&B music.

    Note

    Call setAudioProfile and set the profile parameter to AgoraAudioProfileMusicHighQuality(4) or AgoraAudioProfileMusicHighQualityStereo(5) before setting this enumerator; otherwise, the enumerator setting does not take effect.

    Declared In AgoraEnumerates.h.

    AgoraStyleTransformationPopular

    An audio effect typical of popular music.

    Note

    Call setAudioProfile and set the profile parameter to AgoraAudioProfileMusicHighQuality(4) or AgoraAudioProfileMusicHighQualityStereo(5) before setting this enumerator; otherwise, the enumerator setting does not take effect.

    Declared In AgoraEnumerates.h.

    AgoraPitchCorrection

    A pitch correction effect that corrects the user’s pitch based on the pitch of the natural C major scale. To change the basic mode and tonic pitch, call setAudioEffectParameters after this method.

    Note

    To achieve better audio effect quality, Agora recommends calling setAudioProfile and setting the profile parameter to AgoraAudioProfileMusicHighQuality(4) or AgoraAudioProfileMusicHighQualityStereo(5) before setting this enumerator.

    Declared In AgoraEnumerates.h.

    Declared In

    AgoraEnumerates.h