功能总览
2026-01-16
即构超级白板（ZegoSuperBoard），基于 ZEGO 亿级海量用户的实时信令网络，提供完整的多人实时白板互动协同服务，包括：白板涂鸦、实时轨迹同步、文档共享、文件转码、白板录制与回放、白板与实时音视频同步等多种能力，具备灵活易用、扩展性强、抽象程度高的特点，适用于在线教育、协作办公、游戏娱乐、金融面签等场景。
SDK初始化
| 方法名 | 描述 |
|---|---|
| clearLog | 将本地缓存日志上传并清除 |
| getInstance | 获取 ZegoSuperBoardManager 实例对象。 |
| setLogConfig | 日志高级配置 |
| init | 初始化 ZegoSuperBoard SDK |
| enableSuperBoardView | 设置是否使用 SuperBoardView |
| unInit | 反初始化SDK |
| getSDKVersion | 获取SDK的版本号 |
| on | 注册监听事件 |
| off | 删除监听事件 |
ZegoSuperBoardManager的创建、销毁、切换功能
| 方法名 | 描述 |
|---|---|
| createWhiteboardView | 创建纯白板 |
| createFileView | 创建文件 |
| destroySuperBoardSubView | 销毁指定的 SuperBoardSubView 视图 |
| querySuperBoardSubViewList | 向服务器查询当前存在的 SuperBoardSubView 列表 |
| getSuperBoardSubView | 获取指定的 SuperBoardSubView |
| attachSuperBoardSubView | 添加 SuperBoardSubView 到视图 |
ZegoSuperBoardSubView内容的操作功能（翻页、滚动及其他）
| 方法名 | 描述 |
|---|---|
| getCurrentStep | 获取动态 PPT 当前页码的动画步骤，从1开始 |
| setScaleFactor | 缩放 superBoardSubView |
| getModel | 获取白板对应的model数据 |
| flipToPage | 跳转到指定页面 |
| flipToPrePage | 跳转到上一页 |
| flipToNextPage | 跳转到下一页 |
| preStep | 跳转到上一步动画 |
| getCurrentPage | 获取当前显示的内容的页码 |
| nextStep | 跳转到下一步动画 |
| getPageCount | 获取总页码数 |
| getVisibleSize | 获取可见区域的大小 |
| getCurrentSheetName | 获取当前展示的sheet名称 |
| getCurrentSuperBoardSubView | 获取当前展示 superBoardSubView |
ZegoSuperBoardSubView绘制操作相关功能
| 方法名 | 描述 |
|---|---|
| clearSelected | 删除选中图元 |
| reloadView | 重新加载 SubView |
| addText | 向白板添加自定义文本 |
| undo | 撤销白板的上一步操作 |
| redo | 恢复白板上一步撤销的操作 |
| clearCurrentPage | 清除白板当前页的图元 |
| clearAllPage | 清除白板所有页的图元 |
| addImage | 插入图片到白板 |
| clearSelected | 删除选中的图元 |
| setBackgroundImage | 向白板设置背景图 |
| clearBackgroundImage | 清除白板的背景图 |
ZegoSuperBoardManager文件上传转码、缓存功能
| 方法名 | 描述 |
|---|---|
| uploadFile | 上传文件到 ZegoSuperBoard 服务 |
| cancelUploadFile | 在上传文件的过程中取消上传动作 |
| cacheFile | 将文件缓存到本地 |
| cancelCacheFile | 在缓存文件的过程中取消缓存动作 |
| queryFileCached | 查询文件缓存是否存在 |
| uploadH5File | 上传自定义H5课件 |
ZegoSuperBoardSubView 获取文件相关信息功能
| 方法名 | 描述 |
|---|---|
| getExcelSheetNameList | 获取 Excel 的 Sheet 名字列表 |
| getThumbnailUrlList | 获取当前文件的缩略图列表，仅支持 PDF 、PPT、动态 PPT 、H5文件格式 |
| getPPTNotes | 获取 PPT 指定页码的备注 |
ZegoSuperBoardSubView文件内元素操作功能
| 方法名 | 描述 |
|---|---|
| snapshot | 获取当前白板快照 |
| stopPlayPPTVideo | 停止当前动态ppt页面正在播放的视频 |
ZegoSuperBoardManager清理资源相关
| 方法名 | 描述 |
|---|---|
| clearCache | 清除文件和白板相关的缓存资源 |
ZegoSuperBoardSubView操作权限
| 方法名 | 描述 |
|---|---|
| setOperationMode | 设置当前白板的操作模式 |
ZegoSuperBoardView 切换操作相关
| 方法名 | 描述 |
|---|---|
| getSuperBoardView | 获取 SuperBoardView 对象 |
| switchSuperBoardSubView | 切换到指定的SuperBoardSubView |
ZegoSuperBoardManager 个性化设置
| 方法名 | 描述 |
|---|---|
| enableCustomCursor | 设置是否开启本端自定义光标 |
| enableRemoteCursorVisible | 设置是否开启显示远端自定义光标 |
| getWhiteboardBackgroundColor | 获取白板背景色 |
| setCustomCursorAttribute | 自定义设置本端自定义光标 |
| setCustomizedConfig | 设置配置项 |
| getCustomizedConfig | 获取设置的配置项的值 |
| setWhiteboardBackgroundColor | 设置白板的背景颜色 |
| setDeferredRenderingTime | 设置本端 SubView 延时渲染的时间 |
| enableSyncScale | 设置是否将缩放同步给房间内其他成员 |
| enableResponseScale | 是否响应房间内其他成员的缩放 |
| enableHandwriting | 设置是否开启笔锋 |
| isHandwritingEnabled | 获取是否开启笔锋效果 |
| setToolType | 设置白板工具类型 |
| getToolType | 获取正在使用的白板工具类型。 |
| setFontBold | 设置文本粗体 |
| setFontItalic | 设置文本工具的文本是否斜体。 |
| isFontItalic | 获取文字是否为斜体效果 |
| setFontSize | 设置文本大小 |
| getFontSize | 获取文本大小 |
| setBrushSize | 设置画笔粗细 |
| getBrushSize | 获取画笔粗细 |
| setBrushColor | 设置画笔颜色 |
| getBrushColor | 获取画笔颜色 |
| getScaleFactor | 获取当前 superBoardSubView 的缩放信息 |