NertcBase.h

浏览该文件的文档.

#ifndef NertcBase_h
#define NertcBase_h
 
#pragma once
 
#include "CoreMinimal.h"
 
#if defined(_WIN32)
#ifndef WIN32_LEAN_AND_MEAN
#define WIN32_LEAN_AND_MEAN
#endif
#include <windows.h>
#define NERTC_PLUGIN_CALL __cdecl
#define NERTC_PLUGIN_API  __declspec(dllexport)
#elif defined(__APPLE__) || defined(__ANDROID__) || defined(__linux__)
#define NERTC_PLUGIN_API  __attribute__((visibility("default")))
#define NERTC_PLUGIN_CALL
#else
#define NERTC_PLUGIN_API  
#define NERTC_PLUGIN_CALL
#endif
 
 
 
namespace nertc {
namespace wwiseplugin {
 
    #define kWWISEPLUGINMaxDeviceIDLength 256
    #define kWWISEPLUGINMaxDeviceNameLength 256
 
    class NERTC_PLUGIN_API RtcConstants
    {
    public:
        static constexpr const char* kNERtcKeyRecordHostEnabled = "record_host_enabled";
        static constexpr const char* kNERtcKeyRecordAudioEnabled = "record_audio_enabled";
        static constexpr const char* kNERtcKeyRecordType = "record_type";
        static constexpr const char* kNERtcKeyLogLevel = "log_level";
        static constexpr const char* kNERtcKeyAudioProcessingAECEnable = "audio_processing_aec_enable";
        static constexpr const char* kNERtcKeyAudioAECLowLevelEnable = "audio_aec_low_level_enable";
        static constexpr const char* kNERtcKeyAudioProcessingAGCEnable = "audio_processing_agc_enable";
        static constexpr const char* kNERtcKeyAudioProcessingNSEnable = "audio_processing_ns_enable";
        static constexpr const char* kNERtcKeyAudioProcessingAINSEnable = "audio_processing_ai_ns_enable";
        static constexpr const char* kNERtcKeyAudioProcessingExternalAudioMixEnable = "audio_processing_external_audiomix_enable";
        static constexpr const char* kNERtcKeyAudioProcessingEarphone = "audio_processing_earphone";
        static constexpr const char* kNERtcKeyAudioDeviceAutoSelectType = "audio_device_auto_select_type";
        static constexpr const char* kNERtcKeyEnableReportVolumeWhenMute = "enable_report_volume_when_mute";
        static constexpr const char* kNERtcKeyDisableOverrideSpeakerOnReceiver = "disable_override_speaker_on_receiver";
        static constexpr const char* kNERtcKeyDisableSWAECOnHeadset = "disable_sw_aec_on_headset";
        static constexpr const char* kNERtcKeyEnableAudioBluetoothSCO = "enable_audio_bluetooth_sco";
        static constexpr const char* kNERtcAudioDeviceAutoID = "nertc-audio-device-auto";
    };
  
    enum RtcLogLevel {
        kWWISEPLUGINLevelFatal = 0,
        kWWISEPLUGINLevelError = 1,
        kWWISEPLUGINLevelWarning = 2,
        kWWISEPLUGINLevelInfo = 3,
        kWWISEPLUGINLevelDetailInfo = 4,
        kWWISEPLUGINLevelVerbos = 5,
        kWWISEPLUGINLevelDebug = 6,
        kWWISEPLUGINLevelOff = 7,
    };
    
    enum RtcConnectionStateType {
    kWWISEPLUGINConnectionStateDisconnected = 1,
    kWWISEPLUGINConnectionStateConnecting = 2,
    kWWISEPLUGINConnectionStateConnected = 3,
    kWWISEPLUGINConnectionStateReconnecting = 4,
    kWWISEPLUGINConnectionStateFailed = 5,
    };
 
    enum RtcReasonConnectionChangedType {
    kWWISEPLUGINReasonConnectionChangedLeaveChannel = 1,
    kWWISEPLUGINReasonConnectionChangedChannelClosed = 2,
    kWWISEPLUGINReasonConnectionChangedBeKicked = 3,
    kWWISEPLUGINReasonConnectionChangedTimeOut = 4,
    kWWISEPLUGINReasonConnectionChangedJoinChannel = 5,
    kWWISEPLUGINReasonConnectionChangedJoinSucceed = 6,
    kWWISEPLUGINReasonConnectionChangedReJoinSucceed = 7,
    kWWISEPLUGINReasonConnectionChangedMediaConnectionDisconnected = 8,
    kWWISEPLUGINReasonConnectionChangedSignalDisconnected = 9,
    kWWISEPLUGINReasonConnectionChangedRequestChannelFailed = 10,
    kWWISEPLUGINReasonConnectionChangedJoinChannelFailed = 11,
    kWWISEPLUGINReasonConnectionChangedReDispatch = 12,
    kWWISEPLUGINReasonConnectionChangedSettingProxyServer = 13
    };
    enum RtcNetworkType {
        kWWISEPLUGINNetworkTypeUnknown = 0,
        kWWISEPLUGINNetworkTypeEthernet,
        kWWISEPLUGINNetworkTypeWifi,
        kWWISEPLUGINNetworkType2G,
        kWWISEPLUGINNetworkType3G,
        kWWISEPLUGINNetworkType4G,
        kWWISEPLUGINNetworkType5G,
        kWWISEPLUGINNetworkTypeWWAN,
        kWWISEPLUGINNetworkTypeBluetooth,
        kWWISEPLUGINNetworkTypeNone
    };
    
    enum RtcClientRole {        
        kWWISEPLUGINClientRoleBroadcaster = 0,
        kWWISEPLUGINClientRoleAudience = 1,
    };
 
    enum RtcRangeAudioMode {
        kWWISEPLUGINRangeAudioModeNone = -1,
        kWWISEPLUGINRangeAudioModeDefault = 0,
        kWWISEPLUGINRangeAudioModeTeam = 1,
    };
 
    enum RtcAudioProfileType {
        kWWISEPLUGINAudioProfileDefault = 0,
        kWWISEPLUGINAudioProfileStandard = 1,
        kWWISEPLUGINAudioProfileStandardExtend = 2,
        kWWISEPLUGINAudioProfileMiddleQuality = 3,
        kWWISEPLUGINAudioProfileMiddleQualityStereo = 4,
        kWWISEPLUGINAudioProfileHighQuality = 5,
        kWWISEPLUGINAudioProfileHighQualityStereo = 6,
    };
    enum RtcAudioScenarioType {
        kWWISEPLUGINAudioScenarioDefault = 0,
        kWWISEPLUGINAudioScenarioSpeech = 1,
        kWWISEPLUGINAudioScenarioMusic = 2,
        kWWISEPLUGINAudioScenarioChatroom = 3,
    };
    struct NERTC_PLUGIN_API RtcAudioVolumeInfo {
        uint64_t uid;
        unsigned int volume;
        unsigned int substreamVolume;
    };
 
    enum RtcAudioDumpType {
        kWWISEPLUGINAudioDumpTypePCM = 0,
        kWWISEPLUGINAudioDumpTypeAll = 1,
        kWWISEPLUGINAudioDumpTypeWAV = 2
    };
 
    enum RtcErrorCode {
        kWWISEPLUGINNoError = 0,        
        //Error codes are returned when resources are wrongly assigned. Such kind of error code is not returned when the SDK sends the normal permissions.
        kWWISEPLUGINErrChannelReservePermissionDenied = 403,    
        kWWISEPLUGINErrChannelReserveTimeOut = 408,         
        kWWISEPLUGINErrChannelReserveErrorParam = 414,
        kWWISEPLUGINErrChannelReserveErrorAppKey = 417,
        kWWISEPLUGINErrChannelReserveServerFail = 500,      
        kWWISEPLUGINErrChannelReserveMoreThanTwoUser = 600,
        kWWISEPLUGINErrChannelNoPublishPermission = 1620,
        kWWISEPLUGINErrChannelNoSubscribePermission = 2803,
        kWWISEPLUGINErrServerPersonsInRoomReachedTheLimit = 4003,
        
        kWWISEPLUGINErrFatal = 30001,
        kWWISEPLUGINErrOutOfMemory = 30002,
        kWWISEPLUGINErrInvalidParam = 30003,
        kWWISEPLUGINErrNotSupported = 30004,
        kWWISEPLUGINErrInvalidState = 30005,
        kWWISEPLUGINErrLackOfResource = 30006,
        kWWISEPLUGINErrInvalidIndex = 30007,
        kWWISEPLUGINErrDeviceNotFound = 30008,
        kWWISEPLUGINErrInvalidDeviceSourceID = 30009,
        kWWISEPLUGINErrInvalidVideoProfile = 30010,
        kWWISEPLUGINErrCreateDeviceSourceFail = 30011,
        kWWISEPLUGINErrInvalidRender = 30012,
        kWWISEPLUGINErrDevicePreviewAlreadyStarted = 30013,
        kWWISEPLUGINErrTransmitPendding = 30014,
        kWWISEPLUGINErrConnectFail = 30015,
        kWWISEPLUGINErrDeviceOccupied             = 30027,
        kWWISEPLUGINErrChannelAlreadyJoined = 30100,
        kWWISEPLUGINErrChannelNotJoined = 30101,
        kWWISEPLUGINErrChannelRepleatedlyLeave = 30102,
        kWWISEPLUGINErrRequestJoinChannelFail = 30103,
        kWWISEPLUGINErrSessionNotFound = 30104,
        kWWISEPLUGINErrUserNotFound = 30105,
        kWWISEPLUGINErrInvalidUserID = 30106,
        kWWISEPLUGINErrMediaNotStarted = 30107,
        kWWISEPLUGINErrSourceNotFound = 30108,
        kWWISEPLUGINErrConnectionNotFound = 30200,
        kWWISEPLUGINErrStreamNotFound = 30201,
        kWWISEPLUGINErrAddTrackFail = 30202,
        kWWISEPLUGINErrTrackNotFound = 30203,
        kWWISEPLUGINErrMediaConnectionDisconnected = 30204, 
        kWWISEPLUGINErrSignalDisconnected = 30205,          
        kWWISEPLUGINErrServerKicked = 30206,                
        kWWISEPLUGINErrKickedForRoomClosed = 30207,
        kWWISEPLUGINErrChannelLeaveBySwitchAction = 30208,
        kWWISEPLUGINErrChannelLeaveByDuplicateUidLogin = 30209,
        
        kWWISEPLUGINErrPTTAuthorizeFailed = 31001,
        kWWISEPLUGINErrPTTAuthNetError = 31002,
        kWWISEPLUGINErrPTTAuthTimeOut = 31003,
        kWWISEPLUGINErrPTTRecordingAreadyStarted = 31011,
        kWWISEPLUGINErrPTTRecordingOpenFileFailed = 31012,
        kWWISEPLUGINErrPTTRecordingDurationTooShort = 31013,
        kWWISEPLUGINErrPTTRecordingNotStarted = 31014,
        kWWISEPLUGINErrPTTPlayOpenFileFailed = 31021,
        kWWISEPLUGINErrPTTPlayReadFileFailed = 31022,
        kWWISEPLUGINErrPTTPlayNotStarted = 31023,
        kWWISEPLUGINErrPTTUploadOpenFileFailed = 31031,
        kWWISEPLUGINErrPTTUploadFileTooLarge = 31032,
        kWWISEPLUGINErrPTTUploadAuthFailed = 31033,
        kWWISEPLUGINErrPTTUploadNetError = 31034,
        kWWISEPLUGINErrPTTUploadDataError = 31035,
        kWWISEPLUGINErrPTTDownloadOpenFileFailed = 31041,
        kWWISEPLUGINErrPTTDownloadAuthFailed = 31042,
        kWWISEPLUGINErrPTTDownloadNetError = 31043,
        kWWISEPLUGINErrPTTDownloadNotFound = 31044,
        kWWISEPLUGINErrPTTDownloadDataError = 31045,
        kWWISEPLUGINErrPTTDownloadAuditing = 31046,
        kWWISEPLUGINErrPTTDownloadAuditFailed = 31047,    
        kWWISEPLUGINErrPTTSTTAuthFailed = 31051,
        kWWISEPLUGINErrPTTSTTNetError = 31052,
        kWWISEPLUGINErrPTTSTTTranslateFaild = 31053,
        kWWISEPLUGINErrPTTSTTNotFound = 31054,
        kWWISEPLUGINErrPTTSTTDataError = 31055,
        kWWISEPLUGINErrPTTSTTAuditing = 31056,
        kWWISEPLUGINErrPTTSTTAuditFailed = 31057,    
        kWWISEPLUGINRuntimeErrADMNoAuthorize = 40000,
        kWWISEPLUGINRuntimeErrADMInitRecording        = 40001,
        kWWISEPLUGINRuntimeErrADMStartRecording       = 40002,
        kWWISEPLUGINRuntimeErrADMStopRecording        = 40003,
        kWWISEPLUGINRuntimeErrADMInitPlayout          = 40004,
        kWWISEPLUGINRuntimeErrADMStartPlayout         = 40005,
        kWWISEPLUGINRuntimeErrADMStopPlayout          = 40006,
        
        kWWISEPLUGINRuntimeErrADMRecordingFailed = 40007,
        kWWISEPLUGINRuntimeErrADMPlayoutFailed = 40008,
    };
 
    enum RtcVoiceAuditStatus {
        kkWWISEPLUGINVoiceAuditUnkonwn = -1,
        kkWWISEPLUGINVoiceAuditing = 0,
        kkWWISEPLUGINVoiceAuditFinished = 1,
        kkWWISEPLUGINVoiceAuditServerError = 2,
        kkWWISEPLUGINVoiceAuditUnactivated = 3,
    };
 
    enum RtcAudioStreamType {
        kWWISEPLUGINAudioStreamTypeMain = 0,
 
        kWWISEPLUGINAudioStreamTypeSub = 1,
    };
 
    enum RtcAudioOutputRouting {
        kWWISEPLUGINAudioOutputRoutingDefault = 0,
        kWWISEPLUGINAudioOutputRoutingHeadset,
        kWWISEPLUGINAudioOutputRoutingEarpiece,
        kWWISEPLUGINAudioOutputRoutingLoudspeaker,
        kWWISEPLUGINAudioOutputRoutingBluetooth,
    };
 
    enum RtcAudioDeviceTransportType {
        kWWISEPLUGINAudioDeviceTransportTypeUnknown = 0,
        kWWISEPLUGINAudioDeviceTransportTypeBluetooth = 1,
        kWWISEPLUGINAudioDeviceTransportTypeBluetoothA2DP = 2,
        kWWISEPLUGINAudioDeviceTransportTypeBluetoothLE = 3,
        kWWISEPLUGINAudioDeviceTransportTypeUSB = 4,
        kWWISEPLUGINAudioDeviceTransportTypeHDMI = 5,
        kWWISEPLUGINAudioDeviceTransportTypeBuiltIn = 6,
        kWWISEPLUGINAudioDeviceTransportTypeThunderbolt = 7,
        kWWISEPLUGINAudioDeviceTransportTypeAirPlay = 8,
        kWWISEPLUGINAudioDeviceTransportTypeVirtual = 9,
        kWWISEPLUGINAudioDeviceTransportTypeOther = 10,
    };
 
    struct RtcDeviceInfo {
        char deviceId[kWWISEPLUGINMaxDeviceIDLength];
        char deviceName[kWWISEPLUGINMaxDeviceNameLength];
        int transportType;
        bool suspectedUnavailable;
        bool systemDefaultDevice;
    };
    enum RtcAudioDeviceType{
        kWWISEPLUGINAudioDeviceUnknown = 0,
        kWWISEPLUGINAudioDeviceRecord,
        kWWISEPLUGINAudioDevicePlayout,
    };
 
    enum RtcAudioDeviceState {
        kWWISEPLUGINAudioDeviceActive = 0,
        kWWISEPLUGINAudioDeviceUnactive,
    };
    struct NERTC_PLUGIN_API RtcEngineContext
    {
        const char* appKey;
        
        const char* logPath;
        RtcLogLevel logLevel = RtcLogLevel::kWWISEPLUGINLevelInfo;
    };
}
}
#endif /* NertcBase_h */