Class

2026-01-23


IZegoSuperBoardManagerListener	ZegoCreateFileConfig
ZegoCreateWhiteboardConfig	ZegoSuperBoardCursorAttribute
ZegoSuperBoardCursorTitleStyle	ZegoSuperBoardInitConfig
ZegoSuperBoardManager	ZegoSuperBoardSubView
ZegoSuperBoardSubViewModel	ZegoSuperBoardView
ZegoUploadCustomH5Config

IZegoSuperBoardManagerListener

白板状态的监听

详情

白板状态的监听，主要包括subView的创建，删除，切换，操作权限变更和其他使用中的错误等。针对单独的subView的监听，请参考 IZegoSuperBoardViewListener

支持版本：2.0.0及以上。

Declared in IZegoSuperBoardManagerListener.java

方法

onError

public void onError(int errorCode)

使用白板过程中的错误回调，错误码见 ZegoSuperBoardError

Declared in IZegoSuperBoardManagerListener.java

参数

名称	类型	描述
errorCode	int	详情描述：错误码。

调用时机/通知时机：使用白板过程中的错误回调

支持版本：v2.0.0。

onRemoteSuperBoardSubViewAdded

public void onRemoteSuperBoardSubViewAdded(ZegoSuperBoardSubViewModel subViewModel)

新增白板的通知

Declared in IZegoSuperBoardManagerListener.java

参数

名称	类型	描述
subViewModel	ZegoSuperBoardSubViewModel	详情描述：新增的 model

调用时机/通知时机：同一房间内其他用户成功创建白板(调用 [createWhiteboardView])后，本端会收到此通知。

支持版本：v2.0.0。

onRemoteSuperBoardSubViewRemoved

public void onRemoteSuperBoardSubViewRemoved(ZegoSuperBoardSubViewModel subViewModel)

白板被删除的通知

Declared in IZegoSuperBoardManagerListener.java

参数

名称	类型	描述
subViewModel	ZegoSuperBoardSubViewModel	详情描述：被删除的 model。

调用时机/通知时机：同一房间内其他成员成功销毁白板（调用 [destroySuperBoardSubView]）后，本端会收到此通知。

支持版本：v2.0.0。

onRemoteSuperBoardSubViewSwitched

public void onRemoteSuperBoardSubViewSwitched(String uniqueID)

白板切换的通知

Declared in IZegoSuperBoardManagerListener.java

参数

名称	类型	描述
uniqueID	String

调用时机/通知时机：同一房间内其他成员成功切换白板（调用 [switchSubView]）后，本端会收到此通知。

支持版本：v2.0.0。

onRemoteSuperBoardSubViewExcelSwitched

public void onRemoteSuperBoardSubViewExcelSwitched(String uniqueID, int sheetIndex)

Excel白板切换sheet的通知

Declared in IZegoSuperBoardManagerListener.java

参数

名称	类型	描述
uniqueID	String	详情描述：
sheetIndex	int	详情描述：

支持版本：v2.0.0。

onRemoteSuperBoardAuthChanged

public void onRemoteSuperBoardAuthChanged(HashMap<String,Integer> authInfo)

白板操作权限变更回调

Declared in IZegoSuperBoardManagerListener.java

参数

名称	类型	描述
authInfo	HashMap<String,Integer>	详情描述：包含 "scale" 和 "scroll" 2个key，value 取值为 0 或 1（0代表对应权限关闭，1代表对应权限打开）

详情

白板操作权限变更回调,用于控制对白板的操作，包括缩放，滚动。

调用时机/通知时机：收到后台的权限变更通知。

支持版本：v2.0.0。

onRemoteSuperBoardGraphicAuthChanged

public void onRemoteSuperBoardGraphicAuthChanged(HashMap<String,Integer> authInfo)

图元操作权限变更回调

Declared in IZegoSuperBoardManagerListener.java

参数

名称	类型	描述
authInfo	HashMap<String,Integer>	详情描述：包含"create"、"delete"、"move"、"update"、"clear" 5个key，value 取值为 0 或 1（0代表对应权限关闭，1代表对应权限打开）。

详情

图元操作权限包括创建、删除、移动、更新、清空所有图元。

调用时机/通知时机：收到后台的权限变更通知。

支持版本：v2.0.0。

ZegoCreateFileConfig

详情

接口参数构造类，用传入创建文件所需要的参数。

业务场景：在调用[createFileView]接口时需要传入。

Declared in ZegoCreateFileConfig.java

属性

fileID

public String fileID

文件对应的ID

是否必填：必填

支持版本：2.0.0及以上

ZegoCreateWhiteboardConfig

详情

接口参数构造类，用传入创建白板所需要的参数。

业务场景：在调用 createWhiteboardView 接口是需要传入。

Declared in ZegoCreateWhiteboardConfig.java

属性

name

public String name

创建白板时需要设置的白板名称。

是否必填：必填
取值范围：限制长度为 128 字节，支持中英文。

支持版本：2.0.0及以上

perPageWidth

public int perPageWidth

每页白板的宽度。

是否必填：必填
取值范围：大于 0 的正整数。

支持版本：v2.0.0。

perPageHeight

public int perPageHeight

每页白板的高度。

是否必填：必填
取值范围：大于0 的正整数。

支持版本：2.0.0及以上

pageCount

public int pageCount

总页数。

是否必填：必填。
取值范围：大于0。

支持版本：2.0.0及以上

ZegoSuperBoardCursorAttribute

详情

接口参数构造类，用传入光标样式所需要的参数。

业务场景：在调用[setCustomCursorAttribute:cursorAttribute:complete:]接口时需要传入。

Declared in ZegoSuperBoardCursorAttribute.java

属性

url

public String url

自定义光标图片路径, 本地路径或者网络路径均可（本地路径仅支持 URI，网络图片仅支持 https，图片格式只支持 PNG。）例："xxxxxxxxxx.png"，""

是否必填：否
默认值：

支持版本：v2.4.0

pox_x

public int pox_x

自定义光标作用点，绘制点作用在图片指定x偏移方向，默认为0，不可超出图片宽度

是否必填：否
默认值：0

支持版本：v2.4.0

pox_y

public int pox_y

自定义光标作用点，绘制点作用在图片指定y偏移方向,默认为0，不可超出图片高度

是否必填：否
默认值：0

支持版本：v2.4.0

titleStyle

public ZegoSuperBoardCursorTitleStyle titleStyle

光标自定义文字信息

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

支持版本：v2.4.0

ZegoSuperBoardCursorTitleStyle

光标自定义文本信息

详情

设置光标自定义文本信息

业务场景：需要显示光标自定义文本时可用

Declared in ZegoSuperBoardCursorTitlePosition.java

属性

title

public String title

光标自定义文字内容

是否必填：否
默认值：“”
建议值：用户登录名字展示
取值范围：15个字符以内

bold

public boolean bold

光标自定义文本是否加粗

是否必填：否
默认值：false

italic

public boolean italic

光标自定义文本是否斜体

是否必填：否
默认值：false

size

public int size

光标自定义文本字体大小

是否必填：否
默认值：16
取值范围：12-20

color

public int color

光标自定义文本字体颜色

是否必填：否
默认值：白色

backgroundColor

public int backgroundColor

光标自定义文本字体背景颜色

是否必填：否

position

public ZegoSuperBoardCursorTitlePosition position

自定义文本相对于光标的位置

是否必填：否

ZegoSuperBoardInitConfig

详情

接口参数构造类，用构造初始化SDK所需要的参数。

业务场景：调用初始化SDK接口 initWithConfig 时需要传入。

Declared in ZegoSuperBoardInitConfig.java

属性

appID

public long appID

ZEGO 为开发者签发的应用 ID，请从 ZEGO 管理控制台申请。

是否必填：必填
取值范围：0 - 4294967295。

token

public String token

登录验证 token，是通过在即构控制台注册项目获得密钥，加上指定算法获得。测试阶段可以通过 ZEGO 提供的接口获取，正式环境一定要用户自己实现。

parentDomID

public String parentDomID

展示 subView 的目标视图父容器 ID

是否必填：是

注意事项：在添加 subView 到视图中前必须确认父容器定位方式为相对定位且物理尺寸不为 0

userID

public String userID

用户ID，请勿在此字段填写用户敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。

appSign

public String appSign

取值范围：'0' ~ '9', 'a' ~ 'z'。例："9dc9a25bh2f2137446897071c8c033fa33b91c3dd2a85e0c000ae82c0dad3"。2.3.0及以上版本 appSign 允许传空或者不传。如果传空或者不传，可以传token进行初始化。token的生成方式请参考使用 Token 鉴权。

cacheFolder

public String cacheFolder

缓存目录

logFolder

public String logFolder

日志目录

ZegoSuperBoardManager

详情

接口类，SDK的初始化，房间内全局性的功能设置, 创建文件或者纯白板等。

业务场景：主要用于初始化SDK，设置白板的一些工具、缩放同步、画笔效果，在开启SuperBoardView模式下,获取SuperBoardView, 创建纯白板、文件等。
平台差异：无。

Declared in ZegoSuperBoardManager.java

属性

enableCustomCursor

public boolean enableCustomCursor

设置是否启用自定义光标，设置为 true 则显示光标。默认为true

业务场景：涂鸦过程中显示光标功能。
调用时机：初始化 SDK 之后。

支持版本：v2.2.0

enableRemoteCursorVisible

public boolean enableRemoteCursorVisible

设置是否是否显示远端光标，设置为 true 则显示远端的光标。默认为true。

业务场景：涂鸦过程中显示远端光标功能。
调用时机：初始化 SDK 之后。

支持版本：v2.2.0

superBoardMaxScaleFactor

~ ~ superBoardMaxScaleFactor

调用时机：请在初始化之后，创建文件/白板之前，unInit之后失效。

方法

setSuperBoardMaxScaleFactor

public void setSuperBoardMaxScaleFactor(Float scaleFactor)

设置超级白板（文件和白板）最大缩放倍数，默认为3倍。可设置的区间为【1,10】

Declared in ZegoSuperBoardManager.java

参数

名称	类型	描述
scaleFactor	Float	详情描述：超级白板（文件和白板）最大缩放倍数

详情

设置超级白板（文件和白板）最大缩放倍数，默认为3倍。可设置的区间为【1,10】

调用时机/通知时机：请在初始化之后，创建文件/白板之前，unInit之后失效。

支持版本：2.3.7

renewToken

public void renewToken(String token)

更新Token

Declared in ZegoSuperBoardManager.java

参数

名称	类型	描述
token	String	需要更新的 Token。

详情

token 权限变更、或者 token 过期时调用，用于更新 token 权限

默认值：无
调用时机：初始化 SDK 后，借助 ZEGO SDK 的将要过期回调 [tokenWillExpire] 接口，收到 token 将要过期回调，主动更新超级白板的文件服务 token。
影响范围：token 内包含的过期时间，在过期前 30s 会触发 [tokenWillExpire] 回调
相关回调：无
相关接口：[tokenWillExpire]
平台差异：无

enableCustomCursor

void enableCustomCursor(boolean enable)

设置是否开启本端自定义光标

Declared in ZegoSuperBoardManager.java

参数

名称	类型	描述
enable	boolean	是否开启

详情

设置白板涂鸦是否使用自定义光标，设置为 true 则光标可设置自定义图片。

是否必填：是。
调用时机：初始化 SDK 之后。

支持版本：2.2.0及以上。

enableRemoteCursorVisible

void enableRemoteCursorVisible(boolean enable)

设置是否开启显示远端自定义光标

Declared in ZegoSuperBoardManager.java

参数

名称	类型	描述
enable	boolean	是否开启

是否必填：是。
调用时机：初始化 SDK 之后。

支持版本：2.2.0及以上。

getCustomText

String getCustomText()

获取文本教具的默认值

Declared in ZegoSuperBoardManager.java

获取文本教具的默认值

默认值：文本
调用时机/通知时机：初始化SDK之后

支持版本：2.0.0

文本教具的默认值

getInstance

ZegoSuperBoardManager getInstance()

获取 ZegoSuperBoardManager 实例对象。

Declared in ZegoSuperBoardManager.java

获取 ZegoSuperBoardManager 实例对象才能调用 ZegoSuperBoardManager 中的接口方法。

调用时机：集成 ZegoSuperBoard SDK之后，初始化 ZegoSuperBoard SDK 之前。

支持版本：2.0.0 及以上。

ZegoSuperBoardManager 实例对象

getSuperBoardSubViewModelList

List<ZegoSuperBoardSubViewModel> getSuperBoardSubViewModelList()

获取SDK保存的superBoardSubView的信息

Declared in ZegoSuperBoardManager.java

通过superBoardSubViewModelList,可以获取到当前房间内存在的superBoardSubView的数量以及superBoardSubView的信息。

业务场景：进房后需要获取房间内的superBoardSubView列表做展示，在列表中切换当前展示的superBoardSubView。
调用时机/通知时机：初始化 ZegoSuperboard SDK 之后。

支持版本：v2.0.0

SDK保存的superBoardSubView的信息

isCustomCursorEnabled

boolean isCustomCursorEnabled()

是否开启光标显示

Declared in ZegoSuperBoardManager.java

光标是否开启

调用时机：初始化 SDK 之后。

支持版本：2.2.0及以上。

光标是否开启

isEnableResponseScale

boolean isEnableResponseScale()

获取当前是否会响应别的用户同步过来的缩放系数

Declared in ZegoSuperBoardManager.java

获取当前是否会响应别的用户同步过来的缩放系数。

调用时机：当 currentSuperBoardSubView 存在的时候即可调用。

支持版本：2.0.0 及以上。

当前是否会响应别的用户同步过来的缩放系数

isEnableSyncScale

boolean isEnableSyncScale()

获取当前是否会同步缩放系数给别的用户

Declared in ZegoSuperBoardManager.java

获取当前是否会同步缩放系数给别的用户。

调用时机：当 currentSuperBoardSubView 存在的时候即可调用。

支持版本：2.0.0 及以上。

当前是否会同步缩放系数给别的用户

isRemoteCursorVisibleEnabled

boolean isRemoteCursorVisibleEnabled()

远端光标是否开启

Declared in ZegoSuperBoardManager.java

远端光标是否开启

是否必填：是。
调用时机：初始化 SDK 之后。

支持版本：2.2.0及以上。

远端光标是否开启

setCustomText

void setCustomText(String text)

自定义文本教具的默认文本

Declared in ZegoSuperBoardManager.java

参数

名称	类型	描述
text	String	自定义文本教具的默认值

详情

自定义文本教具的默认文本

默认值：文本
调用时机/通知时机：初始化SDK之后，使用文本之前

支持版本：2.0.0 及以上。

setManagerListener

void setManagerListener(IZegoSuperBoardManagerListener listener)

设置SDK方法监听

Declared in ZegoSuperBoardManager.java

参数

名称	类型	描述
listener	IZegoSuperBoardManagerListener	监听白板回调信息

调用时机：init之后

支持版本：2.0.0及以上

uploadFile

int uploadFile(String filePath, ZegoSuperBoardRenderType renderType, IZegoSuperBoardUploadFileListener listener)

上传文件到 ZegoSuperBoard 服务

Declared in ZegoSuperBoardManager.java

参数

名称	类型	描述
filePath	String	需要上传的文件绝对路径，支持 ppt、pdf、xls、jpg、jpeg、png、bmp、txt 等类型的文件，具体参考文件规范。
renderType	ZegoSuperBoardRenderType	上传文件转码后的渲染模式类型，建议设置为 VectorAndIMG，详见 ZegoSuperBoardRenderType。
listener	IZegoSuperBoardUploadFileListener	上传的进度和结果的回调。上传文件的过程中，会收到多次回调，具体请查看 IZegoSuperBoardUploadFileListener 的介绍

详情

上传过程中，SDK 会根据传入的 [renderType] 对文件进行格式转换，格式转换后文件的渲染模式取决于传入的 [renderType]，可在结果回调中获取上传的进度信息。

业务场景：上传文件到ZegoDocs 服务。
调用时机：初始化 ZegoSuperBoard SDK 之后。

支持版本：2.0.0 及以上。
注意事项：上传阶段会有多次回调，详细请查阅 ZegoSuperBoardUploadFileState 定义

返回值

返回上传文件的请求 seq

cancelUploadFile

void cancelUploadFile(int seq, IZegoSuperBoardApiCalledCallback listener)

在上传文件的过程中取消上传动作

Declared in ZegoSuperBoardManager.java

参数

名称	类型	描述
seq	int	调用uploadFile时返回的上传seq。
listener	IZegoSuperBoardApiCalledCallback	取消上传文件结果回调。

详情

执行取消上传文件的操作必须传入对应的上传任务的seq。

业务场景：在上传文件的过程中需要中断对应文件的上传到ZegoDocs service。
调用时机：调用uploadFile接口后正在上传文件过程中的时候调用。

支持版本：2.0.0 及以上。

cacheFile

int cacheFile(String fileID, IZegoSuperBoardCacheFileListener listener)

将文件缓存到本地

Declared in ZegoSuperBoardManager.java

参数

名称	类型	描述
fileID	String	需要缓存的文件 ID
listener	IZegoSuperBoardCacheFileListener	下载文件进度和结果回调

详情

可以把对应文件保存到本地。

业务场景：把文件保存到本地，下次打开不需要请求网络，提升打开速度。
调用时机：需要在 initWithConfig 之后调用。

支持版本：2.0.0 及以上。

返回值

下载文件操作对应的序列号

cancelCacheFile

public void cancelCacheFile(int seq, IZegoSuperBoardApiCalledCallback listener)

在缓存文件的过程中取消缓存动作

Declared in ZegoSuperBoardManager.java

参数

名称	类型	描述
seq	int	缓存操作的序列号。
listener	IZegoSuperBoardApiCalledCallback	取消缓存操作结果回调。

详情

可以取消掉正在缓存文件的操作，需要传入对应缓存文件操作的seq，取消后文件不会被缓存到本地。

业务场景：在执行缓存文件过程中，需要中断当前缓存文件的操作，可以调用cancelCacheFile方法来取消掉对应的操作。
调用时机：需要在 init 之后调用。
相关接口：cacheFile。

支持版本：2.0.0 及以上。

返回值

操作结果

queryFileCached

public void queryFileCached(String fileID, IZegoDocsViewQueryCachedListener listener)

查询文件缓存是否存在

Declared in ZegoSuperBoardManager.java

参数

名称	类型	描述
fileID	String	待查询的文件ID。
listener	IZegoDocsViewQueryCachedListener	查询结果回调。

详情

通过对应文件的ID可以查找到该文件是否本地已经缓存下来了。

业务场景：查询文件缓存是否存在。
调用时机：需要在 init 之后调用。
相关接口：cacheFile。

支持版本：2.0.0 及以上。

uploadH5File

int uploadH5File(String file, ZegoUploadCustomH5Config config, IZegoSuperBoardUploadFileListener listener)

上传自定义H5课件

Declared in ZegoSuperBoardManager.java

参数

名称	类型	描述
file	String	自定义课件的本地路径
config	ZegoUploadCustomH5Config	自定义H5课件相关配置信息
listener	IZegoSuperBoardUploadFileListener	上传的进度的回调。上传文件的过程中，会收到多次回调，具体请查看 IZegoSuperBoardUploadFileListener 的介绍。

详情

上传过程中，SDK 会根据传入的 [config] 对文件进行格式转换，格式转换后文件的宽高页码以及是否带缩略图取决于传入的 [config]，可在结果回调中获取上传的进度信息。

业务场景：上传自定义H5课件。
调用时机：您需要在初始化成功后调用它。

支持版本：2.0.0 及以上。

返回值

返回上传接口请求的seq

setCustomFontFromAsset

void setCustomFontFromAsset(String regularAssetPath, String boldAssetPath)

设置自定义字体源文件路径

Declared in ZegoSuperBoardManager.java

参数

名称	类型	描述
regularAssetPath	String	常规字体的字体名称，请联系技术支持获取
boldAssetPath	String	粗体字体的字体名称，请联系技术支持获取

详情

需要给白板中的文本工具设置新的自定义字体样式。

业务场景：设置自定义新字体。
调用时机：需要在创建纯白板或者文件白板完成之后调用。

支持版本：2.0.0 及以上。
注意事项：只支持特定的字体, 并且需要在工程中内置我们提供的字体文件，请联系技术支持获取字体文件与对应的字体名。

init

void init(Application application, ZegoSuperBoardInitConfig initConfig, IZegoSuperBoardInitCallback callback)

初始化 ZegoSuperBoard SDK

Declared in ZegoSuperBoardManager.java

参数

名称	类型	描述
application	Application	app的appcalition对象
initConfig	ZegoSuperBoardInitConfig	SDK 初始化所需要的配置信息
callback	IZegoSuperBoardInitCallback	初始化的结果回调

详情

初始化ZegoSuperBoard SDK的方法。

业务场景：初始化 ZegoSuperBoard SDK。
调用时机：在调用ZegoExpressEngine SDK的loginRoom接口前。
相关接口：unInit。

支持版本：2.0.0 及以上。

setCustomizedConfig

void setCustomizedConfig(String key, String value)

设置配置项<br/>例如：<br/>key值为 logPath，SDK记录日志的目录地址。<br/>key值为 cachePath，SDK缓存的目录地址。

Declared in ZegoSuperBoardManager.java

参数

名称	类型	描述
key	String	key
value	String	value

调用时机：初始化 Superboard SDK 后调用

支持版本：2.0.0 及以上。

返回值

设置是否成功

enableSuperBoardView

void enableSuperBoardView(boolean enable)

设置是否使用 SuperBoardView

Declared in ZegoSuperBoardManager.java

参数

名称	类型	描述
enable	boolean	YES 代表使用SuperBoardView NO代表不使用, 默认为YES

详情

设置是否使用 SuperBoardView。

调用时机：初始化 SDK 之前。

支持版本：2.0.0 及以上。
注意事项：默认开启

createWhiteboardView

void createWhiteboardView(ZegoCreateWhiteboardConfig config, IZegoSuperBoardCreateCallback callback)

创建纯白板

Declared in ZegoSuperBoardManager.java

参数

名称	类型	描述
config	ZegoCreateWhiteboardConfig	纯白板相关的配置参数
callback	IZegoSuperBoardCreateCallback	创建纯白板的结果回调

详情

创建成功后会内部保存对应的SubView并返回它的 subViewModel 数据

调用时机：初始化 ZegoSuperboard SDK，调用 [loginRoom] 登录房间之后，需要创建纯白板的时候。

支持版本：2.0.0 及以上。

createFileView

void createFileView(ZegoCreateFileConfig config, IZegoSuperBoardCreateCallback callback)

创建文件

Declared in ZegoSuperBoardManager.java

参数

名称	类型	描述
config	ZegoCreateFileConfig	创建文件需要的配置参数
callback	IZegoSuperBoardCreateCallback	创建文件的结果回调

详情

创建成功后会内部保存对应的SubView并返回它的 subViewModel 数据

调用时机：初始化 ZegoSuperboard SDK，调用 [loginRoom] 登录房间之后，需要创建文件的时候。

支持版本：2.0.0 及以上。

destroySuperBoardSubView

void destroySuperBoardSubView(String uniqueID, IZegoSuperBoardDestroyCallback callback)

销毁指定的 SuperBoardSubView 视图

Declared in ZegoSuperBoardManager.java

参数

名称	类型	描述
uniqueID	String	ZegoSuperBoardSubView 对象的唯一标识
callback	IZegoSuperBoardDestroyCallback	销毁指定SuperBoardSubView的结果回调

调用时机：在调用querySuperBoardSubViewList 拉取到列表后或者 superBoardSubViewModelList 获取到model数量大于0的时候调用。

支持版本：2.0.0 及以上。

querySuperBoardSubViewList

void querySuperBoardSubViewList(IZegoSuperBoardQueryListCallback callback)

向服务器查询当前存在的 SuperBoardSubView 列表

Declared in ZegoSuperBoardManager.java

参数

名称	类型	描述
callback	IZegoSuperBoardQueryListCallback	获取SuperBoardSubView列表的结果回调

详情

将当前房间内的白板一次性拉取下来，SDK内部会将关联了文件的白板中的文件也加载下来，这些白板和文件SDK内部会处理对应关系添加到ZegoSuperBoardSubView中，外部只需要使用ZegoSuperBoardView即可。

调用时机：初始化SDK，登录房间之后调用。

支持版本：2.0.0及以上

getSuperBoardSubView

ZegoSuperBoardSubView getSuperBoardSubView(String uniqueID)

获取指定的 SuperBoardSubView

Declared in ZegoSuperBoardManager.java

参数

名称	类型	描述
uniqueID	String	ZegoSuperBoardSubView 对象的唯一标识

调用时机：初始化SDK，进房成功后，获取到SuperBoardSubView列表之后调用。

支持版本：2.0.0及以上
注意事项：仅限于不使用 SuperBoardView （通过 enableSuperBoardView 设置）的场景使用

clearCache

void clearCache()

清除文件和白板相关的缓存资源

Declared in ZegoSuperBoardManager.java

调用时机：初始化，进入房间之后，SDK 对于房间内资源的清理，需要在退出房间前主动调用。

支持版本：2.0.0及以上

clear

void clear()

清空房间内资源退房时调用

Declared in ZegoSuperBoardManager.java

退房时需要清空房间内的缓存信息，以及停止媒体播放。

调用时机：需要在退房前主动调用。

支持版本：2.0.0及以上

unInit

void unInit()

反初始化SDK

Declared in ZegoSuperBoardManager.java

调用时机：当你需要重新初始化SDK时，你必须先调用unInit。

支持版本：2.0.0及以上

getSDKVersion

String getSDKVersion()

获取SDK的版本号

Declared in ZegoSuperBoardManager.java

获取 SDK 版本号。

业务场景：1. SDK 在运行过程中，当开发者发现与预期情况不符时，可将问题与相关日志提交给 ZEGO 技术人员定位，ZEGO 技术人员可能需要 SDK 的版本的信息来辅助定位问题。

开发者也可以收集此信息作为 App 所使用的 SDK 的版本信息，以便统计线上各版本 App 对应的各版本 SDK。

调用时机：在任意时刻均可调用。

支持版本：v2.0.0 及以上。

SDK的版本号

getCustomizedConfig

String getCustomizedConfig(String key)

获取设置的配置项的值

Declared in ZegoSuperBoardManager.java

参数

名称	类型	描述
key	String	要获取的设置项

详情

获取设置的配置项的值。

调用时机：初始化 Superboard SDK，调用 setCustomizedConfig 之后。

支持版本：2.0.0及以上。

getSuperBoardView

ZegoSuperBoardView getSuperBoardView()

获取 SuperBoardView 对象

Declared in ZegoSuperBoardManager.java

开了 SuperBoardView 模式，获取该对象。

业务场景：在开启 SuperBoardView 模式下，使用该对象上的方法进行 A 端切换白板，B 端自动同步。
默认值：默认获得该对象。
调用时机：初始化 ZegoSuperboard SDK 之后。

支持版本：2.0.0及以上。
注意事项：如果使用 enableSuperBoardView 接口并设置为 false ，则无法获取 SuperBoardView 对象。

BoardView 对象

enableSyncScale

void enableSyncScale(boolean enable)

设置是否将缩放同步给房间内其他成员

Declared in ZegoSuperBoardManager.java

参数

名称	类型	描述
enable	boolean

详情

开启之后，可以将本端缩放的发送出去，对端是否要接受，需要对端开启接受缩放。

业务场景：使操作端和接受端的白板缩放同步。
默认值：未调用此接口设置场景时，默认的配置为 false。
调用时机：初始化 ZegSuperboard SDK 之后。
相关回调：对端发生缩放变化，接受端可通过 remoteSuperBoardScaleChanged 监听变化参数。

支持版本：2.0.0及以上。
注意事项：如需实现双端缩放同步，需要同时设置 enableSyncScale 和 enableResponseScale

enableResponseScale

void enableResponseScale()

是否响应房间内其他成员的缩放

Declared in ZegoSuperBoardManager.java

开启之后，可以响应房间内其他成员的缩放，前提是对端将缩放同步给房间内其他成员。

业务场景：使操作端和接受端的白板缩放同步。
默认值：未调用此接口设置场景时，默认的配置为 false。
调用时机：初始化 ZegSuperboard SDK 之后。
相关回调：对端发生缩放变化，接受端可通过 remoteSuperBoardScaleChanged 监听变化参数。

支持版本：2.0.0及以上。
注意事项：如需实现双端缩放同步，需要同时设置 enableSyncScale 和 enableResponseScale

enableHandwriting

void enableHandwriting(boolean enable)

设置是否开启笔锋

Declared in ZegoSuperBoardManager.java

参数

名称	类型	描述
enable	boolean	是否开启笔锋

详情

设置白板涂鸦是否拥有笔锋效果，设置为 true 则该涂鸦带有笔锋效果。

业务场景：根据涂鸦绘制过程中的速度调整笔画粗细和形状，增强书写体验。
默认值：false。
调用时机/通知时机：初始化 SDK 之后。

支持版本：2.0.0及以上。

isHandwritingEnabled

boolean isHandwritingEnabled()

获取是否开启笔锋效果

Declared in ZegoSuperBoardManager.java

当前使用工具类型为画笔时，调用 isHandwritingEnabled 可获得是否开启笔锋效果。

调用时机：初始化 ZegoSuperBoard SDK 之后。

支持版本：2.0.0及以上。

是否开启笔锋效果

setToolType

void setToolType(ZegoSuperBoardTool tool)

设置白板工具类型

Declared in ZegoSuperBoardManager.java

参数

名称	类型	描述
tool	ZegoSuperBoardTool	白板工具。

详情

设置工具类型，使鼠标拥有不同的功能效果。

默认值：默认值 1，默认工具为画笔
调用时机：初始化 ZegSuperBoard SDK 之后。

支持版本：2.0.0及以上。

getToolType

ZegoSuperBoardTool getToolType()

获取正在使用的白板工具类型。

Declared in ZegoSuperBoardManager.java

获取正在使用的白板工具类型

调用时机：初始化 ZegoSuperBoard SDK之后。

支持版本：2.0.0及以上。

返回使用中的工具类型

setFontBold

void setFontBold(boolean bold)

设置文本粗体

Declared in ZegoSuperBoardManager.java

参数

名称	类型	描述
bold	boolean	是否设置文字粗体

详情

选择了文字工具类型，调用 setFontBold 设置为 true之后，在白板上新增的文字都是粗体效果。

默认值：false
调用时机：初始化 ZegoSuperBoard SDK 之后。

支持版本：2.0.0及以上。
注意事项：仅设置文本粗体之后新增的文字拥有粗体效果，如之前白板上已存在文字不会更改为粗体效果。

返回值

设置结果

isFontBold

boolean isFontBold()

获取文本是否为粗体

Declared in ZegoSuperBoardManager.java

当前使用工具类型为文本时，调用 isFontBold 可获得是否设置粗体效果。

调用时机：初始化 ZegoSuperBoard SDK 之后。

支持版本：2.0.0及以上。

是否是粗体效果

setFontItalic

boolean setFontItalic(boolean italic)

设置文本工具的文本是否斜体。

Declared in ZegoSuperBoardManager.java

参数

名称	类型	描述
italic	boolean

详情

设置文本工具的文本是否斜体。

默认值：false
调用时机：初始化 ZegoSuperBoard SDK 之后。

支持版本：2.0.0及以上。
注意事项：仅调用之后新增的文字生效，如之前白板上已存在文字不会更改。

返回值

设置结果

isFontItalic

boolean isFontItalic()

获取文字是否为斜体效果

Declared in ZegoSuperBoardManager.java

当前使用工具类型为文本时，调用 isFontItalic 可获得是否设置斜体效果。

调用时机：初始化 ZegoSuperBoard SDK 之后。

支持版本：2.0.0及以上。

返回是否设置斜体

setFontSize

boolean setFontSize(number fontSize)

设置文本大小

Declared in ZegoSuperBoardManager.java

参数

名称	类型	描述
fontSize	number	字体大小

详情

选择了文字工具类型，调用 setFontSize 设置，在白板上新增的文字都是设置之后的大小。

默认值：24，最大值不得超过 100
调用时机：初始化 ZegoSuperBoard SDK 之后。

支持版本：2.0.0及以上。
注意事项：仅调用 setFontSize 之后新增的文字生效，如之前白板上已存在文字不会更改为字体大小。

返回值

设置结果

getFontSize

number getFontSize()

获取文本大小

Declared in ZegoSuperBoardManager.java

当前使用工具类型为文本时，调用 getFontSize 可获得当前文本工具的字体大小。

调用时机：初始化 ZegoSuperBoard SDK 之后。

支持版本：2.0.0及以上。

字体大小

setBrushSize

boolean setBrushSize(number size)

设置画笔粗细

Declared in ZegoSuperBoardManager.java

参数

名称	类型	描述
size	number	画笔粗细

详情

选择了画笔工具类型，调用 setBrushSize 设置数值，在白板上新增的涂鸦粗细即设置的值。

默认值：6
调用时机：初始化 ZegoSuperBoard SDK 之后。

支持版本：2.0.0及以上。
注意事项：仅设置画笔粗细之后新增的涂鸦拥有新的粗细效果，如之前白板上已存在涂鸦不会更改为粗细。

返回值

设置结果

getBrushSize

number getBrushSize()

获取画笔粗细

Declared in ZegoSuperBoardManager.java

当前使用工具类型为文本时，调用 getBrushSize 可获得画笔粗细。

调用时机：初始化 ZegoSuperBoard SDK 之后。

支持版本：2.0.0及以上。

画笔粗细

setBrushColor

boolean setBrushColor(String color)

设置画笔颜色

Declared in ZegoSuperBoardManager.java

参数

名称	类型	描述
color	String	颜色

详情

选择了画笔工具类型，调用 setBrushColor 之后，白板上新增的涂鸦颜色生效。

默认值：#f54326
调用时机：初始化 ZegoSuperBoard SDK 之后。

支持版本：2.0.0及以上。
注意事项：仅设置画笔颜色之后新增的涂鸦生效，如之前白板上已存在涂鸦不会更改为颜色。

返回值

设置结果

getBrushColor

String getBrushColor()

获取画笔颜色

Declared in ZegoSuperBoardManager.java

当前使用工具类型为画笔时，调用 getBrushColor 可获得当前画笔颜色。

调用时机：初始化 ZegoSuperBoard SDK 之后。

支持版本：2.0.0及以上。

画笔颜色，16 进制 RGBA

ZegoSuperBoardSubView

详情

接口类，用来描述一个纯白板或者文件白板。

业务场景：主要用于对当前展示的白板的操作，设置状态或操作等。

注意事项：需要先登录房间，使用前请先检查是否为空。

Declared in ZegoSuperBoardSubView.java

方法

setCustomCursorAttribute

void setCustomCursorAttribute(ZegoSuperBoardViewCursorType type, ZegoSuperBoardCursorAttribute attribute, IZegoSuperBoardApiCalledCallback listener)

自定义设置本端自定义光标

Declared in ZegoSuperBoardSubView.java

参数

名称	类型	描述
type	ZegoSuperBoardViewCursorType	设置工具类型，目前仅支持设置画笔样式
attribute	ZegoSuperBoardCursorAttribute	光标参数
listener	IZegoSuperBoardApiCalledCallback	回调

详情

设置本端自定义光标的指针图标和指针的热点(即自定义图标的实际点击位置)

是否必填：是。
调用时机：开启本端自定义光标之后。

支持版本：2.2.0及以上。
注意事项：设置指针的热点位置，建议两个小于32的无单位非负数。

getExcelSheetNameList

ArrayList<String> getExcelSheetNameList()

获取 Excel 的 Sheet 名字列表

Declared in ZegoSuperBoardSubView.java

获取这个excel文件的所有sheet表的名字。

业务场景：需要展示excel文件的sheet表的时候，通过这个方法获取这个excel文件的所有sheet表的名字。
调用时机：createFile 成功之后或者拉取列表成功。

支持版本：2.0.0 及以上。
注意事项：对于非excel的文件类型返回一个空的列表。

Excel 文件的 Sheet 名字列表

getThumbnailUrlList

ArrayList<String> getThumbnailUrlList()

获取当前文件的缩略图列表，仅支持 PDF 、PPT、动态 PPT 、H5文件格式

Declared in ZegoSuperBoardSubView.java

如果需要展示文件的预览画面，可以通过这个接口来获取对应的预览图片，然后通过点击预览图片进行翻页。

业务场景：展示文件每一页的预览画面。
调用时机：在文件加载后调用，否则返回一个空列表。

支持版本：2.0.0 及以上。
使用限制：仅支持 PDF 、PPT、动态 PPT 、H5文件格式,其他类型返回一个空的列表。

文件每一页的缩略图的URL地址列表

getPPTNotes

String getPPTNotes(int page)

获取 PPT 指定页码的备注

Declared in ZegoSuperBoardSubView.java

参数

名称	类型	描述
page	int	指定的页码，从1开始

详情

获取 PPT 指定页码的备注。

业务场景：获取 PPT 指定页码的备注。
调用时机：loadFile 成功之后。

支持版本：2.0.0 及以上。
使用限制：仅支持PPT、动态 PPT 文件格式,其他类型返回null。

返回值

该页备注，若没有备注，则返回空字符串

getModel

ZegoSuperBoardSubViewModel getModel()

获取白板对应的model数据

Declared in ZegoSuperBoardSubView.java

获取白板对应的 ZegoSuperBoardSubViewModel 数据。

业务场景：获取白板对应的 ZegoSuperBoardSubViewModel 数据，比如白板ID、名字、关联的文件ID、当前的缩放系数等。
调用时机：初始化 ZegoSuperBoard SDK 之后。

支持版本：2.0.0 及以上。

白板对应的 ZegoSuperBoardSubViewModel 数据

inputText

void inputText(IZegoSuperBoardApiCalledCallback callback)

给白板 View 添加文本,调用后会从白板底部弹出输入框。

Declared in ZegoSuperBoardSubView.java

参数

名称	类型	描述
callback	IZegoSuperBoardApiCalledCallback	操作结果回调,如果有创建图元的权限，则会成功，否则失败

详情

给白板 View 添加文本,调用后会从白板底部弹出输入框。

业务场景：给白板 View 添加文本,调用后会从白板底部弹出输入框。
默认值：输入框的默认内容是 "文本" ，可以通过 [ZegoSuperBoardManager.setCustomText] 设置默认文本，默认显示位置是当前白板范围的中间
相关回调：IZegoSuperBoardApiCalledCallback。
相关接口：ZegoSuperBoardManager.setCustomText。
调用时机：当 currentSuperBoardSubView 存在的时候即可调用。

支持版本：2.0.0 及以上。

addText

void addText(String text, int positionX, int positionY, IZegoSuperBoardApiCalledCallback callback)

向白板添加自定义文本

Declared in ZegoSuperBoardSubView.java

参数

名称	类型	描述
text	String	待添加文本图元的字符串内容
positionX	int	相对所在viewport的左上角的横向偏移，如10，此处的viewport是指可写区域
positionY	int	相对所在viewport的左上角的纵向偏移，如10，此处的viewport是指可写区域
callback	IZegoSuperBoardApiCalledCallback	操作结果回调,如果有创建图元的权限，则会成功，否则失败

详情

在白板view中添加文本,可以指定添加的位置，不会弹出键盘输入框。

业务场景：在白板view指定位置添加文本，会创建一个新的文本图元。
相关回调：IZegoSuperBoardApiCalledCallback。
调用时机：当 currentSuperBoardSubView 存在的时候即可调用。

支持版本：2.0.0 及以上。

undo

void undo()

撤销白板的上一步操作

Declared in ZegoSuperBoardSubView.java

撤销白板的上一步操作。

业务场景：白板的相关操作。
相关接口：redo。
调用时机：当 currentSuperBoardSubView 存在的时候即可调用。

支持版本：2.0.0 及以上。

redo

void redo()

恢复白板上一步撤销的操作

Declared in ZegoSuperBoardSubView.java

恢复白板上一步撤销的操作。

业务场景：白板的相关操作。
相关接口：undo。
调用时机：当 currentSuperBoardSubView 存在的时候即可调用。

支持版本：2.0.0 及以上。

clearCurrentPage

void clearCurrentPage(IZegoSuperBoardApiCalledCallback callback)

清除白板当前页的图元

Declared in ZegoSuperBoardSubView.java

参数

名称	类型	描述
callback	IZegoSuperBoardApiCalledCallback	操作结果回调。如果删除当前页的图元成功，则会返回成功，否则失败

详情

清除白板当前页的图元。

业务场景：白板相关操作。
相关接口：clearAllPage。
调用时机：当 currentSuperBoardSubView 存在的时候即可调用。

支持版本：2.0.0及以上

clearAllPage

void clearAllPage(IZegoSuperBoardApiCalledCallback callback)

清除白板所有页的图元

Declared in ZegoSuperBoardSubView.java

参数

名称	类型	描述
callback	IZegoSuperBoardApiCalledCallback	操作结果回调。如果有删除图元的权限，则会返回成功，否则失败

详情

清除白板所有页的图元。

业务场景：白板相关操作。
相关接口：clearCurrentPage。
调用时机：当 currentSuperBoardSubView 存在的时候即可调用。

支持版本：2.0.0及以上。

setOperationMode

void setOperationMode(int mode)

设置当前白板的操作模式

Declared in ZegoSuperBoardSubView.java

参数

名称	类型	描述
mode	int	操作模式，详情见 ZegoSuperBoardOperationMode。

详情

设置当前白板的操作模式，比如禁止客户端对白板的手势操作。mode 可通过 getMode方法获取，比如 int mode = ZegoSuperBoardOperationMode.Draw.getMode() | ZegoSuperBoardOperationMode.Zoom.getMode()。

业务场景：设置toolType的时候，需要调用这个方法来对白板进行处理。如果需要禁止客户端对白板的手势操作，可以使用这个方法设置成None模式。如果要滚动文件，则设置成滚动模式，其他的白板工具，则设置成绘制模式。
默认值：绘制/缩放模式。
影响范围：设置为滚动模式的时候，此时手势会被识别为滚动，设置为绘制模式的时候，此时手势会被识别为绘制相关的操作。
调用时机：当 currentSuperBoardSubView 存在的时候即可调用。

支持版本：2.0.0及以上。
注意事项：只有当 currentSuperBoardSubView 存在时才可调用，可通过 getCurrentSuperBoardSubView() 方法进行判断 currentSuperBoardSubView 是否存在，否则不会有任何效果。

flipToPage

void flipToPage(int targetPage, IZegoSuperBoardApiCalledCallback callback)

跳转到指定页面

Declared in ZegoSuperBoardSubView.java

参数

名称	类型	描述
targetPage	int	目标页的页码，从1开始
callback	IZegoSuperBoardApiCalledCallback	操作结果回调

详情

跳转到指定页面。

业务场景：指定一个页码进行跳转。
相关回调：IZegoSuperBoardApiCalledCallback。
相关接口：flipToPrePage，flipToNextPage。
调用时机：当 currentSuperBoardSubView 存在的时候即可调用。

支持版本：2.0.0及以上。
注意事项：如果是动态ppt或者H5文件，跳转页面可能需要下载图片，动画资源，因此频繁调用可能会导致需要很久才执行完。

flipToPrePage

void flipToPrePage(IZegoSuperBoardApiCalledCallback callback)

跳转到上一页

Declared in ZegoSuperBoardSubView.java

参数

名称	类型	描述
callback	IZegoSuperBoardApiCalledCallback	操作结果回调

详情

跳转到上一页。

相关回调：IZegoSuperBoardApiCalledCallback。
相关接口：flipToPage，flipToNextPage。
调用时机：当 currentSuperBoardSubView 存在的时候即可调用。

支持版本：2.0.0及以上。
注意事项：如果是动态ppt或者H5文件，跳转页面可能需要下载图片，动画资源，因此频繁调用可能会导致需要很久才执行完。

flipToNextPage

void flipToNextPage(IZegoSuperBoardApiCalledCallback callback)

跳转到下一页

Declared in ZegoSuperBoardSubView.java

参数

名称	类型	描述
callback	IZegoSuperBoardApiCalledCallback	操作结果回调

详情

跳转到下一页。

相关回调：IZegoSuperBoardApiCalledCallback。
相关接口：flipToPage，flipToPrePage。
调用时机：当 currentSuperBoardSubView 存在的时候即可调用。

支持版本：2.0.0及以上。
注意事项：如果是动态ppt或者H5文件，跳转页面可能需要下载图片，动画资源，因此频繁调用可能会导致需要很久才执行完。

preStep

void preStep(IZegoSuperBoardApiCalledCallback callback)

跳转到上一步动画

Declared in ZegoSuperBoardSubView.java

参数

名称	类型	描述
callback	IZegoSuperBoardApiCalledCallback	操作结果回调

详情

跳转到上一步动画。

相关回调：IZegoSuperBoardApiCalledCallback。
相关接口：nextStep。
调用时机：当 currentSuperBoardSubView 存在的时候即可调用。

支持版本：2.0.0及以上。
注意事项：仅仅针对动态ppt或者H5文件，否则不会有任何效果。

getCurrentPage

int getCurrentPage()

获取当前显示的内容的页码

Declared in ZegoSuperBoardSubView.java

获取当前显示的内容的页码。

调用时机：使用 ZegoSuperBoardView 时，当 currentSuperBoardSubView 存在的时候即可调用。不使用 ZegoSuperBoardView 时，当 superBoardSubViewModelList 存在 SuperBoardSubViewModel 的时候即可调用。

支持版本：2.0.0及以上。

当前显示的内容的页码

nextStep

void nextStep(IZegoSuperBoardApiCalledCallback callback)

跳转到下一步动画

Declared in ZegoSuperBoardSubView.java

参数

名称	类型	描述
callback	IZegoSuperBoardApiCalledCallback	操作结果回调

详情

跳转到下一步动画。

相关回调：IZegoSuperBoardApiCalledCallback。
相关接口：preStep。
调用时机：当 currentSuperBoardSubView 存在的时候即可调用。

支持版本：2.0.0及以上。
注意事项：仅仅针对动态ppt或者H5文件，否则不会有任何效果。

getPageCount

int getPageCount()

获取总页码数

Declared in ZegoSuperBoardSubView.java

获取总页码数。

调用时机：使用ZegoSuperBoardView时，当 currentSuperBoardSubView 存在的时候即可调用。不使用ZegoSuperBoardView时，当 superBoardSubViewModelList 存在superBoardSubViewModel的时候即可调用。

支持版本：2.0.0及以上。

总页码数

switchExcelSheet

void switchExcelSheet(int sheetIndex, IZegoSuperBoardSwitchCallback switchCallback)

切换excel文件到指定sheet页

Declared in ZegoSuperBoardSubView.java

参数

名称	类型	描述
sheetIndex	int	excel文件目标sheet表的index
switchCallback	IZegoSuperBoardSwitchCallback	操作结果回调

详情

切换excel文件到指定sheet页。

默认值：打开excel文件的时候，默认是在第0个sheet页。
相关回调：IZegoSuperBoardSwitchCallback。
调用时机：当currentSuperBoardSubView 存在的时候即可调用。

支持版本：2.0.0及以上。

getVisibleSize

Size getVisibleSize()

获取可见区域的大小

Declared in ZegoSuperBoardSubView.java

获取文件可见区域的大小，比如用1000x1000的大小去加载一张64x64的图片，此时可见区域的大小是64x64。

调用时机：当 currentSuperBoardSubView 存在的时候即可调用。

支持版本：2.0.0及以上。
注意事项：如果不是文件白板，会返回0。

可见区域的大小

getCurrentSheetName

String getCurrentSheetName()

获取当前展示的sheet名称

Declared in ZegoSuperBoardSubView.java

获取当前展示的sheet名称,如果不是excel，则返回null。

调用时机：当 currentSuperBoardSubView 存在的时候即可调用。

支持版本：2.0.0及以上。

当前展示的sheet名称

addImage

void addImage(ZegoSuperBoardViewImageType type , String address, int positionX, int positionY, IZegoSuperBoardApiCalledCallback callback)

插入图片到白板

Declared in ZegoSuperBoardSubView.java

参数

名称	类型	描述
type	ZegoSuperBoardViewImageType	图片类型，目前支持普通图片和自定义图形
address	String	图片地址，支持本地图片地址和网络图片地址，本地图片会先上传到cdn存储。目前自定义图形只支持网络图片地址。（网络图片仅支持 https）例："xxxxxxxxxx.png"，"https://xxxxxxxx.com/xxx.png"。
positionX	int	图片插入位置的起始点，相对所在viewport的左上角的横向偏移，如10，此处的viewport是指可写区域。自定义图形直接传 0 即可。
positionY	int	图片插入位置的起始点，相对所在viewport的左上角的纵向偏移，如10，此处的viewport是指可写区域。自定义图形直接传 0 即可。
callback	IZegoSuperBoardApiCalledCallback	添加图片结果回调

详情

插入图片到到白板显示或者设置自定义图形。

业务场景：设置自定义图形后，在选择白板工具为自定义图形时，触摸白板会绘制此处传入的自定义图形
调用时机：当 currentSuperBoardSubView 存在的时候即可调用。

支持版本：2.0.0及以上。
注意事项：支持的图片类型：png/jpg/jpeg，当type为Graphic时，支持本地图片和网络图片，图片大小限制10M，当type为Custom时，只支持网络图片，图片大小限制500KB。

clearSelected

void clearSelected(IZegoSuperBoardApiCalledCallback callback)

删除选中的图元

Declared in ZegoSuperBoardSubView.java

参数

名称	类型	描述
callback	IZegoSuperBoardApiCalledCallback	操作结果回调

详情

通过白板的选择工具选择一些图元，调用这个方法可以删除选中的图元。

相关回调：IZegoSuperBoardApiCalledCallback。
调用时机：获取到SuperBoardSubView列表之后。

支持版本：2.0.0及以上。

setBackgroundImage

void setBackgroundImage(String address, ZegoSuperBoardViewImageFitMode mode, IZegoSuperBoardApiCalledCallback callback)

向白板设置背景图

Declared in ZegoSuperBoardSubView.java

参数

名称	类型	描述
address	String	背景图片路径, 本地路径或者网络路径均可（网络图片仅支持 https）例："xxxxxxxxxx.png"，"https://xxxxxxxx.com/xxx.png"。
mode	ZegoSuperBoardViewImageFitMode	背景图片填充模式
callback	IZegoSuperBoardApiCalledCallback	背景图片设置完成回调

详情

向白板设置背景图，支持本地路径或者网络路径，这个背景图会同步给房间内的其他用户。

相关回调：IZegoSuperBoardApiCalledCallback。
调用时机：获取到SuperBoardSubView列表之后。

支持版本：2.0.0及以上。

clearBackgroundImage

void clearBackgroundImage(IZegoSuperBoardApiCalledCallback callback)

清除白板的背景图

Declared in ZegoSuperBoardSubView.java

参数

名称	类型	描述
callback	IZegoSuperBoardApiCalledCallback	清除背景完成回调

详情

清除白板的背景图，这个动作会同步给房间内的其他用户。

相关回调：IZegoSuperBoardApiCalledCallback。
调用时机：获取到SuperBoardSubView列表之后。

支持版本：2.0.0及以上。

stopPlayPPTVideo

void stopPlayPPTVideo()

停止当前动态ppt页面正在播放的视频

Declared in ZegoSuperBoardSubView.java

停止当前动态ppt页面正在播放的视频,一般用于切换文件时，停止掉动态 PPT 文件的音视频播放。

调用时机：在文件加载成功之后,播放音视频的过程中调用。

支持版本：2.0.0及以上。

setWhiteboardBackgroundColor

void setWhiteboardBackgroundColor(String color)

设置白板的背景颜色

Declared in ZegoSuperBoardSubView.java

参数

名称	类型	描述
color	String	背景颜色

详情

设置白板的背景颜色,比如纯白板设置成灰色等。如果是文件白板，因为会被文件内容覆盖，所以设置不会生效。仅仅在本地生效，不会同步给其他用户。

默认值：rgb(241, 243, 244)
调用时机：初始化 ZegoSuperBoard SDK 之后。

支持版本：2.0.0及以上。

返回值

设置结果

setSizeChangedListener

void setSizeChangedListener(IZegoSuperBoardSizeChangedListener listener)

设置SubView大小改变后的监听

Declared in ZegoSuperBoardSubView.java

参数

名称	类型	描述
listener	IZegoSuperBoardSizeChangedListener	监听SubView大小变化的接口

详情

设置SubView大小改变后的监听。

支持版本：2.0.0及以上。

setScrollChangedListener

void setScrollChangedListener(IZegoSuperBoardScrollChangedListener listener)

设置SubView滚动过程的监听

Declared in ZegoSuperBoardSubView.java

参数

名称	类型	描述
listener	IZegoSuperBoardScrollChangedListener	SubView滚动的监听

详情

设置SubView滚动的监听。

支持版本：2.0.0及以上。

ZegoSuperBoardSubViewModel

详情

数据模型类，里面包含了创建的ZegoSuperBoardSubView的名称、创建时间、包含的文件ID、文件类型以及ZegoSuperBoardSubView 对象的唯一标识。

业务场景：用户获取对应ZegoSuperBoardSubView对象的ID，名称和文件信息。

Declared in ZegoSuperBoardSubViewModel.java

属性

name

public String name

SuperBoardSubView 对应的名称

createTime

public long createTime

白板创建时间 Unix 时间戳(毫秒)

fileID

public String fileID

创建文件白板时使用的文件ID，此 ID 唯一

fileType

public ZegoSuperBoardFileType fileType

创建文件白板时使用的文件类型，详见ZegoSuperBoardFileType

uniqueID

public String uniqueID

SuperBoardSubview的ID，此ID唯一。

whiteboardIDList

public List<String> whiteboardIDList

白板ID的列表

ZegoSuperBoardView

详情

本类主要实现了切换SuperBoardSubView以及 SuperBoardSubView 中Excel文件sheet的功能，初始化SDK后，可以通过ZegoSuperBoardManager获取到ZegoSuperBoardView对象直接使用，通过该类外界不需要再处理ZegoSuperBoardView的切换同步等逻辑，ZegoSuperBoardView会内部处理这些切换同步展示的逻辑。

业务场景：简化接入SDK的复杂度，不想要处理过多的切换ZegoSuperBoardView的逻辑。

注意事项：要使用SuperBoardView需要开启enableSuperBoardView（默认开启）。

Declared in ZegoSuperBoardView.java

方法

getCurrentSuperBoardSubView

ZegoSuperBoardSubView | null getCurrentSuperBoardSubView()

获取当前展示 superBoardSubView

Declared in ZegoSuperBoardView.java

业务场景：如需对当前展示的 superBoardSubView 进行翻页操作等，获取当前展示 superBoardSubView之后调用 superBoardSubView 上的翻页方法。
调用时机：初始化 ZegoSuperBoard SDK 之后。

支持版本：2.0.0 及以上。
注意事项：在开启 superBoardView 模式下生效

当前展示 superBoardSubView

setBoardViewListener

void setBoardViewListener(IZegoSuperBoardViewListener boardViewListener)

设置 ZegoSuperBoardView 的内部变更（大小、滚动等）的监听

Declared in ZegoSuperBoardView.java

参数

名称	类型	描述
boardViewListener	IZegoSuperBoardViewListener	BoardView状态监听接口

详情

设置 ZegoSuperBoardView 的内部变更（大小、滚动等）的监听。

支持版本：2.0.0 及以上。

switchSuperBoardSubView

void switchSuperBoardSubView(String uniqueID, IZegoSuperBoardSwitchCallback callback)

切换到指定的SuperBoardSubView

Declared in ZegoSuperBoardView.java

参数

名称	类型	描述
uniqueID	String	SuperBoardSubView的唯一标识
callback	IZegoSuperBoardSwitchCallback	切换SuperBoardSubView的结果回调

详情

切换到指定SubView，多端同步。

相关回调：IZegoSuperBoardSwitchCallback。

支持版本：2.0.0及以上。

switchSuperBoardSubView

void switchSuperBoardSubView(String uniqueID, int sheetIndex, IZegoSuperBoardSwitchCallback callback)

切换指定的 SuperBoardSubView 到指定的sheet

Declared in ZegoSuperBoardView.java

参数

名称	类型	描述
uniqueID	String	SuperBoardSubView的唯一标识
sheetIndex	int	excel的sheetIndex
callback	IZegoSuperBoardSwitchCallback	切换Excel的结果回调

详情

切换指定的 SuperBoardSubView中Excel到指定的sheet。

业务场景：切换Excel Sheet。
调用时机：文件加载完成之后调用。

支持版本：2.0.0 及以上。
使用限制：仅支持Excel 类型文件。

返回值

操作结果

ZegoUploadCustomH5Config

详情

自定义H5课件属性构造类，可以设置自定义课件的宽、高、页数以及缩略图信息。

业务场景：在上传自定义H5课件接口中需要传入。

Declared in ZegoUploadCustomH5Config.java

属性

width

public int width

是否必填：必填
取值范围：大于0

支持版本：2.0.0及以上

height

public int height

是否必填：必填
取值范围：大于0

支持版本：2.0.0及以上

pageCount

public int pageCount

是否必填：必填
取值范围：大于0

支持版本：2.0.0及以上

thumbnailList

public String[] thumbnailList

支持版本：2.0.0及以上