Interface

2026-01-16


loadOptions	uploadOptions
ZegoCursorAttribute	ZegoEvent
ZegoSuperBoardCacheFileCallBack	ZegoSuperBoardDynamicCacheModel
ZegoSuperBoardErrorData	ZegoSuperBoardStaticCacheModel
ZegoSuperBoardUploadCallback	ZegoSuperBoardUploadH5FileCallback
ZegoWhiteboardScaleModel	~

ZegoCursorAttribute

详情描述：自定义光标可个性化属性。

属性

iconPath

iconPath: string | File

光标路径，可输入网络图片或者本地上传图标文件。

offsetX

offsetX: number

鼠标作用点 X 轴偏移

是否必填：是

示例：如要将鼠标作用点设置在图标的左上角，则 X 轴设置 0。

取值范围：0～32。
平台差异：该属性平台差异请参考 https://developer.mozilla.org/zh-CN/docs/Web/CSS/cursor#specifications。

offsetY

offsetY: number

鼠标作用点 Y 轴偏移

是否必填：是

示例：如要将鼠标作用点设置在图标的左上角，则 Y 轴设置 0。

取值范围：0～32。
平台差异：该属性平台差异请参考 https://developer.mozilla.org/zh-CN/docs/Web/CSS/cursor#specifications。

titleStyle

titleStyle: ZegoSuperBoardCursorTitleStyle

光标自定义文字信息

是否必填：否
默认值：参考 ZegoCursorTitleStyle 类

支持版本：v2.13.0

ZegoEvent

ZegoSuperBoard SDK 回调事件集合

属性

error

error: errorCallback

监听所有 error 错误

remoteSuperBoardSubViewAdded

remoteSuperBoardSubViewAdded: remoteSuperBoardSubViewAddedCallback

监听对端创建 subView ，返回对端创建的 subView 的 uniqueID

通知时机：创建成功 subView 后，已在同一房间内其他用户会在 [remoteSuperBoardSubViewAdded] 回调中收到相应通知。

remoteSuperBoardSubViewRemoved

remoteSuperBoardSubViewRemoved: remoteSuperBoardSubViewRemovedCallback

监听对端删除 subView ，返回对端删除的 subView 的 uniqueID。

通知时机：删除 subView 成功后，已在同一房间内其他用户会在 [remoteSuperBoardSubViewRemoved] 回调中收到相应通知。

remoteSuperBoardSubViewSwitched

remoteSuperBoardSubViewSwitched: remoteSuperBoardSubViewSwitchedCallback

监听对端切换 subView ，返回对端切换的 subView 的 uniqueID。

通知时机：切换 subView 成功后，已在同一房间内其他用户会在 [remoteSuperBoardSubViewSwitched] 回调中收到相应通知。

remoteSuperBoardAuthChanged

remoteSuperBoardAuthChanged: remoteSuperBoardAuthChangedCallback

监听白板权限变更，[缩放、滚动]权限对象

通知时机：权限变更发生，已在同一房间内用户会在 [remoteSuperBoardAuthChanged] 回调中收到相应通知。

remoteSuperBoardGraphicAuthChanged

remoteSuperBoardGraphicAuthChanged: remoteSuperBoardGraphicAuthChangedCallback

监听图元权限变更，[创建、擦除、移动、编辑、清空]权限对象

通知时机：权限变更发生，已在同一房间内用户会在 [remoteSuperBoardGraphicAuthChanged] 回调中收到相应通知。

superBoardSubViewScaleChanged

superBoardSubViewScaleChanged: superBoardSubViewScaleChangedCallback

监听缩放 subView ，返回缩放的 subView 的 uniqueID 和缩放系数。

通知时机：缩放 subView 成功后，在同一房间全部用户会在 [superBoardSubViewScaleChanged] 回调中收到相应通知。

superBoardSubViewScrollChanged

superBoardSubViewScrollChanged: superBoardSubViewScrollChangedCallback

监听滚动/翻页 subView ，返回滚动/翻页的 subView 的 uniqueID ，页码，动态 PPT 类型的文件的步数

通知时机：滚动/翻页 subView 成功后，在同一房间全部用户会在 [superBoardSubViewScrollChanged] 回调中收到相应通知。

cacheFile

cacheFile: cacheFileCallback

调用 cacheFile 接口后,缓存文件过程的状态会通过此回调出来。

业务场景：需要缓存文件到本地。

回调时机：调用cacheFile接口之后。

uploadFile

uploadFile: uploadFileCallback

监听文件等上传，返回文件上传状态，错误码，seq，上传进度，文件ID 信息

通知时机：上传文件成功后，在同一房间全部用户会在 [uploadFile] 回调中收到相应通知。

uploadH5File

uploadH5File: uploadH5FileCallback

监听 H5 文件上传，返回文件上传状态，错误码，seq，上传进度，文件ID 信息

通知时机：上传文件成功后，在同一房间全部用户会在 [uploadH5File] 回调中收到相应通知。

superBoardSubViewMediaPermission

superBoardSubViewMediaPermission: superBoardSubViewMediaPermissionCallback

监听被动端由于浏览器限制导致音视频无法播放时触发的回调，一般结合 playMedia 使用，将回调返回的信息传入 playMedia。

方法

cacheFileCallback

 cacheFileCallback(state: ZegoSuperBoardCacheFileState, errorCode: number, seq: number, percent: number, fileID: string): void

预加载静态文件进度回调

参数

名称	类型	描述
state	ZegoSuperBoardCacheFileState	文件缓存分为缓存 Caching 和缓存完成 Cached 两个阶段
errorCode	number	当前阶段的回调错误码，0表示执行成功
seq	number	seq 对应的值是一个整数，是接口调用时由服务端返回的标识，用于区分正在缓存的不同文件。该参数只有用户同时缓存多个文件时才会用到。
percent	number	缓存进度
fileID	string	缓存文件的 ID

详情

注意：仅当缓存文件类型为静态时有效

errorCallback

errorCallback(error: ZegoSuperBoardError): void

监听所有 error 错误

名称	类型	描述
error	ZegoSuperBoardError	错误信息

remoteSuperBoardAuthChangedCallback

remoteSuperBoardAuthChangedCallback(data: Record<string, number>): void

返回白板权限变更对象

名称	类型	描述
data	Record<string, number>	返回白板权限变更对象注意事项：{ scale:0, scroll:1 }

remoteSuperBoardGraphicAuthChangedCallback

remoteSuperBoardGraphicAuthChangedCallback(data: Record<string, number>): void

返回图元权限变更对象

名称	类型	描述
data	Record<string, number>	返回图元权限变更变更对象注意事项：{ create:1, delete:1, move:1, update:1, clear:0 }

remoteSuperBoardSubViewAddedCallback

 remoteSuperBoardSubViewAddedCallback(name: string, createTime: number, fileID: string, fileType: ZegoSuperBoardFileType, uniqueID: string, whiteboardIDList: array): void

监听对端创建 subView ，返回对端创建的 subView 的信息

名称	类型	描述
name	string	SuperBoardSubView 的名称
createTime	number	创建时间
fileID	string	文件 ID
fileType	ZegoSuperBoardFileType	文件类型
uniqueID	string	SuperBoardSubview 的ID, 是唯一的
whiteboardIDList	array	白板 ID 列表

remoteSuperBoardSubViewRemovedCallback

remoteSuperBoardSubViewRemovedCallback(uniqueID: string): void

返回对端删除的 subView 的 uniqueID

名称	类型	描述
uniqueID	string	对端删除的 subView 的 uniqueID

remoteSuperBoardSubViewRemovedCallback

 remoteSuperBoardSubViewRemovedCallback(name: string, createTime: number, fileID: string, fileType: ZegoSuperBoardFileType, uniqueID: string, whiteboardIDList: array): void

监听对端删除 subView ，返回对端删除的 subView 的信息

名称	类型	描述
name	string	SuperBoardSubView 的名称
createTime	number	创建时间
fileID	string	文件 ID
fileType	ZegoSuperBoardFileType	文件类型
uniqueID	string	SuperBoardSubview 的ID, 是唯一的
whiteboardIDList	array	白板 ID 列表

remoteSuperBoardSubViewSwitchedCallback

remoteSuperBoardSubViewSwitchedCallback(uniqueID: string): void

返回对端切换的 subView 的 uniqueID

名称	类型	描述
uniqueID	string	对端切换的 subView 的 uniqueID

remoteSuperBoardSubViewSwitchedCallback

remoteSuperBoardSubViewSwitchedCallback(uniqueID: string): void

监听对端切换 subView ，返回对端切换的 subView 的信息

名称	类型	描述
uniqueID	string	SuperBoardSubview 的ID, 是唯一的

superBoardSubViewScaleChangedCallback

 superBoardSubViewScaleChangedCallback(name: string, createTime: number, fileID: string, fileType: ZegoSuperBoardFileType, uniqueID: string, whiteboardIDList: array, scaleFactor: number, scaleOffsetX: number, scaleOffsetY: number): void

监听对端缩放 subView ，返回对端缩放的 subView 的信息

名称	类型	描述
name	string	SuperBoardSubView 的名称
createTime	number	创建时间
fileID	string	文件 ID
fileType	ZegoSuperBoardFileType	文件类型
uniqueID	string	SuperBoardSubview 的ID, 是唯一的
whiteboardIDList	array	白板 ID 列表
scaleFactor	number	缩放系数
scaleOffsetX	number	缩放后产生的 X 方向的偏移
scaleOffsetY	number	缩放后产生的 Y 方向的偏移

superBoardSubViewScrollChangedCallback

superBoardSubViewScrollChangedCallback(uniqueID: string, page: number, step: number): void

监听滚动/翻页的 subView ，返回 subView 的 uniqueID 和页码

名称	类型	描述
uniqueID	string	subView 的 uniqueID
page	number	subView 的页码
step	number	动态 PPT 类型的文件的步数

superBoardSubViewScrollChangedCallback

 superBoardSubViewScrollChangedCallback(name: string, createTime: number, fileID: string, fileType: ZegoSuperBoardFileType, uniqueID: string, whiteboardIDList: array, currentPage: number, pageCount: number): void

监听对端滚动 subView ，返回对端滚动的 subView 的信息

名称	类型	描述
name	string	SuperBoardSubView 的名称
createTime	number	创建时间
fileID	string	文件 ID
fileType	ZegoSuperBoardFileType	文件类型
uniqueID	string	SuperBoardSubview 的ID, 是唯一的
whiteboardIDList	array	白板 ID 列表
currentPage	number	当前页
pageCount	number	总页数

uploadFileCallback

 uploadFileCallback(state: ZegoSuperBoardUploadFileState, errorCode: number, seq: number, upload_percent: number, fileID: string): void

上传文件回调

名称	类型	描述
state	ZegoSuperBoardUploadFileState	文件上传分为上传 Upload 和格式转换 Convert 两个阶
errorCode	number	当前阶段的回调错误码，0表示执行成功
seq	number	seq 对应的值是一个整数，是接口调用时由服务端返回的标识，用于区分正在缓存的不同文件。该参数只有用户同时缓存多个文件时才会用到。
upload_percent	number	上传进度
fileID	string	缓存文件的 ID

uploadH5FileCallback

 uploadH5FileCallback(state: ZegoSuperBoardUploadFileState, errorCode: number, seq: number, upload_percent: number, fileID: string): void

上传 H5 文件回调

名称	类型	描述
state	ZegoSuperBoardUploadFileState	文件上传分为上传 Upload 和格式转换 Convert 两个阶
errorCode	number	当前阶段的回调错误码，0表示执行成功
seq	number	seq 对应的值是一个整数，是接口调用时由服务端返回的标识，用于区分正在缓存的不同文件。该参数只有用户同时缓存多个文件时才会用到。
upload_percent	number	上传进度
fileID	string	缓存文件的 ID

ZegoSuperBoardCacheFileCallBack

预加载静态文件进度回调

注意事项：仅缓存文件类型为静态文件时才有效

属性

data

data: ZegoSuperBoardStaticCacheModel

预加载静态文件回调返回的参数

ZegoSuperBoardDynamicCacheModel

关于动态文件调用 cacheFile 方法返回的相关参数

注意事项：该返回字段即将废弃

属性

totalFileNum

totalFileNum: number

该文件总资源数

failedFileNum

failedFileNum: number

该文件预请求失败资源数

ZegoSuperBoardErrorData

错误回调

属性

code

code: ZegoSuperBoardError

错误码

msg

msg: string

错误信息

ZegoSuperBoardStaticCacheModel

关于静态文件调用 cachel 方法产生的回调返回的相关参数

注意事项：该回调仅在预加载文件类型为静态文件时才返回

属性

seq

seq: number

缓存文件对应的 seq，如调用取消缓存 cancelCache 时需要

state

state: CacheState

文件当前缓存状态

totalFileNum

totalFileNum: number

该文件总资源数

failedFileNum

failedFileNum: number

该文件预请求失败资源数

loadedFileNum

loadedFileNum: number

该文件预请求成功资源数

ZegoSuperBoardUploadCallback

上传的进度和结果的回调

属性

data

data: ZegoSuperBoardUploadModel

上传文件产生回调返回的参数

ZegoSuperBoardUploadH5FileCallback

上传 H5 文件产生的回调

属性

data

data: ZegoSuperBoardUploadModel

上传文件产生回调返回的参数

ZegoWhiteboardScaleModel

缩放信息

属性

scaleFactor

scaleFactor: number

当前的缩放系数

scaleOffsetX

scaleOffsetX: number

缩放后产生的 X 方向的偏移

scaleOffsetY

scaleOffsetY: number

缩放后产生的 Y 方向的偏移

loadOptions

加载文件配置

详情

该配置，可以对加载文件时进行一些配置，例如触发动态 PPT 的加载回调时机

注意事项：注意每个配置生效条件，可能某些配置项只针对某类型文件生效。

属性

PPTReady

PPTReady: boolean

设置加载动态文件回调方法触发时机。通常情况下从文件服务器获得加载文件的信息后马上触发回调。

业务场景：获取加载动态 PPT 文件准备就绪状态。
是否必填：否。
默认值：false，默认从文件服务器获得文件信息后立即触发。

注意事项：该参数仅对动态 PPT 文件生效。

uploadOptions

上传文件配置项

详情

针对该上传的文件，进行转码配置

属性

renderImgType

renderImgType: RenderImgType

针对静态文件类型生效，可配置不同参数进行转码为对应的图片格式类型

~

重载配置项

详情

该配置，可以对重新加载 subview 时进行一些配置，例如是否触发强制刷新

支持版本：2.7.1及以后

属性

forceReload

forceReload: boolean

设置是否强制刷新

业务场景：在在部分 iOS 移动设备上渲染文件异常时，执行该 API 进行重新加载文件的操作。
是否必填：是。

reloadType

reloadType: reloadType

该配置，可以针对释放 canvas 的范围进行配置

是否必填：是。