API参考
global API
const char* getCRMeetingSDKVer()
-
功能:获取SDK版本号
-
返回值:版本号字符串
CRMeetingSDK* createCRMeetingSDK()
-
功能:创建SDK对象
-
返回值:CRMeetingSDK*
class CRMeetingSDK
void destroy()
-
功能:销毁SDK对象,释放对象内存及相关资源
-
返回值:无
CRMEETINGSDK_ERR init(const SDKInitDat &dat)
-
功能:初始化SDK
-
返回值:CRMEETINGSDK_ERR, CRMSDKERR_SUCCESS代表调用成功
-
参数:
| 参数 | 类型 | 含义 |
|---|---|---|
| dat | SDKInitDat | 初始化数据 |
SDKInitDat参数说明
| 参数 | 类型 | 含义 |
|---|---|---|
| pDispatch | CRMainThreadDispatch | 主线程消息派发器 |
| pCallBack | CRMEETINGSDK_CallBack | 消息回调对象 |
| server | char* | 服务器地址,格式:{protocol}://{domain}:{port}, protocol的默认端口可以省略。 如:http://192.168.0.25 |
| meetingAppPathName | char* | 会议程序路径文件名 如Windows为SDK安装目录\meeting\NCONFMeeting.exe。 |
| sdkLogPath | char* | SDK日志路径 |
void uninit()
-
功能:反初始化SDK
-
返回值:无
CRMEETINGSDK_ERR setParams(const char* jsonStr)
-
功能:配置SDK参数
-
返回值:CRMEETINGSDK_ERR, CRMSDKERR_SUCCESS代表调用成功
-
参数:
| 参数 | 类型 | 含义 |
|---|---|---|
| jsonStr | char* | json格式, 示例:{"option":{"autoOpenMic":1,"autoOpenCam":1,"language":"zh_CN","meetDuration":1},"custom":[{"name":"topbar_info","hide":1},{"name":"bottom_mic","text":"麦"}]} |
jsonStr参数说明:
| 参数 | 类型 | 说明 |
|---|---|---|
| option | object | 入会选项,支持以下参数: 自动打开麦克风:"autoOpenMic":0/1 自动打开摄像头:"autoOpenCam":0/1 语言:"language":"zh_CN"/"en_US" 显示参会时长:"meetDuration":0/1 整体配色:"colorType":""/"blue" 界面风格:"uiStyle":0/1/2。 0:会议(默认)、1:1对1通话、2:多人通话 |
| custom | array | 自定义界面元素列表,详见下方UIElementDef |
UIElementDef 说明:
| 参数 | 类型 | 说明 |
|---|---|---|
| name | string | 界面元素标识,参见后面定义 |
| hide | int | 是否强制隐藏,取值:0(默认值)/1, 1:代表隐藏 |
| text | string | 自定义显示文字,为空代表保持默认值 |
界面元素标识定义:
| 标识 | 描述 | 支持隐藏 | 自定义显示文字 |
|---|---|---|---|
| topbar_info | 顶部_信息 | 支持 | 不支持 |
| topbar_security | 顶部_安全 | 支持 | 不支持 |
| topbar_netstatus | 顶部_网络状态 | 支持 | 不支持 |
| topbar_local_record | 顶部_本地录制 | 支持 | 不支持 |
| topbar_server_record | 顶部_云端录制 | 支持 | 不支持 |
| topbar_meet_lock | 顶部_会议锁定 | 支持 | 不支持 |
| topbar_live | 顶部_直播 | 支持 | 不支持 |
| topbar_fullscreen | 顶部_全屏 | 支持 | 不支持 |
| bottom_mic | 底部_麦克风 | 支持 | 支持 |
| bottom_camera | 底部_摄像头 | 支持 | 支持 |
| bottom_exit_meeting | 底部_离开会议 | 支持 | 支持 |
| bottom_goback_mainroom | 底部_返回主会场 | 支持 | 支持 |
| bottom_invite | 底部_邀请 | 支持 | 支持 |
| bottom_member | 底部_成员 | 支持 | 支持 |
| bottom_im | 底部_聊天 | 支持 | 支持 |
| bottom_startshare | 底部_开启共享 | 支持 | 支持 |
| bottom_stopshare | 底部_停止共享 | 支持 | 支持 |
| bottom_videolayout | 底部_视频布局 | 支持 | 支持 |
| bottom_record | 底部_录制 | 支持 | 不支持 |
| bottom_breakrooms | 底部_分组会议 | 支持 | 支持 |
| bottom_more | 底部_更多 | 支持 | 支持 |
| more_live | 更多_直播 | 支持 | 支持 |
| more_rollcall | 更多_点名 | 支持 | 支持 |
| more_vote | 更多_投票 | 支持 | 支持 |
| more_setting | 更多_系统设置 | 支持 | 支持 |
| more_startcaptions | 更多_开启字幕 | 支持 | 支持 |
| more_stopcaptions | 更多_关闭字幕 | 支持 | 支持 |
| more_transcripts | 更多_文字转写 | 支持 | 支持 |
| more_aiassistant | 更多_AI助手 | 支持 | 支持 |
| more_interpretation | 更多_同声传译 | 支持 | 支持 |
| setting_general | 设置_通用设置 | 支持 | 支持 |
| setting_meeting | 设置_会议设置 | 支持 | 支持 |
| setting_option | 设置_参会者权限 | 支持 | 支持 |
| setting_audio | 设置_音频设置 | 支持 | 支持 |
| setting_video | 设置_视频设置 | 支持 | 支持 |
| setting_vbg | 设置_虚拟背景 | 支持 | 支持 |
| setting_beauty | 设置_美颜 | 支持 | 支持 |
| setting_loc_storage | 设置_本地存储 | 支持 | 支持 |
| setting_record | 设置_录制设置 | 支持 | 支持 |
| setting_captions | 设置_字幕和转写 | 支持 | 支持 |
| setting_netmonitor | 设置_系统监测 | 支持 | 支持 |
| share_wbdoc | 共享_文档/白板 | 支持 | 支持 |
| share_screen | 共享_屏幕 | 支持 | 支持 |
| share_media | 共享_影音 | 支持 | 支持 |
| share_cam | 共享_视频设备 | 支持 | 支持 |
| share_wbdoc_locdoc | 共享_文档/白板_本地文件 | 支持 | 支持 |
| share_wbdoc_pnetdisk | 共享_文档/白板_个人网盘 | 支持 | 支持 |
| share_wbdoc_cnetdisk | 共享_文档/白板_企业网盘 | 支持 | 支持 |
| share_wbdoc_wb | 共享_文档/白板_创建白板 | 支持 | 支持 |
| share_media_locfile | 共享_影音_影音文件 | 支持 | 支持 |
| share_media_netfile | 共享_影音_网络影音 | 支持 | 支持 |
| invite_call | 邀请_呼叫邀请 | 支持 | 支持 |
| pstn | 电话呼入 | 支持 | 不支持 |
| confinfo_qrcode | 会议信息_扫一扫邀请 | 支持 | 不支持 |
| confinfo_confurl | 会议信息_会议链接 | 支持 | 不支持 |
| confinfo_hostpswd | 会议信息_主持人密码 | 支持 | 不支持 |
| confinfo_pswd | 会议信息_会议密码 | 支持 | 不支持 |
| confinfo_email | 会议信息_邮件邀请 | 支持 | 不支持 |
void login(const char* userID, const char* md5_pswd)
-
功能:登录, 登录结果请参见onLoginRslt
-
返回值:无
-
参数:
| 参数 | 类型 | 含义 |
|---|---|---|
| userID | char* | 登录的帐号 |
| md5_pswd | char* | 登录密码的md5值 |
void logout()
-
功能:登出
-
返回值:无
void joinMeeting(int meetID, const char* pswd)
-
功能:加入会议, 入会状态请参见onJoinMeetingState
-
返回值:无
-
参数:
| 参数 | 类型 | 含义 |
|---|---|---|
| meetID | int | 会议号 |
| pswd | char* | 会议密码,没有会议密码时请传空 |
void joinMeetingWithoutLogin(int meetID, const char *pswd, const char *userID, const char *userName, bool asHost)
-
功能:免登录加入会议, 入会状态请参见onJoinMeetingState
-
返回值:无
-
参数:
| 参数 | 类型 | 含义 |
|---|---|---|
| meetID | int | 会议号 |
| pswd | char* | 会议密码,没有会议密码时请传空 |
| userID | char* | 入会使用的用户ID,空代表不指定userID |
| userName | char* | 入会姓名 |
| asHost | bool | 是否以主持人身份入会 |
void leaveMeeting()
-
功能:离开当前会议
-
返回值:无
void acceptCall(const char* callID)
-
功能:接受会议邀请。接收邀请之后,需要调用joinMeeting进入指定会议。
-
返回值:无
-
参数:
| 参数 | 类型 | 含义 |
|---|---|---|
| callID | char* | 邀请ID |
void declineCall(const char* callID)
-
功能:拒接会议邀请
-
返回值:无
-
参数:
| 参数 | 类型 | 含义 |
|---|---|---|
| callID | char* | 邀请ID |
void setCustomInviteType(CUSTOM_INVITE_TYPE type)
-
功能:设置自定义邀请模式
-
返回值:无
-
参数:
| 参数 | 类型 | 含义 |
|---|---|---|
| type | CUSTOM_INVITE_TYPE | 自定义邀请模式,模式工作逻辑请参见会议邀请模式 |
void setCustomOrgInfo(const char* orgInfo)
- 功能:设置自定义组织结构设置给SDK
应该收到notifyQueryOrgInfo时,尽快获取组织结构数据,并设置给SDK
-
返回值:无
-
参数:
| 参数 | 类型 | 含义 |
|---|---|---|
| orgInfo | char* | 自定义企业组织结构数据 |
orgInfo格式举例:
{"contactData":[{"departId":1,"userId":"100","userName":"test"}],"contactDepartsData":[{"departName":"测试部门","id":1,"pId":0}]}
| 参数 | 类型 | 说明 |
|---|---|---|
| contactData | array | 用户列表数据 |
| departId | int | 用户所属部门id |
| userId | string | 用户id |
| userName | string | 用户姓名 |
| contactDepartsData | array | 部门列表 |
| departName | string | 部门名称 |
| id | int | 部门id |
| pId | int | 部门的上级部门id,0代表无上级部门 |
class CRMEETINGSDK_CallBack
void onLoginRslt(CRMEETINGSDK_ERR err)
-
功能:登录结果
-
返回值:无
-
参数:
| 参数 | 类型 | 含义 |
|---|---|---|
| err | CRMEETINGSDK_ERR | 登录结果,CRMSDKERR_SUCCESS代表登录成功 |
void notifyLineOff(CRMEETINGSDK_ERR reason)
-
功能:掉线通知
-
返回值:无
-
参数:
| 参数 | 类型 | 含义 |
|---|---|---|
| reason | CRMEETINGSDK_ERR | 掉线的原因 |
void onJoinMeetingState(CRMEETINGSDK_MEETING_STATE state, CRMEETINGSDK_ERR err)
-
功能:参会状态通知
-
返回值:无
-
参数:
| 参数 | 类型 | 含义 |
|---|---|---|
| state | CRMEETINGSDK_MEETING_STATE | 状态 |
| err | CRMEETINGSDK_ERR | 入会失败的原因值 |
void notifyCallIn(const char* callID, const char* caller, const char* meetInfo)
- 功能:会议邀请通知
邀请方必须使用setCustomInviteType将邀请模式设为:“内置呼叫邀请模式”,被叫方才会收到:notifyCallIn;
被叫方必须要登录,才能收到notifyCallIn;
-
返回值:无
-
参数:
| 参数 | 类型 | 含义 |
|---|---|---|
| callID | char* | 邀请的唯一标识 |
| caller | char* | 邀请者的名称。如果是WEB API发起的邀请,此处将为会议号 |
| meetInfo | char* | 会议信息,json格式:{"meetID":12345678, "pswd":"abcd"} |
void notifyCallInCanceled(const char* callID)
-
功能:会议邀请取消通知
-
返回值:无
-
参数:
| 参数 | 类型 | 含义 |
|---|---|---|
| callID | char* | 邀请的唯一标识 |
void notifyInvite(uint64_t meetingNativeWID)
- 功能:通知用户在会议中点击了邀请按钮
调用setCustomInviteType将邀请模式设为“自定义邀请UI模式”,用户点击了会议界面中“邀请按钮”时,sdk将回调notifyInvite;
-
返回值:无
-
参数:
| 参数 | 类型 | 含义 |
|---|---|---|
| meetingNativeWID | uint64_t | 会议程序的窗口句柄。 Windows: HWND linux:窗口ID macOS: window number |
void notifyQueryOrgInfo()
- 功能:SDK请求自定义组织结构
调用setCustomInviteType将邀请模式设为“自定义邀请数据模式”,用户打开会议界面中“呼叫邀请界面”时, sdk将回调notifyQueryOrgInfo;
- 返回值:无
void notifyInviteUsers(const char* users)
-
功能:通知邀请的人员
-
返回值:无
-
参数:
| 参数 | 类型 | 含义 |
|---|---|---|
| users | char* | 邀请的用户信息,json格式:{"users":["userID1", "userID2"]} |
void notifyUserJoined(const char *userID, const char *userName)
-
功能:通知有人入会
-
返回值:无
-
参数:
| 参数 | 类型 | 含义 |
|---|---|---|
| userID | char* | 用户ID |
| userName | char* | 用户姓名 |
void notifyUserLeft(const char *userID, const char *userName)
-
功能:通知有人离会
-
返回值:无
-
参数:
| 参数 | 类型 | 含义 |
|---|---|---|
| userID | char* | 用户ID |
| userName | char* | 用户姓名 |
class CRMainThreadDispatch
-
CRMainThreadDispatch背景说明:
为了让集成时不用过多考虑线程问题,所以需要将SDK的内部消息派发到主线程并在主线程与集成代码交互,而c++没有一个标准的主线程消息队列,在此借助CRMainThreadDispatch来实现。
-
CRMainThreadDispatch原理说明:
- 应用层将CRMainThreadDispatch对象设置给SDK;
- SDK其它线程(如网络线程)需要主线程处理逻辑或回调应用层代码时,在网络线程调用postCRMsg(msgSN);
- 应用层在重载的postCRMsg函数中将消息挂入主线程消息队列;
- 应用层在处理SDK派发的消息时,调用SDK的dealCRMsg(msgSN),将处理权交回给SDK;
- SDK便在主线程完成对msgSN的相关处理(包括回调业务代码,也将在主线程完成的);
-
Qt应用举例说明:
//定义CRMsgEvent class CRMsgEvent : public QEvent { public: CRMsgEvent(uint32_t msgSN) : QEvent(QEvent::User), m_msgSN(msgSN) {} uint32_t m_msgSN; }; //Qt版本的主线程消息派发器 class CRMainThreadDispatch_Qt : public QObject, public CRMainThreadDispatch { public: CRMainThreadDispatch_Qt(QObject *parent) : QObject(parent) virtual void postCRMsg(uint32_t msgSN) { //向CRMainThreadDispatch_Qt发消息; //CRMainThreadDispatch_Qt为主线程对象,等于消息派发给了主线程 //由于QCoreApplication::postEvent线程安全,所以无需提心多线程问题 QCoreApplication::postEvent(this, new CRMsgEvent(msgSN)); } bool event(QEvent *e) { //主线程的CRMainThreadDispatch_Qt在处理QEvent::User消息时, //调用dealCRMsg来完成消息的处理 if (e->type() == QEvent::User) { CRMsgEvent *pMsg = static_cast<CRMsgEvent*>(e); dealCRMsg(pMsg->m_msgSN); return true; } return QObject::event(e); } }; int main(int argc, char *argv[]) { QApplication a(argc, argv); CRMeetingSDK::SDKInitDat initDat; initDat.pDispatch = &g_CRMainThreadDispatch; ... getMeetingSDK().init(initDat); }
virtual void postCRMsg(uint32_t msgSN) = 0
- 功能:将消息派发到主线程
纯虚函数,业务代码必须在派生类实现;
实现时必须将消息挂入主线程消息队列;
postCRMsg将可能在非主线程被调用,所以挂入消息队列时要注意线程安全;
在处理消息时,必需调用CRMainThreadDispatch::dealCRMsg,驱动SDK来完成相关消息的处理;
-
返回值:无
-
参数:
| 参数 | 类型 | 含义 |
|---|---|---|
| msgSN | uint32_t | 消息序号 |
void dealCRMsg(uint32_t msgSN)
-
功能:驱动SDK处理派发的消息
-
返回值:无
-
参数:
| 参数 | 类型 | 含义 |
|---|---|---|
| msgSN | uint32_t | 消息序号 |