使用白板
1、注册回调
回调是异步的,在SDK初始化之前,应先注册好所有需要监听的回调(promise类型的接口不需要注册),以便SDK在任何时候给您发送通知,例如:
// SDK接口:回调 登录成功
CRVideo_LoginSuccess.callback = function(userID, cookie){};
// SDK接口:回调 登录失败
CRVideo_LoginFail.callback = function(sdkErr, cookie){};
// SDK接口:通知 登录掉线(从呼叫系统掉线,未启用呼叫服务则不会触发)
CRVideo_LineOff.callback = function(sdkErr){};
// SDK接口:回调 房间创建成功
CRVideo_CreateMeetingSuccess.callback = function(MeetInfoObj, cookie){};
// SDK接口:回调 房间创建失败
CRVideo_CreateMeetingFail.callback = function(sdkErr, cookie){};
// SDK接口:回调 进入房间的结果
CRVideo_EnterMeetingRslt.callback = function(sdkErr, cookie){};
// SDK接口:通知 从房间里面掉线了
CRVideo_MeetingDropped.callback = function(sdkErr){};
// SDK接口:通知 通知初始化白板列表
CRBoard_NotifyInitBoardList.callback = function(WhiteBoadList){};
// SDK接口:通知 通知创建了新白板
CRBoard_NotifyCreateBoard.callback = function(wbDesc, operatorID){};
// SDK接口:通知 通知关闭了某个白板
CRBoard_NotifyCloseBoard.callback = function(boardID, operatorID){};
// SDK接口:通知 通知变更当前白板
CRBoard_NotifyCurrentBoard.callback = function(boardID, operatorID){};
2、初始化SDK
初始化是整个SDK的使用基础,通常在程序启动的时候进行初始化(init),退出的时候进行反初始化(uninit),整个程序的生命周期中只进行一次初始化和反初始化。
// SDK接口:设置SDK参数
CRVideo_SetSDKParams({
isCallSer: false, // 是否启用呼叫服务(如果不需要排队、呼叫及邀请功能,可以不启用呼叫服务)
isWebRTC: false, // 是否启用音视频服务(如果不需要音视频功能,可以不启用音视频服务)
});
// 初始化接口为Promise接口,请注意调用方式如下:
CRVideo_Init().then(res => {
// 初始化成功的回调,继续设置服务器地址及登录等操作,见 第2步...
}, err => {
// 初始化失败的回调,会返回对应的错误码
});
相关API请参考:
相关结构定义请参考:
3. 登录连接服务器
设置服务器地址,使用云屋授权账号和自定义用户编号登录
- 调用接口:
// 设置服务器地址,使用云屋的云服务时填 sdk.cloudroom.com;使用私有化部署的服务器时要填部署的服务器地址:端口;此处以云屋的云服务为例。
CRVideo_SetServerAddr("sdk.cloudroom.com"); // 云屋云服务器
// CRVideo_SetServerAddr("10.8.8.220:2726"); // 私有化部署服务器
// 登录鉴权
CRVideo_Login(appID, md5(appSecret), nickName, userID, userAuthCode, cookie); // 使用appID+appSecret鉴权
// CRVideo_LoginByToken(token, nickname, userID, userAuthCode, cookie); // 使用token鉴权
- 回调通知:
// 登录成功
CRVideo_LoginSuccess.callback = function(userID,cookie){
// 登录成功,开始创建房间,见第3步
}
// 登录失败
CRVideo_LoginFail.callback = function(sdkErr,cookie){
// 登录出错,可以弹出错误提示,或调用登录接口再次重试登录
}
// 登录掉线
CRVideo_LineOff.callback = function(sdkErr){
// 系统掉线,可尝试重新登录,或弹出提示
// token失效时,若没有及时更新token,系统将会强制掉线
}
相关API请参考:
- CRVideo_SetServerAddr
- CRVideo_Login
- CRVideo_LoginByToken
- CRVideo_LoginSuccess.callback
- CRVideo_LoginFail.callback
- CRVideo_LineOff.callback
4. 创建房间
创建一个房间
- 调用接口:
// 创建房间
CRVideo_CreateMeeting2(cookie);
- 回调通知:
// 创建房间成功
CRVideo_CreateMeetingSuccess.callback = function(meetObj, cookie) {
// 创建房间成功,可以进入房间
}
// 创建房间失败
CRVideo_CreateMeetingFail.callback = function(sdkErr, cookie) {
// 创建房间失败,可以弹出错误提示
}
相关API请参考:
5. 进入房间
用创建成功的房间ID进入房间,其他用户也是利用此房间信息进入该房间。
- 调用接口:
// 进入房间
CRVideo_EnterMeeting3(meetID, cookie);
- 回调通知:
// 进入房间完成响应
CRVideo_EnterMeetingRslt.callback = function(sdkErr) {
if(sdkErr === 0) {
console.log("进入房间成功,可以继续下面第5步……");
} else {
console.log("进入房间失败,错误码:"+ sdkErr);
}
}
// 监控房间掉线
CRVideo_MeetingDropped.callback = function() {
// 从房间中掉线,需要再次进入房间或退回进入房间前的状态
}
相关API请参考:
6. 得到白板列表或创建一个新的白板
- 调用接口
const width = 1280,
height = 720,
pageCount = 1,
pageMode = 1;
const extInfo = JSON.stringify({
name: '白板名称XXX',
});
// 通知房间内白板列表
CRBoard_NotifyInitBoardList.callback = (BoardInfoObjects) => {
// 获取到白板列表后的逻辑,创建白板view等...
}
// 创建白板,返回promise
CRBoard_CreateWhiteBoard(width, height, pageCount, pageMode, extInfo)
.then((BoardInfoObject) => {
// 白板创建成功后的逻辑,创建白板view等...
})
.catch((err) => {
// 白板创建失败后的逻辑...
});
相关API请参考:
相关数据体请参考:
7. 在自己的视图中添加白板view控件
- 调用接口
const boardView = new CRBoard_BoardView(); // 创建一个白板view控件
document.querySelector('body').appendChild(boardView.handler()); // 将白板view控件添加到页面上
相关API请参考:
8. 配置白板view控件
- 调用接口
const BoardViewAttrObject = {
readOnly: false, // 是否只读
asyncPage: true, // 是否同步发送翻页
followPage: true, // 是否跟随翻页
asyncScale: true, // 是否同步发送缩放
followScale: true, // 是否跟随缩放
}
const BoardViewToolAttrObject = {
lineWidth: 2, // 线宽
// lineStyle: 1, // 线型
color: '#007FFF', // 颜色
fontSize: 40, // 文字字体大小
fontWeight: 'normal', // 文字是否加粗,普通normal、加粗bold,缺省为normal
// fontFamily: 'sans-serif', // 文字字体
fontStyle: 'normal', // 文字是否斜体 普通normal、斜体italic,缺省为normal
fontUnderLine: false, // 文字是否有下划线,缺省为false
// fontAlign: 'left', // 文字水平对齐方式
// fontBaseLine: 'middle', // 文字垂直对齐方式
fontBackGroundColor: 'rgba(0,0,0,0)', // 文字背景框的颜色
}
const boardID = 'xxx'; // boardID来自第5步中boardInfo的属性,或者通过查询白板列表获得
// 一般在创建白板view后以及切换白板的回调中配置
boardView.setBoardID(boardID); //给白板配置白板ID,从创建白板或者查询白板列表中获得boardID
boardView.setAttr(attr); // 设置白板的权限
boardView.setToolType(1); // 设置当前图元工具类型 BOARDVIEW_SHAPE_TYPE
boardView.setToolAttr(this.toolAttr); // 设置工具属性
// 给白板view控件注册相关回调通知
// SDK接口(白板view):通知 白板view缩放比变化
boardView.notifyScaleChanged.callback = (boardID, scale, operatorID) => {};
// SDK接口(白板view):通知 白板view的可撤销状态变化
boardView.notifyUndoEnableChanged.callback = (bool) => {};
// SDK接口(白板view):通知 白板view的可恢复状态变化
boardView.notifyRedoEnableChanged.callback = (bool) => {};
// SDK接口(白板view):通知 白板view当前页改变
boardView.notifyBoardCurPageChanged.callback = (curPageID) => {};
// SDK接口(白板view):通知 标注异常通知
boardView.notifyMarkException.callback = (err) => {};
- 白板权限属于本地配置行为,同步页面指多页滑动或放大后的滑动
相关API请参考:
- CRBoard_BoardView.setBoardID
- CRBoard_BoardView.setAttr
- CRBoard_BoardView.setToolType
- CRBoard_BoardView.setToolAttr
- CRBoard_BoardView.notifyScaleChanged.callback
- CRBoard_BoardView.notifyUndoEnableChanged.callback
- CRBoard_BoardView.notifyRedoEnableChanged.callback
- CRBoard_BoardView.notifyBoardCurPageChanged.callback
- CRBoard_BoardView.notifyMarkException.callback
相关数据体请参考:
9. 关闭白板
- 调用接口
CRBoard_CloseBoard(boardID) // 从创建白板或者查询白板列表中获得boardID
.then(resObject=>{})
.catch(errObject=>{})
相关API请参考:
10. 退出房间
// 离开房间
CRVideo_ExitMeeting();
相关API请参考:
11. 注销登录
//注销本次登录
CRVideo_Logout();
相关API请参考:
12. 反初始化,退出SDK
执行反初始化后SDK功能不再可用。
//反初始化
CRVideo_Uninit();
相关API请参考: