zego-api-audio-processing.h

Go to the documentation of this file.

#ifndef zego_api_audio_processing_h
#define zego_api_audio_processing_h
 
namespace ZEGO
{
    namespace AUDIOPROCESSING
    {
        enum ZegoAVAPIAudioReverbMode
        {
            ZEGO_AUDIO_REVERB_MODE_SOFT_ROOM = 0,
            ZEGO_AUDIO_REVERB_MODE_WARM_CLUB = 1,
            ZEGO_AUDIO_REVERB_MODE_CONCERT_HALL = 2,
            ZEGO_AUDIO_REVERB_MODE_LARGE_AUDITORIUM = 3,
        };
 
        enum ZegoAVAPIVoiceReverbType
        {
            ZEGO_AUDIO_REVERB_TYPE_OFF = 0,
            ZEGO_AUDIO_REVERB_TYPE_SOFT_ROOM = 1,
            ZEGO_AUDIO_REVERB_TYPE_WARM_CLUB = 2,
            ZEGO_AUDIO_REVERB_TYPE_CONCERT_HALL = 3,
            ZEGO_AUDIO_REVERB_TYPE_LARGE_AUDITORIUM = 4,
            ZEGO_AUDIO_REVERB_TYPE_RECORDING_STUDIO = 5,
            ZEGO_AUDIO_REVERB_TYPE_BASEMENT = 6,
            ZEGO_AUDIO_REVERB_TYPE_KTV = 7,
            ZEGO_AUDIO_REVERB_TYPE_POPULAR = 8,
            ZEGO_AUDIO_REVERB_TYPE_ROCK = 9,
            ZEGO_AUDIO_REVERB_TYPE_VOCAL_CONCERT = 10,
            ZEGO_AUDIO_REVERB_TYPE_HIPHOP = 11,
            ZEGO_AUDIO_REVERB_TYPE_MISTY = 12,
            ZEGO_AUDIO_REVERB_TYPE_3DVOICE = 13,
            ZEGO_AUDIO_REVERB_TYPE_GRAMOPHONE = 14,
            ZEGO_AUDIO_REVERB_TYPE_KTV2 = 15,
            ZEGO_AUDIO_REVERB_TYPE_ROCK2 = 16,
            ZEGO_AUDIO_REVERB_TYPE_MISTY2 = 17,
 
        };
 
        enum ZegoAVAPIVoiceChangerType
        {
            ZEGO_VOICE_CHANGER_TYPE_CHANGER_OFF = 0,
            ZEGO_VOICE_CHANGER_TYPE_OPTIMUS_PRIME = 1,
            ZEGO_VOICE_CHANGER_TYPE_AI_ROBOT = 2,
            ZEGO_VOICE_CHANGER_TYPE_FOREIGNER = 3,
            ZEGO_VOICE_CHANGER_TYPE_ELUSIVE = 4,
            ZEGO_VOICE_CHANGER_TYPE_MALE_MAGNETIC = 5,
            ZEGO_VOICE_CHANGER_TYPE_FEMALE_FRESH = 6,
            ZEGO_VOICE_CHANGER_TYPE_MEN_TO_CHILD = 7,
            ZEGO_VOICE_CHANGER_TYPE_MEN_TO_WOMEN = 8,
            ZEGO_VOICE_CHANGER_TYPE_WOMEN_TO_CHILD = 9,
            ZEGO_VOICE_CHANGER_TYPE_WOMEN_TO_MEN = 10,
            ZEGO_VOICE_CHANGER_TYPE_FEMALE_ENERGETIC = 11,
            ZEGO_VOICE_CHANGER_TYPE_RICHNESS = 12,
            ZEGO_VOICE_CHANGER_TYPE_MUFFLED = 13,
            ZEGO_VOICE_CHANGER_TYPE_ROUNDNESS = 14,
            ZEGO_VOICE_CHANGER_TYPE_DICTIONARIES = 15,
            ZEGO_VOICE_CHANGER_TYPE_FULLNESS = 16,
            ZEGO_VOICE_CHANGER_TYPE_CLEAR = 17,
            ZEGO_VOICE_CHANGER_TYPE_HIGHLY_RESONANT = 18,
            ZEGO_VOICE_CHANGER_TYPE_LOUD_CLEAR = 19,
            ZEGO_VOICE_CHANGER_TYPE_MINIONS = 20,
            ZEGO_VOICE_CHANGER_TYPE_MAJOR_C = 21,
            ZEGO_VOICE_CHANGER_TYPE_MINOR_A = 22,
            ZEGO_VOICE_CHANGER_TYPE_HARMONIC_MINOR = 23,
            ZEGO_VOICE_CHANGER_TYPE_SUNSHINE = 24,
            ZEGO_VOICE_CHANGER_TYPE_GENTLE = 25,
            ZEGO_VOICE_CHANGER_TYPE_SWEET = 26,
            ZEGO_VOICE_CHANGER_TYPE_SWEET_MALE = 27,
            ZEGO_VOICE_CHANGER_TYPE_SWEET_FEMAIL = 28,
            ZEGO_VOICE_CHANGER_TYPE_BRIGHT = 29,
            ZEGO_VOICE_CHANGER_TYPE_AUTOBOT = 30,
            ZEGO_VOICE_CHANGER_TYPE_OUT_OF_POWER = 31
        };
 
        enum ZegoAVAPIElectronicEffectsMode
        {
            ZEGO_ELECTRONIC_EFFECTS_MODE_MAJOR = 0,
            ZEGO_ELECTRONIC_EFFECTS_MODE_MINOR = 1,
            ZEGO_ELECTRONIC_EFFECTS_MODE_HARMONIC_MINOR = 2
        };
 
        extern const float ZEGO_VOICE_CHANGER_NONE;
        
        extern const float ZEGO_VOICE_CHANGER_WOMEN_TO_MEN;
 
        extern const float ZEGO_VOICE_CHANGER_MEN_TO_WOMEN;
 
        extern const float ZEGO_VOICE_CHANGER_WOMEN_TO_CHILD;
 
        extern const float ZEGO_VOICE_CHANGER_MEN_TO_CHILD;
        
        struct ZegoAVAPIReverbParams
        {
            float roomSize;
            
            float reverberance;
            
            float damping;
            
            float dryWetRatio;
 
            ZegoAVAPIReverbParams()
            {
                roomSize = 0;
                reverberance = 0;
                damping = 0;
                dryWetRatio = 0;
            }
        };
 
        struct ZegoAVAPIAdvancedReverbParams
        {
            float roomSize;
            float preDelay;
            float reverberance;
            float hfDamping;
            float toneLow;
            float toneHigh;
            float wetGain;
            float dryGain;
            float stereoWidth;
            bool  wetOnly;
 
            ZegoAVAPIAdvancedReverbParams()
            {
                roomSize = 0;
                preDelay = 0;
                reverberance = 0;
                hfDamping = 0;
                toneLow = 0;
                toneHigh = 0;
                wetGain = 0;
                dryGain = 0;
                stereoWidth = 0;
                wetOnly = false;
            }
        };
 
        struct ZegoAVAPIReverbEchoParams
        {
            int    numDelays;
 
            float  inGain;
 
            float  outGain;
 
            int    delay[7];
 
            float  decay[7];
        };
        
        ZEGOAVKIT_API bool EnableVirtualStereo(bool bEnable, int angle);
    
        ZEGOAVKIT_API bool EnableReverb(bool bEnable, ZegoAVAPIAudioReverbMode mode);
        
        ZEGOAVKIT_API bool SetReverbParam(float roomSize, float dryWetRatio);
        
        
        ZEGOAVKIT_API bool SetReverbParam(ZegoAVAPIReverbParams params);
 
        ZEGOAVKIT_API bool SetAdvancedReverbParam(bool bEnable, ZegoAVAPIAdvancedReverbParams config);
 
        ZEGOAVKIT_API bool SetReverbPreset(ZegoAVAPIVoiceReverbType type);
        
        ZEGOAVKIT_API bool SetVoiceChangerParam(float param);
 
        ZEGOAVKIT_API bool SetReverbEchoParam(ZegoAVAPIReverbEchoParams params);
    
        ZEGOAVKIT_API bool SetVoicePreset(ZegoAVAPIVoiceChangerType type);
 
        ZEGOAVKIT_API bool SetAudioEqualizerGain(int bandIndex, float bandGain);
 
        ZEGOAVKIT_API bool SetElectronicEffects(bool enable, ZegoAVAPIElectronicEffectsMode mode, int tonal);
 
        ZEGOAVKIT_API bool EnableSpeechEnhance(bool enable, int level);
    }
}
 
#endif /* zego_api_audio_processing_h */