API参考
global API
com.rtc.meeting.CRMeetingSDK
String getCRMeetingSDKVer()
-
功能:获取SDK版本号
-
返回值:版本号字符串
void init(Context context, final String server, final CRMeetingSDKCallback callback)
-
功能:初始化SDK
-
返回值:无
-
参数:
| 参数 | 类型 | 含义 |
|---|---|---|
| context | Context | APP上下文 |
| server | String | 服务器地址,格式:{protocol}://{domain}:{port}, protocol的默认端口可以省略。 如:http://192.168.0.25 |
| callback | CRMeetingSDKCallback | 消息回调对象 |
void uninit()
-
功能:反初始化SDK
-
返回值:无
CRMEETINGSDK_ERR setParams(String params)
-
功能:配置SDK参数
-
返回值:CRMEETINGSDK_ERR, CRMSDKERR_SUCCESS代表调用成功
-
参数:
| 参数 | 类型 | 含义 |
|---|---|---|
| params | String | 参数数据,json格式 |
params参数说明:
| 参数 | 类型 | 说明 |
|---|---|---|
| option | JSON | 入会选项,json格式,支持以下选项: 自动打开麦克风:"autoOpenMic":0/1 自动打开摄像头:"autoOpenCam":0/1 入会开启扬声器:"localOpenSpeaker":0/1 语言:"language":"zh_CN",目前支持zh_CN和en_US |
| custom | JSON | 入会自定义配置选项列表,json格式,详见下方custom参数说明,示例:[{"name":"topbar_meeting_info","hide":1},{"name":"bottom_mic","hide":0}] |
custom参数说明:
| 参数 | 类型 | 说明 |
|---|---|---|
| name | 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_setting" |
| hide | int | 是否强制隐藏,取值0/1, 1:代表强制隐藏 |
void login(String userID, String md5_pswd)
-
功能:登录, 登录结果请参见onLoginRslt
-
返回值:无
-
参数:
| 参数 | 类型 | 含义 |
|---|---|---|
| userID | String | 登录的帐号 |
| md5_pswd | String | 登录密码的md5值 |
void logout()
-
功能:登出
-
返回值:无
void joinMeeting(final Activity activity, int meetID, String pswd)
-
功能:加入会议, 入会状态请参见onJoinMeetingState
-
返回值:无
-
参数:
| 参数 | 类型 | 含义 |
|---|---|---|
| meetID | int | 会议号 |
| pswd | String | 会议密码,没有会议密码时请传空 |
void joinMeetingWithoutLogin(final Activity activity, int meetID, String pswd, String userID, String userName, boolean asHost)
-
功能:免登录加入会议, 入会状态请参见onJoinMeetingState
-
返回值:无
-
参数:
| 参数 | 类型 | 含义 |
|---|---|---|
| meetID | int | 会议号 |
| pswd | String | 会议密码,没有会议密码时请传空 |
| userID | String | 入会使用的用户ID,空代表不指定userID |
| userName | String | 入会姓名 |
| asHost | boolean | 是否以主持人身份入会 |
void leaveMeeting()
-
功能:离开当前会议
-
返回值:无
void acceptCall(String callID)
-
功能:接受会议邀请。接收邀请之后,需要调用joinMeeting进入指定会议。
-
返回值:无
-
参数:
| 参数 | 类型 | 含义 |
|---|---|---|
| callID | String | 邀请ID |
void declineCall(String callID)
-
功能:拒接会议邀请
-
返回值:无
-
参数:
| 参数 | 类型 | 含义 |
|---|---|---|
| callID | String | 邀请ID |
com.rtc.meeting.CRMeetingSDKCallback
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(String callID, String caller, MeetingInfo meetInfo)
-
功能:会议邀请通知
-
返回值:无
-
参数:
| 参数 | 类型 | 含义 |
|---|---|---|
| callID | String | 邀请的唯一标识 |
| caller | String | 邀请者的名称。如果是WEB API发起的邀请,此处将为会议号 |
| meetInfo | MeetingInfo | 会议信息 |
void notifyCallInCanceled(String callID)
-
功能:会议邀请取消通知
-
返回值:无
-
参数:
| 参数 | 类型 | 含义 |
|---|---|---|
| callID | String | 邀请的唯一标识 |
void notifyInvite()
-
功能:通知邀请
-
返回值:无
void notifyUserJoined(String userID, String userName)
-
功能:通知有人入会
-
返回值:无
-
参数:
| 参数 | 类型 | 含义 |
|---|---|---|
| userID | String | 用户ID |
| userName | String | 用户姓名 |
void notifyUserLeft(String userID, String userName)
-
功能:通知有人离会
-
返回值:无
-
参数:
| 参数 | 类型 | 含义 |
|---|---|---|
| userID | String | 用户ID |
| userName | String | 用户姓名 |