通过阅读本文，您可以了解到DingRTC Web Whiteboard SDK的WhiteboardManager接口详情。
属性列表
属性 | 类型 | 描述 | 支持的最低版本 |
isConnected | boolean | sdk 实例与服务器是否已链接。 | 1.0.1 |
接口列表
接口 | 描述 | 支持的最低版本 |
获取一个白板实例 | 1.0.1 | |
获取一个标注实例 | 1.0.2 | |
加入频道，独立使用白板时使用 | 1.0.1 | |
离开频道，独立使用白板时使用 | 1.0.1 | |
清理本地白板/标注缓存实例，可以在离开频道时调用。 | 1.0.2 | |
取消一个指定事件的监听回调函数 | 1.0.1 | |
监听一个指定事件并设置回调函数 | 1.0.1 | |
监听一个指定事件一次，回调函数触发后移除 | 1.0.1 | |
取消该对象指定事件或所有事件上的监听回调 | 1.0.1 |
事件列表
DingRTC 全局事件
事件 | 回调类型 | 描述 | 支持的最低版本 |
(whiteboardId: string) => void; | 频道内创建了一个新的白板 | 1.0.1 | |
(whiteboardId: string) => void; | 频道内关闭了一个白板 | 1.0.1 | |
(annotationId: string, sourceType: 'video' | 'share' | 'external') => void; | 频道内创建了一个新的标注 | 1.0.2 | |
(annotationId: string, sourceType: 'video' | 'share' | 'external') => void; | 频道内关闭了一个标注 | 1.0.2 | |
(curState:ConnectionState, revState:ConnectionState, reason?:DisconnectedReason) => void | SDK 与服务器的连接状态发生改变时的回调。 | 1.0.1 |
接口详情
getWhiteboard()
获取白板实例
类型签名
getWhiteboard(whiteboardId: string): RTCWhiteboard;入参：
参数 | 类型 | 描述 |
whiteboardId | string | 白板Id，字符内容只允许[A-Za-z0-9_-]，长度不超过64个字符。 |
返回
RTCWhiteboard
getAnnotation()
获取标注实例
类型签名
getAnnotation(annotationId: string, sourceType: 'video' | 'share' | 'external'): RTCWhiteboard;入参：
参数 | 类型 | 描述 |
annotationId | string | 标注Id，字符内容只允许[A-Za-z0-9_-]，长度不超过64个字符。建议在sourceType 为video 或share 时annotationId 包含标注归属视频流用户的uid信息； |
sourceType | 'video' | 'share' | 'external' | video 代表标注归属于摄像头视频流； share 代表标注归属于共享流； external 代表归属于用户自行定义的标注源； |
返回
RTCWhiteboard
join()
加入频道，在同一个频道内的用户可以互相通信。独立使用白板时使用，若配合dingrtc一起使用时无需调用。
类型签名
join(joinInfo: JoinParam): Promise<void>;入参：
参数 | 类型 | 描述 |
joinInfo | 加入频道所需参数 |
返回
Promise<void>
leave()
离开频道，独立使用白板时使用，若配合dingrtc一起使用时无需调用。
类型签名
leave(): void;
返回
void
clear()
清理本地白板/标注缓存实例，可以在离开频道时调用。
类型签名
clear(): void;
返回
void
on()
监听一个指定事件并设置回调函数
类型签名
on(event: string, fn: Function): void;
参数
参数 | 类型 | 描述 |
event | string | 监听的指定事件 |
fn | Function | 监听事件触发时的回调函数 |
返回
void
off()
取消一个指定事件的监听回调函数
类型签名
off(event: string, fn: Function): void;
参数
参数 | 类型 | 描述 |
event | string | 监听的指定事件 |
fn | Function | 监听事件触发时的回调函数 |
返回
void
once()
监听一个指定事件一次，回调函数触发后移除
类型签名
once(event: string, fn: Function): void;
参数
参数 | 类型 | 描述 |
event | string | 监听的指定事件 |
fn | Function | 监听事件触发时的回调函数 |
返回
void
removeAllListeners()
取消该对象指定事件或所有事件上的监听回调
类型签名
removeAllListeners(event?: string): void;
参数
参数 | 类型 | 描述 |
event | string | (Optional)设置了指定事件时，对应监听回调函数将会清空。当参数未填写时，对象的所有事件的监听函数都将清空 |
返回
void
事件详情
"whiteboard-start"
频道内创建了一个新的白板
类型签名
'whiteboard-start': (whiteboardId: string) => void;示例
WhiteboardManager.on('whiteboard-start', (whiteboardId) => {
console.log(whiteboardId);
});"whiteboard-stop"
频道内关闭了一个白板
类型签名
'whiteboard-stop': (whiteboardId: string) => void;示例
WhiteboardManager.on('whiteboard-stop', (whiteboardId) => {
console.log(whiteboardId);
});"annotation-start"
频道内创建了一个新的标注
类型签名
'annotation-start': (annotationId: string, sourceType: 'video' | 'share' | 'external') => void;示例
WhiteboardManager.on('annotation-start', (annotationId, sourceType) => {
console.log(annotationId, sourceType);
});"annotation-stop"
频道内关闭了一个标注
类型签名
'annotation-stop': (annotationId: string, sourceType: 'video' | 'share' | 'external') => void;示例
WhiteboardManager.on('annotation-stop', (annotationId, sourceType) => {
console.log(annotationId, sourceType);
});"connection-state-change"
SDK 与服务器的连接状态发生改变时的回调，建议独立使用白板时使用，若配合dingrtc一起使用时无需额外监听。
类型签名
'connection-state-change': (curState: ConnectionState, prevState: ConnectionState, reason?: DisconnectedReason) => void;示例
WhiteboardManager.on('connection-state-change', (curState, prevState, reason) => {
console.log(curState, prevState, reason);
});