NERtcEngineEnum.h

浏览该文件的文档.

/*
 * Copyright (c) 2021 NetEase, Inc.  All rights reserved.
 */
 
#import <Foundation/Foundation.h>
 
#if __has_attribute(visibility)
#define NERTC_EXPORT __attribute__((visibility("default")))
#endif
 
#ifndef NERTC_EXPORT
#define NERTC_EXPORT
#endif
 
#if defined(__cplusplus)
#define NERTC_EXTERN_API extern "C" __attribute__((visibility("default")))
#else
#define NERTC_EXTERN_API extern __attribute__((visibility("default")))
#endif
 
#if TARGET_OS_IPHONE
#import <UIKit/UIKit.h>
typedef UIView VIEW_CLASS;
typedef UIColor COLOR_CLASS;
#elif TARGET_OS_MAC
#import <AppKit/AppKit.h>
typedef NSView VIEW_CLASS;
typedef NSColor COLOR_CLASS;
#endif
 
 
NS_ASSUME_NONNULL_BEGIN
 
#pragma mark -- ENGINE ENUM
 
 
typedef NS_ENUM(NSUInteger, NERtcConnectionStateType) {
    kNERtcConnectionStateUnknown = 0,
    kNERtcConnectionStateDisconnected = 1,
    kNERtcConnectionStateConnecting = 2,
    kNERtcConnectionStateConnected = 3,
    kNERtcConnectionStateReconnecting = 4,
    kNERtcConnectionStateFailed = 5,
};
 
 
typedef NS_ENUM(NSInteger, NERtcSessionLeaveReason) {
    kNERtcSessionLeaveNormal = 0,
    kNERtcSessionLeaveForFailOver = 1,
    kNERTCSessionLeaveForUpdate = 2,
    kNERtcSessionLeaveForKick = 3,
    kNERtcSessionLeaveTimeout = 4,
};
 
typedef NS_ENUM(NSInteger, NERtcJoin3Type) {
    kNERtcJoin3WithPubVideo = 4,
    kNERtcJoin3NoPubVideo = 5,
};
 
typedef NS_ENUM(NSInteger, NERtcClientRole) {
    kNERtcClientRoleBroadcaster = 0,
    kNERtcClientRoleAudience = 1,
};
 
typedef NS_ENUM(NSUInteger, NERtcMediaPubType) {
    kNERtcMediaPubTypeAudio,
};
 
typedef NS_ENUM(NSInteger, NERtcReasonConnectionChangedType) {
    kNERtcReasonConnectionChangedLeaveChannel = 1,
    kNERtcReasonConnectionChangedChannelClosed = 2,
    kNERtcReasonConnectionChangedBeKicked = 3,
    kNERtcReasonConnectionChangedTimeOut = 4,
    kNERtcReasonConnectionChangedJoinChannel = 5,
    kNERtcReasonConnectionChangedJoinSucceed = 6,
    kNERtcReasonConnectionChangedReJoinSucceed = 7,
    kNERtcReasonConnectionChangedMediaConnectionDisconnected = 8,
    kNERtcReasonConnectionChangedSignalDisconnected = 9,
    kNERtcReasonConnectionChangedRequestChannelFailed = 10,
    kNERtcReasonConnectionChangedJoinChannelFailed = 11,
    kNERtcReasonConnectionChangedReDispatch = 12,
    kNERtcReasonConnectionChangedSettingProxyServer = 13
};
 
#pragma mark -- VIDEO ENUM
 
 
typedef NS_ENUM(NSUInteger, NERtcVideoProfileType) {
    kNERtcVideoProfileLowest = 0,          // 160x90/120
    kNERtcVideoProfileLow = 1,          // 320x180/240
    kNERtcVideoProfileStandard = 2,     // 640x360/480
    kNERtcVideoProfileHD720P = 3,       // 1280x720
    kNERtcVideoProfileHD1080P = 4,      // 1920x1080
    kNERtcVideoProfileMAX = kNERtcVideoProfileHD1080P,
};
 
typedef NS_ENUM(NSUInteger, NERtcVideoFrameRate) {
    kNERtcVideoFrameRateFpsDefault = 0,
    kNERtcVideoFrameRateFps7  = 7,
    kNERtcVideoFrameRateFps10 = 10,
    kNERtcVideoFrameRateFps15 = 15,
    kNERtcVideoFrameRateFps24 = 24,
    kNERtcVideoFrameRateFps30 = 30,
    kNERtcVideoFrameRateFps60 = 60,
};
 
typedef NS_ENUM(NSUInteger, NERtcDegradationPreference) {
    kNERtcDegradationDefault = 0,
    kNERtcDegradationMaintainFramerate,
    kNERtcDegradationMaintainQuality,
    kNERtcDegradationBalanced,
};
 
typedef NS_ENUM(NSUInteger, NERtcSubStreamContentPrefer) {
    kNERtcSubStreamContentPreferMotion = 0,
    kNERtcSubStreamContentPreferDetails,
};
 
typedef NS_ENUM(NSUInteger, NERtcRemoteVideoStreamType) {
    kNERtcRemoteVideoStreamTypeHigh,
    kNERtcRemoteVideoStreamTypeLow
};
 
typedef NS_ENUM(NSUInteger, NERtcVideoPubMode) {
    kNERtcVideoSendOnPubWithNone = 0,
    kNERtcVideoSendOnPubWithHigh,
    kNERtcVideoSendOnPubWithLow,
    kNERtcVideoSendOnPubWithAll,
};
 
typedef NS_ENUM(NSUInteger, NERtcVideoRenderScaleMode) {
    kNERtcVideoRenderScaleFit      = 0,
    kNERtcVideoRenderScaleFullFill = 1,
    kNERtcVideoRenderScaleCropFill = 2,
};
 
typedef NS_ENUM(NSUInteger, NERtcVideoRotationMode) {
    NERtcVideoRotationModeBySystem = 0,
    NERtcVideoRotationModeByApp = 1,
};
 
 
typedef NS_ENUM(NSUInteger, NERtcVideoMirrorMode) {
    kNERtcVideoMirrorModeAuto    = 0,
    kNERtcVideoMirrorModeEnabled = 1,
    kNERtcVideoMirrorModeDisabled = 2,
};
 
typedef NS_ENUM(NSUInteger, NERtcVideoOutputOrientationMode) {
    kNERtcVideoOutputOrientationModeAdaptative    = 0,
    kNERtcVideoOutputOrientationModeFixedLandscape = 1,
    kNERtcVideoOutputOrientationModeFixedPortrait = 2,
};
 
typedef NS_ENUM(NSUInteger, NERtcVideoCropMode) {
    kNERtcVideoCropDefault,
    kNERtcVideoCropMode16_9,
    kNERtcVideoCropMode4_3,
    kNERtcVideoCropMode1_1,
};
 
typedef NS_ENUM(NSUInteger, NERtcRenderType) {
    kNERtcRenderDefault = 0,
    kNERtcRenderOpenGL,
    kNERtcRenderMetal,
};
 
typedef NS_ENUM(NSUInteger, NERtcVideoRotationType) {
    kNERtcVideoRotation_0 = 0,
    kNERtcVideoRotation_90 = 90,
    kNERtcVideoRotation_180 = 180,
    kNERtcVideoRotation_270 = 270,
};
 
typedef NS_ENUM(NSUInteger, NERtcVideoFormatType) {
    kNERtcVideoFormatI420 = 0,
    kNERtcVideoFormatNV12,
    kNERtcVideoFormatBGRA,
};
 
typedef NS_ENUM(NSUInteger, NERtcStreamChannelType) {
    kNERtcStreamChannelTypeMainStream = 0,
    kNERtcStreamChannelTypeSubStream,
};
 
typedef NS_ENUM(NSUInteger, NERtcVirtualBackgroundSourceStateReason) {
    kNERtcVirtualBackgroundSourceStateReasonSuccess = 0,
    kNERtcVirtualBackgroundSourceStateReasonImageNotExist = 1,
    kNERtcVirtualBackgroundSourceStateReasonImageFormatNotSupported = 2,
    kNERtcVirtualBackgroundSourceStateReasonColorFormatNotSupported = 3,
    kNERtcVirtualBackgroundSourceStateReasonDeviceNotSupported = 4
};
 
typedef NS_ENUM(NSUInteger, NERtcVirtualBackgroundSourceType ) {
    
    kNERtcVirtualBackgroundColor = 1,
    
    kNERtcVirtualBackgroundImg = 2,
    
    kNERtcVirtualBackgroundBlur = 3,
};
 
typedef NS_ENUM(NSUInteger, NERtcBlurDegree ) {
    
    kNERtcBlurLow = 1,
    
    kNERtcBlurMedium = 2,
    
    kNERtcBlurHigh = 3,
};
 
typedef NS_ENUM(NSUInteger, NERtcVideoWatermarkType) {
    kNERtcVideoWatermarkTypeImage = 0,
    
    kNERtcVideoWatermarkTypeText,
    
    kNERtcVideoWatermarkTypeTimeStamp
};
 
typedef NS_ENUM(NSUInteger, NERtcLocalVideoWatermarkState) {
    kNERtcLocalVideoWatermarkStateSetSuccess = 0,
  
    kNERtcLocalVideoWatermarkStateDeviceNotSupported = 1,
    
    kNERtcLocalVideoWatermarkStateImageFormatNotSupported,
    
    kNERtcLocalVideoWatermarkStateImageNumberError,
    
    kNERtcLocalVideoWatermarkStateImageSizeError,
    
    kNERtcLocalVideoWatermarkStateImageFpsError,
    
    kNERtcLocalVideoWatermarkStateFontError,
    
    kNERtcLocalVideoWatermarkStateAlphaError,
    
    kNERtcLocalVideoWatermarkStateTextContentEmpty,
    
    kNERtcLocalVideoWatermarkStateFontPathEmpty,
    
    kNERtcLocalVideoWatermarkStateCancel = 20
};
 
typedef NS_ENUM(NSUInteger, NERtcCameraPosition) {
    kNERtcCameraPositionBack = 0,
    
    kNERtcCameraPositionFront
};
 
#pragma mark -- AUDIO ENUM
 
typedef NS_ENUM(NSInteger, NERtcAudioOutputRouting) {
    kNERtcAudioOutputRoutingDefault = 0,
    kNERtcAudioOutputRoutingHeadset,
    kNERtcAudioOutputRoutingEarpiece,
    kNERtcAudioOutputRoutingLoudspeaker,
    kNERtcAudioOutputRoutingBluetooth,
};
 
typedef NS_ENUM(NSInteger, NERtcAudioProfileType) {
    kNERtcAudioProfileDefault = 0,
    kNERtcAudioProfileStandard,
    kNERtcAudioProfileStandardExtend,
    kNERtcAudioProfileMiddleQuality,
    kNERtcAudioProfileMiddleQualityStereo,
    kNERtcAudioProfileHighQuality,
    kNERtcAudioProfileHighQualityStereo,
};
 
typedef NS_ENUM(NSInteger, NERtcAudioScenarioType) {
    kNERtcAudioScenarioDefault = 0,
    kNERtcAudioScenarioSpeech,
    kNERtcAudioScenarioMusic,
    kNERtcAudioScenarioChatRoom,
};
 
typedef NS_ENUM(NSInteger, NERtcChannelProfileType) {
    kNERtcChannelProfileCommunication = 0,
    kNERtcChannelProfileLiveBroadcasting,
};
 
 
typedef NS_ENUM(NSInteger, NERtcAudioSessionOperationRestriction) {
    kNERtcAudioSessionOperationRestrictionNone = 0,
    kNERtcAudioSessionOperationRestrictionAll,
    kNERtcAudioSessionOperationRestrictionDeactivateSession,
};
 
typedef NS_ENUM(int, NERtcAudioStreamType) {
    kNERtcAudioStreamMain = 0,
    kNERtcAudioStreamSub,
    kNERtcAudioStreamTypeMain = kNERtcAudioStreamMain,
    kNERtcAudioStreamTypeSub = kNERtcAudioStreamSub
};
 
typedef NS_ENUM(NSInteger, NERtcAudioDumpType) {
    kNERtcAudioDumpTypePCM = 0,
    kNERtcAudioDumpTypeAll,
    kNERtcAudioDumpTypeWAV
};
 
#pragma mark - media
 
typedef NS_ENUM(NSInteger, NERtcMediaPriorityType){
    kNERtcMediaPriorityHigh = 50,
    kNERtcMediaPriorityNormal = 100,
};
 
typedef NS_ENUM(NSInteger, NERtcStreamFallbackOptions){
    kNERtcStreamFallbackOptionDisabled = 0,
    kNERtcStreamFallbackOptionVideoStreamLow = 1,
    kNERtcStreamFallbackOptionAudioOnly = 2,
};
 
typedef NS_ENUM(NSInteger, NERtcAudioRecordingQuality) {
    kNERtcAudioRecordingQualityLow = 0,
    kNERtcAudioRecordingQualityMedium = 1,
    kNERtcAudioRecordingQualityHigh = 2,
};
 
typedef NS_ENUM(NSInteger, NERtcAudioRecordingCode) {
    NERtcAudioRecordingCodeErrorSuffix = 1,
    kNERtcAudioRecordingOpenFileFailed = 2,
    kNERtcAudioRecordingCodeStart = 3,
    kNERtcAudioRecordingRecordError = 4,
    kNERtcAudioRecordingCodeFinish = 5,
};
 
typedef NS_ENUM(NSInteger, NERtcAudioRecordingPosition) {
    // 录制本地和所有远端用户混音后的音频（默认）
    kNERtcAudioRecordingPositionMixedRecordingAndPlayback = 0,
    // 仅录制采集的音频
    kNERtcAudioRecordingPositionRecording = 1,
    // 仅录制播放的音频
    kNERtcAudioRecordingPositionMixedPlayback = 2
};
 
typedef NS_ENUM(NSInteger, NERtcAudioRecordingCycleTime) {
    // 音频录制缓存时间为0，实时写文件（默认）
    kNERtcAudioRecordingCycleTime0 = 0,
    // 音频录制缓存时间为10s，StopAudioRectording()后，将缓存都写到文件，文件数据时间跨度为: [0,10s]
    kNERtcAudioRecordingCycleTime10 = 10,
    // 音频录制缓存时间为60s，StopAudioRectording()后，将缓存都写到文件，文件数据时间跨度为: [0,60s]
    kNERtcAudioRecordingCycleTime60 = 60,
    // 音频录制缓存时间为360s，StopAudioRectording()后，将缓存都写到文件，文件数据时间跨度为: [0,360s]
    kNERtcAudioRecordingCycleTime360 = 360,
    // 音频录制缓存时间为900s，StopAudioRectording()后，将缓存都写到文件，文件数据时间跨度为: [0,900s]
    kNERtcAudioRecordingCycleTime900 = 900
};
 
typedef NS_ENUM(int, NERtcPreDecoderMediaType) {
    kNERtcPreDecoderMediaTypeAudio = 0,
    
    kNERtcPreDecoderMediaTypeVideo = 1,
    
    kNERtcPreDecoderMediaTypeUnknown = 100,
};
 
typedef NS_ENUM(int, NERtcVideoCodecType) {
    kNERtcVideoCodecTypeH264 = 3,
};
 
#pragma mark --Voice changer/beautifier
 
typedef NS_ENUM(NSInteger, NERtcAudioEqualizationBandFrequency ) {
    NERtcAudioEqualizationBand31 = 0,
    NERtcAudioEqualizationBand62 = 1,
    NERtcAudioEqualizationBand125 = 2,
    NERtcAudioEqualizationBand250 = 3,
    NERtcAudioEqualizationBand500 = 4,
    NERtcAudioEqualizationBand1K = 5,
    NERtcAudioEqualizationBand2K = 6,
    NERtcAudioEqualizationBand4K = 7,
    NERtcAudioEqualizationBand8K = 8,
    NERtcAudioEqualizationBand16K = 9,
};
 
typedef NS_ENUM(NSInteger, NERtcVoiceChangerType) {
    kNERtcVoiceChangerOff = 0,
    kNERtcVoiceChangerRobot,
    kNERtcVoiceChangerGaint,
    kNERtcVoiceChangerHorror,
    kNERtcVoiceChangerMature,
    kNERtcVoiceChangerManToWoman,
    kNERtcVoiceChangerWomanToMan,
    kNERtcVoiceChangerManToLoli,
    kNERtcVoiceChangerWomanToLoli
};
 
typedef NS_ENUM(NSInteger, NERtcVoiceBeautifierType) {
    kNERtcVoiceBeautifierOff = 0,
    kNERtcVoiceBeautifierMuffled,
    kNERtcVoiceBeautifierMellow,
    kNERtcVoiceBeautifierClear,
    kNERtcVoiceBeautifierMagnetic,
    kNERtcVoiceBeautifierRecordingStudio,
    kNERtcVoiceBeautifierNature,
    kNERtcVoiceBeautifierKTV,
    kNERtcVoiceBeautifierRemote,
    kNERtcVoiceBeautifierChurch,
    kNERtcVoiceBeautifierBedroom,
    kNERtcVoiceBeautifierLive
};
 
#pragma mark -- RECORD ENUM
 
typedef NS_ENUM(NSUInteger, NERtcRecordType) {
    kNERtcRecordTypeAll = 0,
    kNERtcRecordTypeMix = 1,
    kNERtcRecordTypeSingle = 2,
};
 
#pragma mark - AUDIO MIXING ENUM
 
typedef NS_ENUM(NSUInteger, NERtcAudioMixingState) {
    kNERtcAudioMixingStateFinished = 0,
    kNERtcAudioMixingStateFailed,
};
 
typedef NS_ENUM(NSUInteger, NERtcAudioMixingErrorCode) {
    kNERtcAudioMixingErrorOK        = 0 ,
    kNERtcAudioMixingErrorFatal         ,
    kNERtcAudioMixingErrorCanNotOpen    ,
    kNERtcAudioMixingErrorDecode        ,
    kNERtcAudioMixingErrorInterrupt     ,
    kNERtcAudioMixingErrorHttpNotFound  ,
    kNERtcAudioMixingErrorOpen          ,
    kNERtcAudioMixingErrorNInfo         ,
    kNERtcAudioMixingErrorNStream       ,
    kNERtcAudioMixingErrorNCodec        ,
    kNERtcAudioMixingErrorNMem          ,
    kNERtcAudioMixingErrorCodecOpen     ,
    kNERtcAudioMixingErrorInvalidInfo   ,
    kNERtcAudioMixingErrorOpenTimeout   ,
    kNERtcAudioMixingErrorIoTimeout     ,
    kNERtcAudioMixingErrorIo            ,
};
 
 
#pragma mark -- Network Status ENUM
typedef NS_ENUM(NSInteger, NERtcNetworkConnectionType) {
    kNERtcNetworkConnectionTypeNone,
    kNERtcNetworkConnectionTypeUnknown,
    kNERtcNetworkConnectionType2G,
    kNERtcNetworkConnectionType3G,
    kNERtcNetworkConnectionType4G,
    kNERtcNetworkConnectionType5G,
    kNERtcNetworkConnectionTypeWiFi,
    kNERtcNetworkConnectionTypeWWAN,
};
 
 
#pragma mark -- Live Stream
typedef NS_ENUM(NSInteger, NERtcLiveStreamAudioSampleRate) {
    kNERtcLiveStreamAudioSampleRate32000 = 32000,
    kNERtcLiveStreamAudioSampleRate44100 = 44100,
    kNERtcLiveStreamAudioSampleRate48000 = 48000,
};
 
typedef NS_ENUM(NSInteger, NERtcLiveStreamAudioCodecProfile) {
    kNERtcLiveStreamAudioCodecProfileLCAAC = 0,
    kNERtcLiveStreamAudioCodecProfileHEAAC = 1,
};
 
typedef NS_ENUM(NSInteger, NERtcLiveStreamMode) {
    kNERtcLsModeVideo = 0,
    kNERtcLsModeAudio,
};
 
typedef NS_ENUM(NSInteger, NERtcLiveStreamVideoScaleMode) {
    kNERtcLsModeVideoScaleFit = 0,
    kNERtcLsModeVideoScaleCropFill ,
};
 
typedef NS_ENUM(NSInteger, NERtcLiveStreamStateCode) {
    kNERtcLsStatePushing = 505,
    kNERtcLsStatePushFail = 506,
    kNERtcLsStatePushStopped = 511,
};
 
#pragma mark -- Audio Frame Observer
typedef NS_ENUM(NSInteger, NERtcAudioType) {
    kNERtcAudioTypePCM16 = 0 ,
};
 
typedef NS_ENUM(NSInteger, NERtcAudioFrameOpMode) {
    kNERtcAudioFrameOpModeReadOnly    = 0 ,
    kNERtcAudioFrameOpModeReadWrite   = 1 ,
};
 
#pragma mark -- Device type
typedef NS_ENUM(int, NERtcAudioDeviceType) {
    kNERtcAudioDeviceTypeUnknown = 0,
    kNERtcAudioDeviceTypeRecord,
    kNERtcAudioDeviceTypePlayout,
};
 
typedef NS_ENUM(int, NERtcVideoDeviceType) {
    kNERtcVideoDeviceTypeUnknown = 0,
    kNERtcVideoDeviceTypeCapture,
};
 
#pragma mark -- Device state
typedef NS_ENUM(int, NERtcAudioDeviceState) {
    kNERtcAudioDeviceStateInitialized = 0,
    kNERtcAudioDeviceStateStarted,
    kNERtcAudioDeviceStateStoped,
    kNERtcAudioDeviceStateUnInitialized,
};
 
typedef NS_ENUM(int, NERtcVideoDeviceState) {
    kNERtcVideoDeviceStateInitialized = 0,
    kNERtcVideoDeviceStateStarted,
    kNERtcVideoDeviceStateStoped,
    kNERtcVideoDeviceStateUnInitialized,
};
 
 
typedef NS_ENUM(int, NERtcNetworkQuality) {
    kNERtcNetworkQualityUnknown = 0,
    kNERtcNetworkQualityExcellent,
    kNERtcNetworkQualityGood,
    kNERtcNetworkQualityPoor,
    kNERtcNetworkQualityBad,
    kNERtcNetworkQualityVeryBad,
    kNERtcNetworkQualityDown,
};
 
typedef NS_ENUM(NSUInteger, NERtcChannelMediaRelayState) {
    NERtcChannelMediaRelayStateIdle = 0,
    NERtcChannelMediaRelayStateConnecting = 1,
    NERtcChannelMediaRelayStateRunning = 2,
    NERtcChannelMediaRelayStateFailure = 3,
};
 
typedef NS_ENUM(NSUInteger, NERtcChannelMediaRelayEvent) {
    NERtcChannelMediaRelayEventDisconnect = 0,
    NERtcChannelMediaRelayEventConnecting = 1,
    NERtcChannelMediaRelayEventConnected = 2,
    NERtcChannelMediaRelayEventVideoSentToDestChannelSuccess = 3,
    NERtcChannelMediaRelayEventAudioSentToDestChannelSuccess = 4,
    NERtcChannelMediaRelayEventOtherStreamSentToDestChannelSuccess = 5,
    NERtcChannelMediaRelayEventFailure = 100,
};
 
typedef NS_ENUM(NSUInteger, NERtcEncryptionMode) {
    NERtcEncryptionModeGMCryptoSM4ECB,
};
 
#pragma mark - last mile probe test
typedef NS_ENUM(NSUInteger, NERtcLastmileProbeResultState) {
    kNERtcLastmileProbeResultComplete = 1,
    kNERtcLastmileProbeResultIncompleteNoBwe = 2,
    kNERtcLastmileProbeResultUnavailable = 3,
};
 
#pragma mark - Cloud Proxy
 
typedef NS_ENUM(NSUInteger, NERtcTransportType) {
    NERtcTransportTypeNoneProxy = 0,
    NERtcTransportTypeUDPProxy
};
 
#pragma mark -- decoder & encoder
 
typedef NS_ENUM(NSInteger, NERtcNalFrameType) {
    kNERtcNalFrameTypeIDR = 1,
 
    kNERtcNalFrameTypeI = 2,
 
    kNERtcNalFrameTypeP = 3,
};
 
typedef NS_ENUM(int, NERtcPayLoadType) {
    kNERtcPayLoadTypeOPUS = 111,
};
 
#pragma mark -- Log
typedef NS_ENUM(NSInteger, NERtcLogLevel) {
    kNERtcLogLevelFatal         = 0,
    kNERtcLogLevelError         = 1,
    kNERtcLogLevelWarning       = 2,
    kNERtcLogLevelInfo          = 3,
    kNERtcLogLevelDetailInfo    = 4,
    kNERtcLogLevelDebug         = 5,
    kNERtcLogLevelVerbose       = 6,
    kNERtcLogLevelOff           = 7,
};
 
NS_ASSUME_NONNULL_END