API参考
主调
CRMeetingSDK.init(SDKInitDat, callbackObj)
- 功能:初始化SDK
- 返回值:Promise<errCode>, 0代表调用成功
- 参数:
CRInitOption参数说明
| 参数 |
类型 |
含义 |
| context |
Context |
上下文,可调用 this.getUIContext().getHostContext() 获取 |
| server |
string |
服务器地址,格式:{domain}:{port}, 默认端口可以省略。 如:192.168.0.25 |
示例:
import { CRError, CRMeetingSDK, CRMeetingSDKCallback } from '@cloudroom/meetingsdk';
const callback: CRMeetingSDKCallback = {
notifyLineOff: (reson) => {
console.log('notifyLineOff', reson)
},
}
const errCode = await CRMeetingSDK.init({
context: this.getUIContext().getHostContext()!,
server: 'http://192.168.0.25'
}, callback)
if (errCode === CRError.SUCCESS) {
console.log('初始化成功了')
} else {
console.log('初始化失败了')
}
CRMeetingSDK.uninit()
CRMeetingSDK.setParams(params: CRMeetConfig)
-
功能:配置SDK参数
-
返回值:errCode, 0代表调用成功
-
CRMeetConfig参数说明:
CRMeetOption参数说明:
| 参数 |
类型 |
说明 |
| autoOpenMic |
boolean? |
入会自动打开麦克风,默认值false |
| autoOpenCam |
boolean? |
入会自动打开摄像头,默认值false |
| localOpenSpeaker |
boolean? |
入会自动打开扬声器。false时使用听筒,默认值false |
| language |
string? |
语言:"zh_CN"/"en_US"/"auto"。默认值"auto" |
| uiStyle |
number? |
界面风格,0:会议模式(默认值),1:1V1通话,2:多人通话 |
CRMeetingCustomConfig参数说明:
| 参数 |
类型 |
说明 |
| name |
CRMeetCustomName |
界面元素标识,参见后面定义 |
| hide |
number |
是否强制隐藏,取值: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 |
会议信息_主持人密码 |
支持 |
不支持 |
| bottom_mic |
底部_麦克风 |
支持 |
支持 |
| bottom_camera |
底部_摄像头 |
支持 |
支持 |
| bottom_member |
底部_成员 |
支持 |
支持 |
| bottom_more |
底部_更多 |
支持 |
支持 |
| more_invite |
更多_邀请 |
支持 |
支持 |
| more_start_server_record |
更多_开启云端录制 |
支持 |
支持 |
| more_stop_server_record |
更多_结束云端录制 |
支持 |
支持 |
| more_transcripts |
更多_文字转写 |
支持 |
支持 |
| more_start_live |
更多_直播 |
支持 |
支持 |
| more_stop_live |
更多_结束直播 |
支持 |
支持 |
| more_vote |
更多_投票 |
支持 |
支持 |
| more_rollcall |
更多_点名 |
支持 |
支持 |
| more_im |
更多_聊天 |
支持 |
支持 |
| more_start_captions |
更多_开启字幕 |
支持 |
支持 |
| more_stop_captions |
更多_关闭字幕 |
支持 |
支持 |
| more_setting |
更多_设置 |
支持 |
支持 |
| setting_meeting |
设置_会议设置 |
支持 |
支持 |
| setting_option |
设置_参会者权限 |
支持 |
支持 |
| setting_chat |
设置_聊天权限 |
支持 |
支持 |
| setting_personal |
设置_个人设置 |
支持 |
支持 |
| setting_general |
设置_通用设置 |
支持 |
支持 |
| float_mic |
悬浮_麦克风 |
支持 |
不支持 |
| float_live |
悬浮_直播状态 |
支持 |
支持 |
| float_transcripts |
悬浮_文字转写状态 |
支持 |
支持 |
| float_record |
悬浮_录制状态 |
支持 |
支持 |
示例:
import { CRMeetingSDK } from '@cloudroom/meetingsdk';
CRMeetingSDK.setParams({
option: {
autoOpenMic:true,
autoOpenCam: true,
localOpenSpeaker: true
}
})
CRMeetingSDK.login(account, md5_password)
- 功能:登录
- 返回值:Promise<errCode>, 0代表登录成功
- 参数:
| 参数 |
类型 |
含义 |
| account |
string |
登录的帐号 |
| md5_password |
string |
登录密码的md5值 |
CRMeetingSDK.logout()
CRMeetingSDK.joinMeeting(option: CRJoinMeetingOption)
| 参数 |
类型 |
说明 |
| meetID |
number |
会议号 |
| pswd |
string |
会议密码,可选参数 |
CRMeetingSDK.joinMeetingWithoutLogin(option: CRJoinMeetingNotLoginOption)
| 参数 |
类型 |
含义 |
| meetID |
number |
会议号 |
| userID |
string |
入会使用的用户ID |
| nickname |
string |
入会昵称 |
| pswd |
string |
会议密码,可选参数 |
| asHost |
boolean |
是否以主持人身份入会,可选参数,默认值false |
CRMeetingSDK.leaveMeeting()
CRMeetingSDK.acceptCall(callID)
| 参数 |
类型 |
含义 |
| callID |
string |
邀请ID |
CRMeetingSDK.declineCall(callID)
| 参数 |
类型 |
含义 |
| callID |
string |
邀请ID |
回调
notifyLineOff(reason)
onJoinMeetingState(state, errCode)
notifyCallIn(callID, caller, meetInfo)
| 参数 |
类型 |
含义 |
| callID |
string |
邀请的唯一标识 |
| caller |
string |
邀请者的名称 |
| meetInfo |
CRMeetInfo |
会议信息,参见下方 |
CRMeetInfo参数说明
| 参数 |
类型 |
含义 |
| meetID |
number |
会议号 |
| pswd |
string |
会议密码 |
notifyCallInCanceled(callID)
| 参数 |
类型 |
含义 |
| callID |
string |
邀请的唯一标识 |
notifyInvite(context)
| 参数 |
类型 |
含义 |
| context |
UIContext |
会议页面上下文 |
notifyUserJoined(userID, userName)
| 参数 |
类型 |
含义 |
| userID |
string |
用户ID |
| userName |
string |
用户姓名 |
notifyUserLeft(userID, userName)
| 参数 |
类型 |
含义 |
| userID |
string |
用户ID |
| userName |
string |
用户姓名 |