API参考
global API
CRMeetingSDK/CRMeetingSDKImp.h
+ (NSString *)getCRMeetingSDKVer
-
功能:获取SDK版本号
-
返回值:版本号字符串
- (CRMEETINGSDK_ERR)init:(id __nullable)callBack serverList:(NSString *)serverList SDKLogPath:(NSString * __nullable)SDKLogPath
-
功能:初始化SDK
-
返回值:CRMEETINGSDK_ERR, CRMSDKERR_SUCCESS代表调用成功
-
参数:
| 参数 | 类型 | 含义 |
|---|---|---|
| context | Context | APP上下文 |
| serverList | NSString* | 服务器地址,格式:{protocol}://{domain}:{port}, protocol的默认端口可以省略。 如:http://192.168.0.25 |
| callback | CRMeetingSDKCallback | 消息回调对象 |
- (void)uninit
-
功能:反初始化SDK
-
返回值:无
- (CRMEETINGSDK_ERR)setParams:(NSString *)jsonStr
-
功能:配置SDK参数
-
返回值:CRMEETINGSDK_ERR, CRMSDKERR_SUCCESS代表调用成功
-
参数:
| 参数 | 类型 | 含义 |
|---|---|---|
| jsonStr | NSString* | 参数数据 |
jsonStr参数说明:
| 参数 | 类型 | 说明 |
|---|---|---|
| option | NSString* | 入会选项,json格式,支持以下选项: 自动打开麦克风:"autoOpenMic":0/1 自动打开摄像头:"autoOpenCam":0/1 入会开启扬声器:"localOpenSpeaker":0/1 语言:"language":"zh_CN",目前支持zh_CN和en_US UI风格: "uiStyle": 0/1/2, 0:会议(默认) 1:1V1通话 2:多人通话 |
| custom | NSString* | 入会自定义配置选项列表,json格式,详见下方custom参数说明,示例:[{"name":"topbar_meeting_info","hide":1},{"name":"bottom_mic","hide":0}] |
custom参数 说明:
| 参数 | 类型 | 说明 |
|---|---|---|
| name | string | 界面元素标识,参见后面定义 |
| hide | int | 是否强制隐藏,取值:0(默认值)/1, 1:代表隐藏 |
| text | string | 自定义显示文字,为空代表保持默认值 |
界面元素标识定义:
| 标识 | 描述 | 支持隐藏 | 自定义显示文字 |
|---|---|---|---|
| topbar_meeting_info | 顶部_会议信息 | 支持 | 不支持 |
| topbar_speaker_switch | 顶部_扬声器听筒切换 | 支持 | 不支持 |
| topbar_camera_switch | 顶部_前后摄像头切换 | 支持 | 不支持 |
| topbar_exit_meeting | 顶部_退出会议 | 支持 | 不支持 |
| meeting_info_confurl | 会议信息_会议链接 | 支持 | 不支持 |
| meeting_info_copy | 会议信息_复制邀请信息 | 支持 | 不支持 |
| meeting_info_hostpswd | 会议信息_主持人密码 | 支持 | 支持 |
| pstn | 电话 | 支持 | 不支持 |
| bottom_mic | 底部_麦克风 | 支持 | 支持 |
| bottom_camera | 底部_摄像头 | 支持 | 支持 |
| bottom_share | 底部_共享 | 支持 | 支持 |
| bottom_member | 底部_成员 | 支持 | 支持 |
| bottom_more | 底部_更多 | 支持 | 支持 |
| share_screen | 共享_手机屏幕 | 支持 | 支持 |
| share_company_disk | 共享_企业网盘 | 支持 | 支持 |
| share_person_disk | 共享_个人网盘 | 支持 | 支持 |
| share_white_board | 共享_白板 | 支持 | 支持 |
| share_opened_doc | 共享_已打开文档 | 支持 | 支持 |
| share_album | 共享_手机相册 | 支持 | 支持 |
| more_mini_video | 更多_小视频 | 支持 | 支持 |
| more_invite | 更多_邀请 | 支持 | 支持 |
| more_start_server_record | 更多_开启云端录制 | 支持 | 不支持 |
| more_stop_server_record | 更多_结束云端录制 | 支持 | 不支持 |
| more_live | 更多_直播 | 支持 | 不支持 |
| more_vote | 更多_投票 | 支持 | 支持 |
| more_rollcall | 更多_点名 | 支持 | 支持 |
| more_im | 更多_聊天 | 支持 | 支持 |
| more_vbg | 更多_虚拟背景 | 支持 | 支持 |
| more_floating | 更多_浮窗显示 | 支持 | 支持 |
| more_start_captions | 更多_开启字幕 | 支持 | 不支持 |
| more_stop_captions | 更多_关闭字幕 | 支持 | 不支持 |
| more_transcripts | 更多_文字转写 | 支持 | 支持 |
| more_ai | 更多_AI助理 | 支持 | 支持 |
| more_interpreter | 更多_同声传译 | 支持 | 支持 |
| more_beauty | 更多_美颜 | 支持 | 支持 |
| more_setting | 更多_设置 | 支持 | 支持 |
| setting_meeting | 更多_设置_会议设置 | 支持 | 支持 |
| setting_option | 更多_设置_参会者权限 | 支持 | 支持 |
| setting_chat | 更多_设置_聊天权限 | 支持 | 支持 |
| setting_personal | 更多_设置_个人设置 | 支持 | 支持 |
| setting_general | 更多_设置_通用设置 | 支持 | 支持 |
- (CRMEETINGSDK_ERR)loginWithAccount:(NSString *)accountID accountPswd:(NSString *)accountPswd
-
功能:登录, 登录结果请参见onLoginRslt
-
返回值:无
-
参数:
| 参数 | 类型 | 含义 |
|---|---|---|
| accountID | NSString* | 登录的帐号 |
| accountPswd | NSString* | 登录密码的md5值 |
- (void)logout
-
功能:登出
-
返回值:无
- (void)joinMeeting:(UIViewController *)presenter meetID:(int)meetID pswd:(NSString * __nullable)pswd
-
功能:加入会议, 入会状态请参见onJoinMeetingState
-
返回值:无
-
参数:
| 参数 | 类型 | 含义 |
|---|---|---|
| presenter | UIViewController | 用于present的UIViewController |
| meetID | int | 会议号 |
| pswd | NSString* | 会议密码,没有会议密码时请传空 |
- (void)joinMeetingWithoutLogin:(UIViewController *)presenter meetID:(int)meetID pswd:(NSString * __nullable)pswd userID:(NSString *)userID userName:(NSString *)userName asHost:(bool)asHost
-
功能:免登录加入会议, 入会状态请参见onJoinMeetingState
-
返回值:无
-
参数:
| 参数 | 类型 | 含义 |
|---|---|---|
| presenter | UIViewController | 用于present的UIViewController |
| meetID | int | 会议号 |
| pswd | NSString* | 会议密码,没有会议密码时请传空 |
| userID | NSString* | 入会使用的用户ID,空代表不指定userID |
| userName | NSString* | 入会姓名 |
| asHost | BOOL | 是否以主持人身份入会 |
- (void)leaveMeeting
-
功能:离开当前会议
-
返回值:无
- (void)acceptCall:(NSString *)callID meetInfo:(NSString *)meetInfo
-
功能:接受会议邀请。接收邀请之后,需要调用joinMeeting进入指定会议。
-
返回值:无
-
参数:
| 参数 | 类型 | 含义 |
|---|---|---|
| callID | NSString* | 邀请ID |
- (void)declineCall:(NSString *)callID
-
功能:拒接会议邀请
-
返回值:无
-
参数:
| 参数 | 类型 | 含义 |
|---|---|---|
| callID | NSString* | 邀请ID |
CRMeetingSDKCallback
- (void)onLoginRslt:(CRMEETINGSDK_ERR)err
-
功能:登录结果
-
返回值:无
-
参数:
| 参数 | 类型 | 含义 |
|---|---|---|
| err | CRMEETINGSDK_ERR | 登录结果,CRMSDKERR_SUCCESS代表登录成功 |
- (void)notifyLineOff:(CRMEETINGSDK_ERR)reason
-
功能:掉线通知
-
返回值:无
-
参数:
| 参数 | 类型 | 含义 |
|---|---|---|
| reason | CRMEETINGSDK_ERR | 掉线的原因 |
- (void)onJoinMeetingState:(CRMeetingSDK_JOIN_STATE)state err:(CRMEETINGSDK_ERR)err
-
功能:参会状态通知
-
返回值:无
-
参数:
| 参数 | 类型 | 含义 |
|---|---|---|
| state | CRMEETINGSDK_MEETING_STATE | 状态 |
| err | CRMEETINGSDK_ERR | 入会失败的原因值 |
- (void)notifyCallIn:(NSString *)callID caller:(NSString *)caller meetInfo:(NSString *)meetInfoc
-
功能:会议邀请通知
-
返回值:无
-
参数:
| 参数 | 类型 | 含义 |
|---|---|---|
| callID | NSString* | 邀请的唯一标识 |
| caller | NSString* | 邀请者的名称。如果是WEB API发起的邀请,此处将为会议号 |
| meetInfo | NSString* | 会议信息,json格式:{"meetID":12345678, "pswd":"abcd"} |
- (void)notifyCallInCanceled:(NSString *)callID
-
功能:会议邀请取消通知
-
返回值:无
-
参数:
| 参数 | 类型 | 含义 |
|---|---|---|
| callID | NSString* | 邀请的唯一标识 |
- (void)notifyUserJoined:(NSString *)userID userName:(NSString *)userName
-
功能:通知有人入会
-
返回值:无
-
参数:
| 参数 | 类型 | 含义 |
|---|---|---|
| userID | NSString* | 用户ID |
| userName | NSString* | 用户姓名 |
- (void)notifyUserLeft:(NSString *)userID userName:(NSString *)userName
-
功能:通知有人离会
-
返回值:无
-
参数:
| 参数 | 类型 | 含义 |
|---|---|---|
| userID | NSString* | 用户ID |
| userName | NSString* | 用户姓名 |
- (void)notifyInvite
-
功能:通知点击了邀请
-
返回值:无