文档中心
ZegoSuperBoard 超级白板
文档中心
体验 App
SDK 中心
API 中心
常见问题
代码市场
进入控制台
立即注册
登录
中文站 English
  • 文档中心
  • 超级白板
  • 客户端 API
  • 功能总览

功能总览

更新时间:2024-10-24 17:11

即构超级白板(ZegoSuperBoard),基于 ZEGO 亿级海量用户的实时信令网络,提供完整的多人实时白板互动协同服务,包括:白板涂鸦、实时轨迹同步、文档共享、文件转码、白板录制与回放、白板与实时音视频同步等多种能力,具备灵活易用、扩展性强、抽象程度高的特点,适用于在线教育、协作办公、游戏娱乐、金融面签等场景。

SDK初始化

方法名 描述
sharedInstance 获取 ZegoSuperBoardManager 实例对象
initWithConfig:config:complete: 初始化 ZegoSuperBoard SDK
enableSuperBoardView:enable: 设置是否使用 SuperBoardView
unInit 反初始化SDK
getSDKVersion 获取SDK的版本号

ZegoSuperBoardManager的创建、销毁、切换功能

方法名 描述
setManagerListener:listener: 设置SDK方法监听
createWhiteboardView:config:complete: 创建纯白板
createFileView:config:complete: 创建文件
destroySuperBoardSubView:uniqueID:complete: 销毁指定的 SuperBoardSubView 视图
querySuperBoardSubViewList:complete: 向服务器查询当前存在的 SuperBoardSubView 列表
getSuperBoardSubView:uniqueID: 获取指定的 SuperBoardSubView

ZegoSuperBoardSubView内容的操作功能(翻页、滚动及其他)

方法名 描述
flipToPage:targetPage:complete: 跳转到指定页面
flipToPrePage:complete: 跳转到上一页
flipToNextPage:complete: 跳转到下一页
preStep:complete: 跳转到上一步动画
nextStep:complete: 跳转到下一步动画

ZegoSuperBoardSubView绘制操作相关功能

方法名 描述
addTextEditWithComplete:complete: 给白板 View 添加文本,调用后会从白板底部弹出输入框。
addText:text:positionX:positionY:complete: 向白板添加自定义文本
undo 撤销白板的上一步操作
redo 恢复白板上一步撤销的操作
clearCurrentPage:complete: 清除白板当前页的图元
clearAllPage:complete: 清除白板所有页的图元
addImage:type :address:positionX:positionY:complete: 插入图片到白板
clearSelected:complete: 删除选中的图元
setBackgroundImageWithPath:imagePath:mode:complete: 向白板设置背景图
clearBackgroundImageWithComplete:complete: 清除白板的背景图
setCustomFontWithName:regularFontName:boldFontName: 设置自定义新字体

ZegoSuperBoardManager文件上传转码、缓存功能

方法名 描述
uploadFile:filePath:renderType:completionBlock: 上传文件到 ZegoSuperBoard 服务
cancelUploadFileWithSeq:seq:completionBlock: 在上传文件的过程中取消上传动作
cacheFileWithFileID:fileID:completionBlock: 将文件缓存到本地
cancelCacheFileWithSeq:seq:completionBlock: 在缓存文件的过程中取消缓存动作
queryFileCachedWithFileID:fileID:completionBlock: 查询文件缓存是否存在
uploadH5File:filePath:config:completionBlock: 上传自定义H5课件

ZegoSuperBoardSubView 获取文件相关信息功能

方法名 描述
getThumbnailUrlList 获取当前文件的缩略图列表,仅支持 PDF 、PPT、动态 PPT 、H5文件格式
getPPTNotes:page: 获取 PPT 指定页码的备注

ZegoSuperBoardSubView文件内元素操作功能

方法名 描述
stopPlayPPTVideo 停止当前动态ppt页面正在播放的视频

ZegoSuperBoardManager清理资源相关

方法名 描述
clearCache 清除文件和白板相关的缓存资源
clear 清空房间内资源 退房时调用

ZegoSuperBoardSubView操作权限

方法名 描述
setOperationMode:mode: 设置当前白板的操作模式
setWhiteboardBackgroundColor:color: 设置容器内白板背景色

ZegoSuperBoardView 切换操作相关

方法名 描述
switchExcelSheet:sheetIndex:complete: 切换excel文件到指定sheet页
switchSuperBoardSubView:uniqueID:complete: 切换到指定的SuperBoardSubView
switcSuperBoardSubView:uniqueID:sheetIndex:complete: 切换指定的 SuperBoardSubView 到指定的sheet

ZegoSuperBoardManager 个性化设置

方法名 描述
setCustomizedConfig:value:key: 设置配置项
例如:
key值为 logPath,SDK记录日志的目录地址。
key值为 cachePath,SDK缓存的目录地址。
getCustomizedConfig:key: 获取设置的配置项的值
本篇目录
  • 免费试用
  • 提交工单
    咨询集成、功能及报价等问题
    电话咨询
    400 1006 604
    咨询客服
    微信扫码,24h在线

    联系我们

  • 文档反馈