nim_vchat_def.h

Go to the documentation of this file.

 
#ifndef NIM_SDK_DLL_EXPORT_HEADERS_NIM_VCHAT_DEF_H_
#define NIM_SDK_DLL_EXPORT_HEADERS_NIM_VCHAT_DEF_H_
 
#include "public_defines.h"
 
#ifdef __cplusplus
extern "C" {
#endif
enum NIMVideoChatSessionType {
    kNIMVideoChatSessionTypeStartRes = 1,
    kNIMVideoChatSessionTypeInviteNotify = 2,
    kNIMVideoChatSessionTypeCalleeAckRes = 3,
    kNIMVideoChatSessionTypeCalleeAckNotify = 4,
    kNIMVideoChatSessionTypeControlRes = 5,
    kNIMVideoChatSessionTypeControlNotify = 6,
    kNIMVideoChatSessionTypeConnect = 7,
    kNIMVideoChatSessionTypePeopleStatus = 8,
    kNIMVideoChatSessionTypeNetStatus = 9,
    kNIMVideoChatSessionTypeHangupRes = 10,
    kNIMVideoChatSessionTypeHangupNotify = 11,
    kNIMVideoChatSessionTypeSyncAckNotify = 12,
    kNIMVideoChatSessionTypeMp4Notify = 13,
    kNIMVideoChatSessionTypeInfoNotify = 14,
    kNIMVideoChatSessionTypeVolumeNotify = 15,
    kNIMVideoChatSessionTypeAuRecordNotify = 16,
    kNIMVideoChatSessionTypeLiveState = 17,
    kNIMVideoChatSessionTypePubSubNotify = 18,
};
 
enum NIMVChatControlType {
    kNIMTagControlOpenAudio = 1,
    kNIMTagControlCloseAudio = 2,
    kNIMTagControlOpenVideo = 3,
    kNIMTagControlCloseVideo = 4,
    kNIMTagControlAudioToVideo = 5,
    kNIMTagControlAgreeAudioToVideo = 6,
    kNIMTagControlRejectAudioToVideo = 7,
    kNIMTagControlVideoToAudio = 8,
    kNIMTagControlBusyLine = 9,
    kNIMTagControlCamaraNotAvailable = 10,
    kNIMTagControlEnterBackground = 11,
    kNIMTagControlReceiveStartNotifyFeedback = 12,
    kNIMTagControlMp4StartRecord = 13,
    kNIMTagControlMp4StopRecord = 14,
};
 
enum NIMVideoChatMode {
    kNIMVideoChatModeAudio = 1,
    kNIMVideoChatModeVideo = 2
};
 
enum NIMVChatConnectStatus {
    kNIMVChatConnectNone = 0,
    kNIMVChatConnecting = 1,
    kNIMVChatConnected = 2,
    kNIMVChatReConnecting = 3,
    kNIMVChatDisconnect = 4,
};
 
enum NIMVChatVideoQuality {
    kNIMVChatVideoQualityNormal = 0,
    kNIMVChatVideoQualityLow = 1,
    kNIMVChatVideoQualityMedium = 2,
    kNIMVChatVideoQualityHigh = 3,
    kNIMVChatVideoQualitySuper = 4,
    kNIMVChatVideoQuality540p = 5,
    kNIMVChatVideoQuality720p = 6,
};
 
enum NIMVChatVideoFrameRate {
    kNIMVChatVideoFrameRateNormal = 0,
    kNIMVChatVideoFrameRate5 = 1,
    kNIMVChatVideoFrameRate10 = 2,
    kNIMVChatVideoFrameRate15 = 3,
    kNIMVChatVideoFrameRate20 = 4,
    kNIMVChatVideoFrameRate25 = 5,
};
 
enum NIMVChatVideoEncodeMode {
    kNIMVChatVEModeNormal = 0,
    kNIMVChatVEModeFramerate = 1,
    kNIMVChatVEModeQuality = 2,
    kNIMVChatVEModeScreen = 3,
};
 
enum NIMVChatVideoFrameScaleType {
    kNIMVChatVideoFrameScaleNone = 0,
    kNIMVChatVideoFrameScale1x1 = 1,
    kNIMVChatVideoFrameScale4x3 = 2,
    kNIMVChatVideoFrameScale16x9 = 3,
};
 
enum NIMVChatMp4RecordCode {
    kNIMVChatMp4RecordClose = 0,
    kNIMVChatMp4RecordVideoSizeError = 1,
    kNIMVChatMp4RecordOutDiskSpace = 2,
    kNIMVChatMp4RecordThreadBusy = 3,
    kNIMVChatMp4RecordCreate = 200,
    kNIMVChatMp4RecordExsit = 400,
    kNIMVChatMp4RecordCreateError = 403,
    kNIMVChatMp4RecordInvalid = 404,
};
 
enum NIMVChatAudioRecordCode {
    kNIMVChatAudioRecordClose = 0,
    kNIMVChatAudioRecordOutDiskSpace = 2,
    kNIMVChatAudioRecordCreate = 200,
    kNIMVChatAudioRecordExsit = 400,
    kNIMVChatAudioRecordCreateError = 403,
    kNIMVChatAudioRecordInvalid = 404,
};
 
enum NIMVChatVideoSplitMode {
    kNIMVChatSplitBottomHorFloating = 0,
    kNIMVChatSplitTopHorFloating = 1,
    kNIMVChatSplitLatticeTile = 2,
    kNIMVChatSplitLatticeCuttingTile = 3,
    kNIMVChatSplitCustomLayout = 4,
    kNIMVChatSplitAudioLayout = 5,
};
 
enum NIMVChatLiveStateCode {
    kNIMVChatLiveStateInitial = 500,
    kNIMVChatLiveStateLayoutError = 501,
    kNIMVChatLiveStateStartConnecting = 502,
    kNIMVChatLiveStateConnectted = 503,
    kNIMVChatLiveStateConnectFail = 504,
    kNIMVChatLiveStatePushing = 505,
    kNIMVChatLiveStatePushFail = 506,
    kNIMVChatLiveStateInnerError = 507,
    kNIMVChatLiveStatePeopleLimit = 508,
};
 
enum NIMVChatAudioMode {
    kNIMVChatAdModeDefault = 0,
    kNIMVChatAdModeNormal = 1,
    kNIMVChatAdModeHighVoip = 2,
    kNIMVChatAdModeHighMusic = 3,
};
 
enum NIMVideoChatSessionStatus {
    kNIMVideoChatSessionStatusJoined = 0,
    kNIMVideoChatSessionStatusLeaved = 1,
};
 
enum NIMVideoChatUserLeftType {
    kNIMVChatUserLeftTimeout = -1,
    kNIMVChatUserLeftNormal = 0,
};
 
enum NIMVideoChatSessionNetStat {
    kNIMVChatNetStatusVideoClose = -1,
    kNIMVideoChatSessionNetStatGood = 0,
    kNIMVideoChatSessionNetStatPoor = 1,
    kNIMVideoChatSessionNetStatBad = 2,
};
 
enum NIMVChatConnectErrorCode {
    kNIMVChatConnectDisconn = 0,
    kNIMVChatConnectStartFail = 1,
    kNIMVChatConnectTimeout = 101,
    kNIMVChatConnectMeetingModeError = 102,
    kNIMVChatConnectRtmpModeError = 103,
    kNIMVChatConnectRtmpNodesError = 104,
    kNIMVChatConnectRtmpHostError = 105,
    kNIMVChatConnectRtmpCreateError = 106,
    kNIMVChatJoinServerValidError = 107,
    kNIMVChatJoinChannelClosed = 108,
    kNIMVChatConnectSuccess = 200,
    kNIMVChatConnectLayoutError = 208,
    kNIMVChatConnectInvalidParam = 400,
    kNIMVChatConnectDesKey = 401,
    kNIMVChatConnectInvalidRequst = 417,
    kNIMVChatConnectServerUnknown = 500,
    kNIMVChatConnectLogout = 1001,
    kNIMVChatChannelStartFail = 11000,
    kNIMVChatChannelDisconnected = 11001,
    kNIMVChatVersionSelfLow = 11002,
    kNIMVChatVersionRemoteLow = 11003,
    kNIMVChatLocalChannelClosed = 11004,
    kNIMVChatLocalChannelKicked = 11005,
};
 
enum NIMNetDetectType {
    kNIMNetDetectTypeAudio = 0,
    kNIMNetDetectTypeVideo = 1,
};
 
enum NIMNetDetectVideoQuality {
    kNIMNDVideoQualityDefault = 0,
    kNIMNDVideoQualityLow = 1,
    kNIMNDVideoQualityMedium = 2,
    kNIMNDVideoQualityHigh = 3,
    kNIMNDVideoQuality480p = 4,
    kNIMNDVideoQuality540p = 5,
    kNIMNDVideoQuality720p = 6,
};
 
enum NIMMainPictureOptCode {
    kNIMMainPictureOptSucess = 200,
    kNIMMainPictureOptAuthError = 401,
    kNIMMainPictureOptRoomNotExist = 404,
    kNIMMainPictureOptUidNotExist = 405,
    kNIMMainPictureOptDataError = 417,
    kNIMMainPictureOptError = 500,
    kNIMMainPictureOptServerError = 600,
    kNIMMainPictureOptInvalid = 11403,
};
 
enum NIMVChatServRecordType {
    kNIMVChatServRecordMixedSingle = 0,
    kNIMVChatServRecordMixed = 1,
    kNIMVChatServRecordSingle = 2,
};
 
enum NIMVChatPubSubNotifyType {
    kNIMVChatNotifyPublishVideoRet = 0,
    kNIMVChatNotifyUnpublishVideoRet = 1,
    kNIMVChatNotifyRemotePublishVideo = 2,
    kNIMVChatNotifyRemoteUnpublishVideo = 3,
    kNIMVChatNotifySubscribeVideoRet = 4,
    kNIMVChatNotifyUnsubscribeVideoRet = 5,
    kNIMVChatNotifySubscribeAudioRet = 6,
    kNIMVChatNotifyUnsubscribeAudioRet = 7,
};
 
enum NIMVChatPublishVideoStreamMode {
    kNIMVChatPublishVideoSingleStream = 0,
    kNIMVChatPublishVideoDualStream = 1,
};
enum NIMVChatPublishVideoSimulcastRes {
    kNIMVChatPublishVideoSimulcastResHigh = 0,
    kNIMVChatPublishVideoSimulcastResLow = 2,
};
 
enum NIMVChatPubSubErrorCode {
    kNIMVChatPSErrCodeSuccess = 0,
    kNIMVChatPSErrCodeFail = -1,
    kNIMVChatPSErrCodeViewerMode = -200,
    kNIMVChatPSErrCodeAudioMode = -300,
    kNIMVChatPSErrCodeOptBusy = -400,
    kNIMVChatPSErrCodeAutoMode = -500,
    kNIMVChatPSErrCodeForbid = -600,
    kNIMVChatPSErrCodeSubscribed = -700,
};
 
enum NIMVChatServerSubscribeFallbackStrategy {
    kNIMVChatSteamFallbackStrategyDisabled = 0,
    kNIMVChatSteamFallbackStrategyAudioOnly = 2,
};
 
static const char* kNIMVChatServerSettingPath = "server_setting_path";  // 初始化 内容Json key
 
static const char* kNIMNetDetectAppKey = "app_key";
static const char* kNIMNetDetectTimeLimit = "time";
static const char* kNIMNetDetectType = "type";
static const char* kNIMNetDetectQualityType = "quality_type";  // 网络探测 内容Json key
 
static const char* kNIMNetDetectTaskId = "task_id";
static const char* kNIMNetDetectLoss = "loss";
static const char* kNIMNetDetectRttmax = "rttmax";
static const char* kNIMNetDetectRttmin = "rttmin";
static const char* kNIMNetDetectRttavg = "rttavg";
static const char* kNIMNetDetectRttmdev = "rttmdev";
static const char* kNIMNetDetectDetail = "detailinfo";  // 网络探测回调 内容Json key
 
static const char* kNIMVChatUids = "uids";
static const char* kNIMVChatSessionId = "session_id";
static const char* kNIMVChatTimeout = "time_out";
static const char* kNIMVChatCustomVideo = "custom_video";
static const char* kNIMVChatCustomAudio = "custom_audio";
static const char* kNIMVChatRecord = "record";
static const char* kNIMVChatVideoRecord = "video_record";
static const char* kNIMVChatRecordType = "record_type";
static const char* kNIMVChatRHostSpeaker = "r_host_speaker";
static const char* kNIMVChatMaxVideoRate = "max_video_rate";
static const char* kNIMVChatVideoQuality = "video_quality";
static const char* kNIMVChatVideoFrameRate = "frame_rate";
static const char* kNIMVChatAudioMode = "audio_mode";
static const char* kNIMVChatRtmpUrl = "rtmp_url";
static const char* kNIMVChatBypassRtmp = "bypass_rtmp";
static const char* kNIMVChatRtmpRecord = "rtmp_record";
static const char* kNIMVChatSplitMode = "split_mode";
static const char* kNIMVChatCustomLayout = "custom_layout";
static const char* kNIMVChatPushEnable = "push_enable";
static const char* kNIMVChatNeedBadge = "need_badge";
static const char* kNIMVChatNeedFromNick = "need_nick";
static const char* kNIMVChatApnsPayload = "payload";
static const char* kNIMVChatSound = "sound";
static const char* kNIMVChatKeepCalling = "keepcalling";
static const char* kNIMVChatVEncodeMode = "v_encode_mode";
static const char* kNIMVChatServerSubscribeFallbackStrategy = "server_sub_fb_stategy";
  // json extension params
 
static const char* kNIMVChatUid = "uid";
static const char* kNIMVChatStatus = "status";
static const char* kNIMVChatRecordAddr = "record_addr";
static const char* kNIMVChatRecordFile = "record_file";
static const char* kNIMVChatVideoRecordFile = "video_record_file";
static const char* kNIMVChatType = "type";
static const char* kNIMVChatTime = "time";
static const char* kNIMVChatAccept = "accept";
static const char* kNIMVChatClient = "client";
static const char* kNIMVChatMp4Start = "mp4_start";
static const char* kNIMVChatMp4Close = "mp4_close";
static const char* kNIMVChatMp4File = "mp4_file";
static const char* kNIMVChatAuRecordStart = "audio_record_start";
static const char* kNIMVChatAuRecordClose = "audio_record_close";
static const char* kNIMVChatFile = "file";
static const char* kNIMVChatCustomInfo = "custom_info";
static const char* kNIMVChatVideo = "video";
static const char* kNIMVChatAudio = "audio";
static const char* kNIMVChatStaticInfo = "static_info";
static const char* kNIMVChatFPS = "fps";
static const char* kNIMVChatKBPS = "KBps";
static const char* kNIMVChatLostRate = "lost_rate";
static const char* kNIMVChatRtt = "rtt";
static const char* kNIMVChatAudioVolume = "audio_volume";
static const char* kNIMVChatSelf = "self";
static const char* kNIMVChatReceiver = "receiver";
static const char* kNIMVChatLiveState = "live_state";
static const char* kNIMVChatMp4AudioType = "mp4_audio";
static const char* kNIMVChatMp4Recode = "mp4_recode";
static const char* kNIMVChatMp4Width = "mp4_width";
static const char* kNIMVChatMp4Height = "mp4_height";
static const char* kNIMVChatTrafficStatRX = "trafficstat_rx";
static const char* kNIMVChatTrafficStatTX = "trafficstat_tx";
static const char* kNIMVChatVideoSimulcastResList = "video_simulcast_res_list";
 
static const char* kNIMVChatRoomConfig = "room_config";
static const char* kNIMVChatRTMPTasks = "rtmpTasks";
static const char* kNIMVChatRTMPTaskID = "taskId";
static const char* kNIMVChatRTMPURL = "streamUrl";
static const char* kNIMVChatRTMPLayoutMode = "layoutMode";
static const char* kNIMVChatRTMPLayoutPara = "layoutPara";
static const char* kNIMVChatRTMPRecord = "record";
static const char* kNIMVChatRTMPMainScreenAccid = "accid";  // json extension params
 
static const char* kNIMVChatAccount = "account";  // json extension params
 
typedef void (*nim_vchat_cb_func)(enum NIMVideoChatSessionType type, int64_t channel_id, int code, const char* json_extension, const void* user_data);
 
typedef void (
    *nim_vchat_mp4_record_opt_cb_func)(bool ret, int code, const char* file, int64_t time, const char* json_extension, const void* user_data);
 
typedef void (
    *nim_vchat_audio_record_opt_cb_func)(bool ret, int code, const char* file, int64_t time, const char* json_extension, const void* user_data);
 
typedef void (*nim_vchat_opt_cb_func)(bool ret, int code, const char* json_extension, const void* user_data);
 
typedef void (*nim_vchat_opt2_cb_func)(int code, int64_t channel_id, const char* json_extension, const void* user_data);
 
typedef void (*nim_vchat_rate_callback)(bool ret, int response_code, const char* json_extension, const void* user_data);
 
typedef void (*nim_vchat_remote_audio_data_cb_func)(uint64_t time,
    const char* data,
    unsigned int size,
    int channels,
    int rate,
    const char* json_extension,
    const void* user_data);
 
#ifdef __cplusplus
};
#endif  // __cplusplus
#endif  // NIM_SDK_DLL_EXPORT_HEADERS_NIM_VCHAT_DEF_H_