功能总览

更新时间：2023-07-25 17:45

ZEGO SDK 拥有全面覆盖全球重点区域的网络节点，提供丰富的 API，为多端提供清晰稳定的实时语音视频云服务。

以下为基本 API 的简要介绍。

SDK初始化

方法名	描述
getVersion	获取 SDK 版本号
clear	退房前清理资源

白板的创建和销毁功能

方法名	描述
createView	创建 ZegoWhiteboardView
destroyView	销毁指定 ZegoWhiteboardView
attachView	添加 ZegoWhiteboardView 到视图
getViewList	获取 ZegoWhiteboardView 列表
on	注册监听事件
off	删除监听事件

白板内容的操作功能（翻页/缩放/滚动/绘制）

方法名	描述
getAspectRatio	获取 ZegoWhiteboardView 宽高比
getBackgroundColor	获取 ZegoWhiteboardView 背景色
setBackgroundColor	设置 ZegoWhiteboardView 背景色
getCreateTime	获取 ZegoWhiteboardView 创建时间
getCurrentScrollPercent	获取滚动百分比
getFileInfo	获取该 ZegoWhiteboardView 关联的文件信息
setScaleFactor	缩放 ZegoWhiteboardView
getScaleFactor	获取当前 ZegoWhiteboardView 的缩放比例
getHorizontalPercent	获取 ZegoWhiteboardView 当前水平滚动百分比
getID	获取 ZegoWhiteboardView ID
getName	获取 ZegoWhiteboardView 名称
getCurrentPage	获取 ZegoWhiteboardView 当前页码，从1开始
getPageCount	获取 ZegoWhiteboardView 页数
getRoomID	获取当前房间 ID
getScaleOffsetX	获取当前缩放 X 轴方向偏移
getScaleOffsetY	获取当前缩放 Y 轴方向偏移
getVerticalPercent	获取 ZegoWhiteboardView 当前垂直滚动百分比
isFontBold	获取文本是否为粗体
isFontItalic	获取文本是否为斜体
redo	恢复上一步撤销的操作
scroll	将白板滚动到指定偏移位置，用百分比描述，取值范围 0 ~ 1.0
undo	撤销上一步绘制
deleteSelectedGraphics	删除选中图元
clearCurrentPage	清除当前页图元
addImage	在 ZegoWhiteboardView 中添加图片
setWhiteboardOperationMode	设置当前 ZegoWhiteboardView 的操作模式，详情查看 ZegoWhiteboardOperationMode
snapshot	获取当前白板快照。
setBackgroundImage	设置白板背景图
clear	清除白板上的所有图元
reloadView	重新加载白板 View
enableHandwriting	设置是否开启笔锋
enableResponseScale	是否响应房间内其他成员的缩放
enableSyncScale	设置是否将缩放同步给房间内其他成员

选择画笔工具的功能

方法名	描述
getBrushColor	获取画笔颜色
setBrushColor	设置画笔颜色
getBrushSize	获取画笔粗细
setBrushSize	设置画笔粗细
setTextSize	设置文本大小
setFontBold	设置文本粗体
setFontItalic	设置文本斜体
setToolType	设置 ZegoWhiteboardView 工具类型
addText	在 ZegoWhiteboardView 中添加文本
enableCustomCursor	设置是否开启本端自定义光标
enableRemoteCursorVisible	设置是否在本端显示远端的自定义光标
setCustomCursorAttribute	自定义设置本端自定义光标