PanoEnumerates.h

浏览该文件的文档.

 
//
//  PanoEnumerates.h
//  PanoRtc
//
//  Copyright © 2019 Pano. All rights reserved.
//
 
#import <Foundation/Foundation.h>
 
typedef NS_ENUM(NSInteger, PanoResult) {
    kPanoResultOK                   = 0,
    kPanoResultFailed               = -1,
    kPanoResultFatal                = -2,
    kPanoResultInvalidArgs          = -3,
    kPanoResultInvalidState         = -4,
    kPanoResultInvalidIndex         = -5,
    kPanoResultAlreadyExist         = -6,
    kPanoResultNotExist             = -7,
    kPanoResultNotFound             = -8,
    kPanoResultNotSupported         = -9,
    kPanoResultNotImplemented       = -10,
    kPanoResultNotInitialized       = -11,
    kPanoResultLimitReached         = -12,
    kPanoResultNoPrivilege          = -13,
    kPanoResultInProgress           = -14,
    kPanoResultWrongThread          = -15,
    kPanoResultTimeout              = -16,
    kPanoResultAborted              = -17,
    kPanoResultTooManyOps           = -18,
    kPanoResultOutOfMemory          = -19,
    kPanoResultOutOfDiskSpace       = -20,
 
    kPanoResultAuthFailed           = -101,
    kPanoResultUserRejected         = -102,
    kPanoResultUserExpelled         = -103,
    kPanoResultUserDuplicate        = -104,
 
    kPanoResultChannelClosed        = -151,
    kPanoResultChannelFull          = -152,
    kPanoResultChannelLocked        = -153,
    kPanoResultChannelModeMismatch  = -154,
    kPanoResultChannelCryptoTypeMismatch = -155,
 
    kPanoResultNetworkError         = -301,
};
 
typedef NS_ENUM(NSInteger, PanoFailoverState) {
    kPanoFailoverReconnecting       = 0,
    kPanoFailoverSuccess            = 1,
    kPanoFailoverFailed             = 2,
};
 
typedef NS_ENUM(NSInteger, PanoAudioAecType) {
    kPanoAecDisable                = 0,
    kPanoAecDefault                = 1,
    kPanoAecSoftware               = 2,
    kPanoAecBuiltIn                = 3,
};
 
typedef NS_ENUM(NSInteger, PanoChannelMode) {
    kPanoChannel1v1                 = 0,
    kPanoChannelMeeting             = 1,
};
 
typedef NS_OPTIONS(NSUInteger, PanoChannelService) {
    kPanoChannelServiceMedia        = 1 << 0,
    kPanoChannelServiceWhiteboard   = 1 << 1,
    kPanoChannelServiceMessage      = 1 << 2,
};
 
typedef NS_ENUM(NSInteger, PanoUserLeaveReason) {
    kPanoLeaveNormal                = 0,
    kPanoLeaveExpelled              = 1,
    kPanoLeaveDisconnected          = 2,
    kPanoLeaveChannelEnd            = 3,
    kPanoLeaveDuplicateUserID       = 4,
};
 
typedef NS_ENUM(NSInteger, PanoSubscribeResult) {
    kPanoSubscribeSuccess           = 0,
    kPanoSubscribeFailed            = 1,
    kPanoSubscribeUserNotFound      = 2,
    kPanoSubscribeLimitReached      = 3,
};
 
typedef NS_ENUM(NSInteger, PanoVideoProfileType) {
    kPanoProfileLowest              = 0,
    kPanoProfileLow                 = 1,
    kPanoProfileStandard            = 2,
    kPanoProfileHD720P              = 3,
    kPanoProfileHD1080P             = 4,
    kPanoProfileNone                = 5,
    kPanoProfileMax                 = kPanoProfileHD1080P,
};
 
typedef NS_ENUM(NSInteger, PanoVideoScalingMode) {
    kPanoScalingFit                 = 0,
    kPanoScalingFullFill            = 1,
    kPanoScalingCropFill            = 2,
};
 
typedef NS_ENUM(NSInteger, PanoAudioType) {
    kPanoPCM                        = 0,
};
 
typedef NS_ENUM(NSInteger, PanoVideoType) {
    kPanoI420                       = 0,
};
 
typedef NS_ENUM(NSInteger, PanoVideoRotation) {
    kPanoRotation0                  = 0,
    kPanoRotation90                 = 90,
    kPanoRotation180                = 180,
    kPanoRotation270                = 270,
};
 
typedef NS_ENUM(NSInteger, PanoDeviceType) {
    kPanoDeviceUnknown              = 0,
    kPanoDeviceAudioRecord          = 1,
    kPanoDeviceAudioPlayout         = 2,
    kPanoDeviceVideoCamera          = 3,
};
 
typedef NS_ENUM(NSInteger, PanoDeviceState) {
    kPanoDeviceAdd                  = 0,
    kPanoDeviceRemove               = 1,
    kPanoDeviceActive               = 2,
    kPanoDeviceInactive             = 3,
};
 
typedef NS_ENUM(NSInteger, PanoVideoCaptureState) {
    kPanoVideoCaptureUnknown        = 0,
    kPanoVideoCaptureNormal         = 1,
    kPanoVideoCaptureSuspended      = 2,
};
 
typedef NS_ENUM(NSInteger, PanoScreenCaptureState) {
    kPanoScreenCaptureUnknown        = 0,
    kPanoScreenCaptureNormal         = 1,
    kPanoScreenCaptureStopped        = 2,
};
 
typedef NS_ENUM(NSInteger, PanoScreenSourceType) {
    kPanoScreen                     = 0,
    kPanoApplicaition               = 1,
    kPanoWindow                     = 2,
};
 
typedef NS_ENUM(NSInteger, PanoScreenScalingRatio) {
    kPanoScalingFitRatio            = 0,
    kPanoScalingOriginalRatio       = 1,
};
 
typedef NS_ENUM(NSInteger, PanoWBRoleType) {
    kPanoWBRoleAdmin                = 0,
    kPanoWBRoleAttendee             = 1,
    kPanoWBRoleViewer               = 2,
};
 
typedef NS_ENUM(NSInteger, PanoWBToolType) {
    kPanoWBToolNone                 = 0,
    kPanoWBToolSelect               = 1,
    kPanoWBToolPath                 = 2,
    kPanoWBToolLine                 = 3,
    kPanoWBToolRect                 = 4,
    kPanoWBToolEllipse              = 5,
    kPanoWBToolImage                = 6,
    kPanoWBToolText                 = 7,
    kPanoWBToolDelete               = 8,
    kPanoWBToolBrush                = 9,
    kPanoWBToolArrow                = 10,
    kPanoWBToolPolyline             = 11,
    kPanoWBToolPolygon              = 12,
    kPanoWBToolArc                  = 13,
    kPanoWBToolCurve                = 14,
    kPanoWBToolLaser                = 15,
    kPanoWBToolStamp                = 16,
};
 
typedef NS_ENUM(NSInteger, PanoWBFillType) {
    kPanoWBFillNone                 = 0,
    kPanoWBFillColor                = 1,
};
 
typedef NS_ENUM(NSInteger, PanoWBFontStyle) {
    kPanoWBFontNormal               = 0,
    kPanoWBFontBold                 = 1,
    kPanoWBFontItalic               = 2,
    kPanoWBFontBoldItalic           = 3,
};
 
typedef NS_ENUM(NSInteger, PanoWBImageScalingMode) {
    kPanoWBImageScalingFit          = 0,
    kPanoWBImageScalingAutoFill     = 1,
    kPanoWBImageScalingFillWidth    = 2,
    kPanoWBImageScalingFillHeight   = 3,
    kPanoWBImageScalingFitCenter    = 4,
    
};
 
typedef NS_ENUM(NSInteger, PanoWBImageState) {
    kPanoWBImageLoadStart            = 0,
    kPanoWBImageLoadComplete         = 1,
    kPanoWBImageLoadFail             = 2,
};
 
typedef NS_ENUM(NSInteger, PanoWBHtmlState) {
    kPanoWBHtmlLoadStart             = 0,
    kPanoWBHtmlLoadComplete          = 1,
    kPanoWBHtmlLoadTimeout           = 2,
    kPanoWBHtmlReloaded              = 3,
};
 
typedef NS_ENUM(NSInteger, PanoWBConvertType) {
    kPanoWBConvertJPG                = 1,
    kPanoWBConvertPNG                = 2,
    kPanoWBConvertH5                 = 3,
    kPanoWBConvertPDF                = 4,
};
 
typedef NS_ENUM(NSInteger, PanoWBDocType) {
    kPanoWBDocNormal                 = 1,
    kPanoWBDocH5                     = 2,
    kPanoWbDocExtHtml                = 3,
    kPanoWbDocExternal               = 4,
    kPanoWbDocPDF                    = 5,
};
 
typedef NS_ENUM(NSInteger, PanoWbClearType) {
    kPanoWBClearDraws               = 1,
    kPanoWBClearBackgroundImage     = 2,
    kPanoWBClearAll                 = 255,
};
 
typedef NS_ENUM(NSInteger, PanoWBSnapshotMode) {
    kPanoWBSnapshotView             = 0,
    kPanoWBSnapshotAll              = 1,
};
 
typedef NS_ENUM(NSInteger, PanoWBDrawEventType) {
    kPanoWBDrawStart                = 0,
    kPanoWBDrawEnd                  = 1,
    kPanoWBTextInput                = 2,
    kPanoWBTextUpdate               = 3,
};
 
typedef PanoVideoScalingMode PanoWBScalingMode;
 
typedef NS_ENUM(NSInteger, PanoWBOptionType) {
    kPanoWBOptionFileCachePath      = 1,
    kPanoWBOptionEnableUIResponse   = 2,
    kPanoWBOptionShowDraws          = 3, // type: BOOL
    kPanoWBOptionScaleMove          = 4, // type: BOOL
    kPanoWBOptionAutoSelected         = 5, // type: BOOL
    kPanoWBOptionCursorPosSync        = 6, // type: BOOL
    kPanoWBOptionShowRemoteCursor     = 7, // type: BOOL
    kPanoWBOptionPCUAForExtHtml       = 8, // type: BOOL
    kPanoWBOptionUIEventForward = 9, // type: BOOL
 
};
 
typedef NS_ENUM(NSInteger, PanoAnnoOptionType) {
    kPanoAnnoOptionEnableLocalRender      = 1, // type: bool
    kPanoAnnoOptionShowDraws              = 2, // type: bool
    kPanoAnnoOptionEnableUIResponse       = 3,
    kPanoAnnoOptionCursorPosSync          = 4, // type: BOOL
    kPanoAnnoOptionShowRemoteCursor       = 5, // type: BOOL
};
 
typedef NS_ENUM(NSInteger, PanoExternalAnnoMode)
{
    kPanoExtAnnoDefault         = 1,
    kPanoExtAnnoAutoSync        = 2,
    kPanoExtAnnoScreenShareSend = 3,
    kPanoExtAnnoScreenShareRecv = 4,
};
 
typedef NS_ENUM(NSInteger, PanoOptionType) {
    kPanoOptionFaceBeautify             = 0,
    kPanoOptionUploadLogs               = 1,
    kPanoOptionUploadAudioDump          = 2,
    kPanoOptionAudioEqualizationMode    = 3,
    kPanoOptionAudioReverbMode          = 4,
    kPanoOptionVideoFrameRate           = 5,
    kPanoOptionAudioEarMonitoring       = 6,
    kPanoOptionBuiltinTransform         = 7,
    kPanoOptionUploadLogsAtFailure      = 8,
    kPanoOptionCpuAdaption              = 9,
    kPanoOptionAudioProfile             = 10,
    kPanoOptionQuadTransform            = 11,
    kPanoAudioPreProcessMode            = 12,
    kPanoAudioNoiseSuppressionLevel     = 13,
    kPanoAudioAutoGainControl           = 14,
    kPanoOptionVideoQualityAdaption     = 15,
    kPanoOptionAudioVoiceChangerMode    = 16,
    kPanoOptionScreenOptimization = 17,
    kPanoOptionMediaTcpCandidate        = 20,
    kPanoOptionAudioAnalogAgc           = 21,
    kPanoOptionAudioBwe                 = 22,
    kPanoOptionAudioStartWithPlayback   = 23,
    kPanoOptionAudioAecSuppressionLevel    = 24,
    kPanoOptionDisableAV1Encoding = 25,
    kPanoOptionMaxSimulcastLayerNum = 26,
    // The type 16, 17, 18 and 19 are reserved.
};
 
typedef NS_ENUM(NSInteger, PanoAudioSoftwareAecLevelOption) {
    kPanoAecLvlDefault = 0,
    kPanoAecLvlBypass,
    kPanoAecLvlLinear,
    kPanoAecLvlNormal,
};
 
typedef NS_ENUM(NSInteger, PanoAudioPreProcessModeOption) {
    kPanoPreProcessDefault         = 0,
    kPanoPreProcessEnable          = 1,
    kPanoPreProcessDisable         = 2,
};
 
typedef NS_ENUM(NSInteger, PanoAudioNoiseSuppressionLevelOption) {
    kPanoNsLvlDefault              = 0,
    kPanoNsLvlDisable              = 1,
    kPanoNsLvlLow                  = 2,
    kPanoNsLvlHigh                 = 3,
    kPanoNsLvlVeryHigh             = 4,
};
 
typedef NS_ENUM(NSInteger, PanoAudioAutoGainControlOption) {
    kPanoAgcDefault                = 0,
    kPanoAgcEnable                 = 1,
    kPanoAgcDisable                = 2,
};
 
typedef NS_ENUM(NSInteger, PanoLogLevel) {
    kPanoLogFatal                   = 0,
    kPanoLogError                   = 1,
    kPanoLogWarning                 = 2,
    kPanoLogInfo                    = 3,
    kPanoLogVerbose                 = 4,
    kPanoLogDebug                   = 5,
};
 
typedef NS_ENUM(NSInteger, PanoFeedbackType) {
    kPanoFeedbackGeneral            = 0,
    kPanoFeedbackAudio              = 1,
    kPanoFeedbackVideo              = 2,
    kPanoFeedbackWhiteboard         = 3,
    kPanoFeedbackScreen             = 4,
};
 
typedef NS_ENUM(NSInteger, PanoAudioMixingState) {
    kPanoMixingStarted              = 0,
    kPanoMixingFinished             = 1,
};
 
typedef NS_ENUM(NSInteger, PanoImageFileFormat) {
    kPanoImageFileJPEG              = 0,
    kPanoImageFilePNG               = 1,
    kPanoImageFileBMP               = 2,
};
 
typedef NS_ENUM(NSInteger, PanoAudioEqualizationMode) {
    kPanoEqualizationNone           = 0,
    kPanoEqualizationBass           = 1,
    kPanoEqualizationLoud           = 2,
    kPanoEqualizationVocalMusic     = 3,
    kPanoEqualizationStrong         = 4,
    kPanoEqualizationPop            = 5,
    kPanoEqualizationLive           = 6,
    kPanoEqualizationDanceMusic     = 7,
    kPanoEqualizationClub           = 8,
    kPanoEqualizationSoft           = 9,
    kPanoEqualizationRock           = 10,
    kPanoEqualizationParty          = 11,
    kPanoEqualizationClassical      = 12,
    kPanoEqualizationTest           = 13,
};
 
typedef NS_ENUM(NSInteger, PanoAudioReverbMode) {
    kPanoReverbNone                 = 0,
    kPanoReverbVocalI               = 1,
    kPanoReverbVocalII              = 2,
    kPanoReverbBathroom             = 3,
    kPanoReverbSmallRoomBright      = 4,
    kPanoReverbSmallRoomDark        = 5,
    kPanoReverbMediumRoom           = 6,
    kPanoReverbLargeRoom            = 7,
    kPanoReverbChurchHall           = 8,
    kPanoReverbCathedral            = 9,
};
 
typedef NS_ENUM(NSInteger, PanoAudioVoiceChangerOption) {
    kPanoVoiceChangerNone           = 0,
    kPanoVoiceChangerMonster        = 1,
    kPanoVoiceChangerMale           = 2,
    kPanoVoiceChangerFemale         = 3,
    kPanoVoiceChangerEcho           = 4,
    kPanoVoiceChangerThriller       = 5,
    kPanoVoiceChangerLoli           = 6,
};
 
typedef NS_ENUM(NSInteger, PanoVideoFrameRateType) {
    kPanoFrameRateLow               = 0,
    kPanoFrameRateStandard          = 1,
};
 
typedef NS_ENUM(NSInteger, PanoVideoCodecType) {
    kPanoVideoCodecUnknown          = 0,
    kPanoVideoCodecH264             = 1,
    kPanoVideoCodecAV1X              = 2,
};
 
typedef NS_ENUM(NSInteger, PanoAudioCodecType) {
    kPanoAudioCodecUnknown          = 0,
    kPanoAudioCodecG711             = 1,
    kPanoAudioCodecG722             = 2,
    kPanoAudioCodecILBC             = 3,
    kPanoAudioCodecISAC             = 4,
    kPanoAudioCodecOPUS             = 5,
};
 
typedef NS_ENUM(NSInteger, PanoAudioSampleRate) {
    kPanoAudioSampleRate16KHz            = 16000,
    kPanoAudioSampleRate48KHz            = 48000,
};
 
typedef NS_ENUM(NSInteger, PanoAudioChannel) {
    kPanoAudioChannelMono           = 1,
    kPanoAudioChannelStereo         = 2,
};
 
typedef NS_ENUM(NSInteger, PanoAudioCallType) {
    kPanoAudioCallTypeVoIP = 0,
    kPanoAudioCallTypePSTN = 1,
    kPanoAudioCallTypeSIP  = 2,
    kPanoAudioCallTypeH323 = 3
};
 
typedef NS_ENUM(NSInteger, PanoQualityRating) {
    kPanoQualityUnavailable         = 0,
    kPanoQualityVeryBad             = 1,
    kPanoQualityBad                 = 2,
    kPanoQualityPoor                = 3,
    kPanoQualityGood                = 4,
    kPanoQualityExcellent           = 5,
};
 
typedef NS_ENUM(NSInteger, PanoDeviceRating) {
    kPanoDeviceUnavailable = 0,
    kPanoDeviceVeryBad     = 1,
    kPanoDeviceBad         = 2,
    kPanoDevicePoor        = 3,
    kPanoDeviceGood        = 4,
    kPanoDeviceExcellent   = 5,
};
 
typedef NS_ENUM(NSInteger, PanoMediaProcessorType) {
    kAudioCaptureExProcessor = 1,
    kAudioCaptureExEffectProcessor = 2,
    kAudioRenderExProcessor = 3,
    kVideoPreprocessor = 100,
};
 
typedef NS_ENUM(NSInteger, PanoQuadIndex) {
    kPanoQuadTopLeft = 0,
    kPanoQuadTopRight = 1,
    kPanoQuadBottomLeft = 2,
    kPanoQuadBottomRight = 3,
};
 
typedef NS_ENUM(NSInteger, PanoMessageServiceState) {
    kPanoMessageServiceUnavailable = 0,
    kPanoMessageServiceAvailable = 1,
};
 
typedef NS_ENUM(NSInteger, PanoActionType) {
    PanoActionAdd,
    PanoActionUpdate,
    PanoActionRemove
};
 
typedef NS_ENUM(NSInteger, PanoKeyboardEventType) {
    PanoKeyboardEventNone,
    PanoKeyboardEventPressDown,
    PanoKeyboardEventPressUp
};
 
typedef NS_OPTIONS(NSUInteger, PanoModifierFlag) {
    PanoModifierFlagControl = 1 << 0,
    PanoModifierFlagShift = 1 << 1,
    PanoModifierFlagCommand = 1 << 2,
    PanoModifierFlagCapsLock = 1 << 3,
    PanoModifierFlagOption = 1 << 4,
};
 
typedef NS_ENUM(NSInteger, PanoLayoutMode) {
    PanoLayoutModeGallery = 0,
    PanoLayoutModeFloating = 1,
    PanoLayoutModeSpeaker = 2,
    PanoLayoutModeActiveSpeaker = 3,
};
 
typedef NS_ENUM(NSInteger, PanoRecordingState) {
    PanoRecordingStateIdle = 0,
    PanoRecordingStateStarted = 1,
    PanoRecordingStatePaused = 2,
    PanoRecordingStateResumed = 3,
    PanoRecordingStateStopped = 4,
    PanoRecordingStateError = 5,
};