Interface

2026-01-16


loadOptions	ReloadOptions
Size	uploadOptions
ZegoCreateFileConfig	ZegoCreateWhiteboardConfig
ZegoCursorAttribute	ZegoEvent
ZegoLoadOption	ZegoLogConfig
ZegoSuperBoardCacheFileCallBack	ZegoSuperBoardCacheModel
ZegoSuperBoardCursorTitleStyle	ZegoSuperboardCustomH5Config
ZegoSuperBoardDynamicCacheModel	ZegoSuperBoardErrorData
ZegoSuperBoardInitConfig	ZegoSuperBoardKeydownModel
ZegoSuperBoardLoadFileModel	ZegoSuperBoardMediaModel
ZegoSuperBoardStaticCacheModel	ZegoSuperBoardSubViewModel
ZegoSuperBoardUploadCallback	ZegoSuperBoardUploadH5FileCallback
ZegoSuperBoardUploadModel	ZegoSuperPreviewView
ZegoWhiteboardScaleModel

ReloadOptions

重载配置项

详情

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

支持版本：2.7.1及以后

属性

forceReload

forceReload: boolean

设置是否强制刷新

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

reloadType

reloadType: reloadType

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

是否必填：是。

Size

可见区域的宽高

属性

width

width: number

可视区域的宽度

height

height: number

可视区域的高度

ZegoCreateFileConfig

详情

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

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

属性

fileID

fileID: string

文件对应的ID

是否必填：必填

支持版本：2.0.0及以上

ZegoCreateWhiteboardConfig

详情

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

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

属性

name

name: string

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

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

支持版本：2.0.0及以上

perPageWidth

perPageWidth: number

每页白板的宽度。

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

支持版本：v2.0.0。

perPageHeight

perPageHeight: number

每页白板的高度。

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

支持版本：2.0.0及以上

pageCount

pageCount: number

总页数。

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

支持版本：2.0.0及以上

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](#remote-super-board-sub-view-added-callback)

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

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

remoteSuperBoardSubViewRemoved

remoteSuperBoardSubViewRemoved: [remoteSuperBoardSubViewRemovedCallback](#remote-super-board-sub-view-removed-callback)

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

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

remoteSuperBoardSubViewSwitched

remoteSuperBoardSubViewSwitched: [remoteSuperBoardSubViewSwitchedCallback](#remote-super-board-sub-view-switched-callback)

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

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

remoteSuperBoardAuthChanged

remoteSuperBoardAuthChanged: [remoteSuperBoardAuthChangedCallback](#remote-super-board-auth-changed-callback)

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

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

remoteSuperBoardGraphicAuthChanged

remoteSuperBoardGraphicAuthChanged: [remoteSuperBoardGraphicAuthChangedCallback](#remote-super-board-graphic-auth-changed-callback)

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

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

superBoardSubViewScaleChanged

superBoardSubViewScaleChanged: [superBoardSubViewScaleChangedCallback](#super-board-sub-view-scale-changed-callback)

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

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

superBoardSubViewScrollChanged

superBoardSubViewScrollChanged: [superBoardSubViewScrollChangedCallback](#super-board-sub-view-scroll-changed-callback)

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

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

cacheFile

cacheFile: [cacheFileCallback](#cache-file-callback)

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

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

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

superBoardSubViewMediaPermission

superBoardSubViewMediaPermission: [superBoardSubViewMediaPermissionCallback](#super-board-sub-view-media-permission-callback)

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

superBoardSubViewKeydown

superBoardSubViewKeydown: [superBoardSubViewKeydownCallback](#super-board-sub-view-keydown-callback)

在动态 ppt 中切换为点击工具并点击 ppt 时，此时按下的键盘事件由本回调来触发，不支持左右键盘回调。

方法

errorCallback

errorCallback(error: ZegoSuperBoardErrorData): [](/javascript_web/class/)

监听所有 error 错误

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

remoteSuperBoardAuthChangedCallback

remoteSuperBoardAuthChangedCallback(data: Record<string, number>): [](/javascript_web/class/)

返回白板权限变更对象

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

remoteSuperBoardGraphicAuthChangedCallback

remoteSuperBoardGraphicAuthChangedCallback(data: Record<string, number>): [](/javascript_web/class/)

返回图元权限变更对象

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

remoteSuperBoardSubViewAddedCallback

remoteSuperBoardSubViewAddedCallback(uniqueID: string): [](/javascript_web/class/)

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

名称	类型	描述
uniqueID	string	对端创建的 subView 的 uniqueID

remoteSuperBoardSubViewRemovedCallback

remoteSuperBoardSubViewRemovedCallback(uniqueID: string): [](/javascript_web/class/)

返回对端删除的 subView 的 uniqueID

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

remoteSuperBoardSubViewSwitchedCallback

remoteSuperBoardSubViewSwitchedCallback(uniqueID: string): [](/javascript_web/class/)

返回对端切换的 subView 的 uniqueID

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

superBoardSubViewKeydownCallback

superBoardSubViewKeydownCallback(data: ZegoSuperBoardKeydownModel): [](/javascript_web/class/)

在动态ppt中切换为点击工具并点击ppt时，此时按下的键盘事件由本回调来触发，不支持左右键盘回调。

名称	类型	描述
data	ZegoSuperBoardKeydownModel	返回键盘按键相关信息

superBoardSubViewMediaPermissionCallback

superBoardSubViewMediaPermissionCallback(data: ZegoSuperBoardMediaModel): [](/javascript_web/class/)

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

名称	类型	描述
data	ZegoSuperBoardMediaModel	返回的音视频相关信息

superBoardSubViewScaleChangedCallback

superBoardSubViewScaleChangedCallback(uniqueID: string, scale: number): [](/javascript_web/class/)

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

名称	类型	描述
uniqueID	string	缩放的 subView 的 uniqueID
scale	number	缩放的 subView 的缩放系数

superBoardSubViewScrollChangedCallback

superBoardSubViewScrollChangedCallback(uniqueID: string, page: number, step: number): [](/javascript_web/class/)

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

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

ZegoLoadOption

加载文件配置项

详情

获取动态 PPT 文件加载状态。

属性

PPTReady

PPTReady: boolean

获取动态 PPT 文件加载状态。请先将此参数赋值为 false（默认），当动态 PPT 加载完成后，此参数会转变为 true。

ZegoLogConfig

日志配置选项

详情

本地 log 级别，等级越高，打印日志越少

属性

logLevel

本地 log 级别，等级越高，打印日志越少

ZegoSuperBoardCacheFileCallBack

预加载静态文件进度回调

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

属性

data

data: ZegoSuperBoardStaticCacheModel

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

ZegoSuperBoardCacheModel

预先请求文件资源情况

属性

totalFileNum

totalFileNum: number

该文件预请求总资源数

failedFileNum

failedFileNum: number

该文件预请求失败资源数

ZegoSuperBoardCursorTitleStyle

光标自定义文本信息

详情

设置光标自定义文本信息

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

属性

title

title: string

光标自定义文字内容

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

bold

bold: boolean

光标自定义文本是否加粗

是否必填：否
默认值：false

italic

italic: boolean

光标自定义文本是否斜体

是否必填：否
默认值：false

size

size: number

光标自定义文本字体大小

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

color

color: number

光标自定义文本字体颜色

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

backgroundColor

backgroundColor: number

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

是否必填：否

position

position: ZegoSuperBoardCursorTitlePosition

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

是否必填：否

ZegoSuperBoardDynamicCacheModel

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

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

属性

totalFileNum

totalFileNum: number

该文件总资源数

failedFileNum

failedFileNum: number

该文件预请求失败资源数

ZegoSuperBoardErrorData

错误回调

属性

code

code: ZegoSuperBoardError

错误码

msg

msg: string

错误信息

ZegoSuperBoardInitConfig

详情

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

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

属性

appID

appID: number

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

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

token

token: string

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

parentDomID

parentDomID: string

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

是否必填：是

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

userID

userID: string

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

appSign

appSign: string

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

cacheFolder

cacheFolder: string

缓存目录

logFolder

logFolder: string

日志目录

ZegoSuperBoardKeydownModel

详情

点击动态 PPT 时按下的键盘信息

属性

type

type: string

键盘事件类型，返回 'keydown' 。

code

code: string

触发事件的键的物理键码。例如，"KeyA"表示 A 键。

ctrlKey

ctrlKey: boolean

在触发键盘事件时，是否同时按下了 Ctrl 键，如果按下了 Ctrl 键，则为 true，否则为 false。

key

key: string

触发事件的键的字符，例如，按下 A 键会返回"A"，按下回车键会返回"Enter"。

keyCode

keyCode: number

触发事件的键的键盘码，这是早期的 JavaScript 事件对象中用于识别键盘按键的一个属性，但已经被 code 属性取代。如需了解 keyCode 与键的对应关系，请参考 MDN Web Docs KeyboardEvent.keyCode 文档。

shiftKey

shiftKey: boolean

在触发键盘事件时，是否同时按下了Shift键，如果按下了 Shift 键，则为 true，否则为 false。

metaKey

metaKey: boolean

在触发键盘事件时，是否同时按下了Meta 键，如果按下了Meta键，则为 true，否则为 false。Meta 键在 Windows 操作系统中为 Windows 键，在 macOS 中为 Command 键

altKey

altKey: boolean

在触发键盘事件时，是否同时按下了 Alt 键，如果按下了Alt键，则为 true，否则为 false。

page

page: number

当前处于的页数.

step

step: number

当前处于的步数.

maxStep

maxStep: number

该页最大步数.

ZegoSuperBoardLoadFileModel

预览文件加载回调返回结果

详情

预览文件加载回调返回结果

属性

parent

parent: string

父容器ID

fileID

fileID: string

预览文件ID

fileName

fileName: string

预览文件的文件名

fileType

fileType: ZegoSuperBoardPreviewFileType

预览文件类型

pageCount

pageCount: number

文件内容页数

width

width: number

文件宽度

height

height: number

预览文件高度

viewID

viewID: string

白板挂载容器的ID

sheets

sheets: string[]

Excel 包含的 Sheet 列表

name

name: string

Excel文件名

seq

seq: number

服务端seq

fileHash

fileHash: string

文件内容hash

fileUrls

fileUrls: string[]

文件url列表

ZegoSuperBoardMediaModel

动态 PPT 中播放异常的音视频信息

属性

id

id: string

资源节点 ID

type

type: string

资源类型，返回 'video' 或者 'audio'

fileType

fileType: ZegoSuperBoardFileType

文件类型

ct

ct: number

播放进度，若 type 为 'video' 则会返回

ZegoSuperBoardStaticCacheModel

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

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

属性

seq

seq: number

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

state

state: CacheState

文件当前缓存状态

totalFileNum

totalFileNum: number

该文件总资源数

failedFileNum

failedFileNum: number

该文件预请求失败资源数

loadedFileNum

loadedFileNum: number

该文件预请求成功资源数

ZegoSuperBoardSubViewModel

详情

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

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

属性

name

name: string

SuperBoardSubView 对应的名称

createTime

createTime: number

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

fileID

fileID: string

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

fileType

fileType: ZegoSuperBoardFileType

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

uniqueID

uniqueID: string

SuperBoardSubview的ID，此ID唯一。

whiteboardIDList

whiteboardIDList: string[]

白板ID的列表

ZegoSuperBoardUploadCallback

上传的进度和结果的回调

属性

data

data: ZegoSuperBoardUploadModel

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

ZegoSuperBoardUploadH5FileCallback

上传 H5 文件产生的回调

属性

data

data: ZegoSuperBoardUploadModel

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

ZegoSuperBoardUploadModel

uploadFile 方法产生的回调返回的相关参数

属性

status

status: ZegoSuperBoardUploadFileState

文件上传、转码状态

uploadPercent

uploadPercent: number

上传进度

fileID

fileID: string

转换完成后才会有 fileID

fileHash

fileHash: string

文件内容 hash

taskID

taskID: string

文件转码任务ID

loaded

loaded: number

已经上传的数据长度，单位 Bytes，文件上传中存在

total

total: number

预期需要上传的数据总长度，单位 Bytes，文件上传中存在

ZegoSuperPreviewView

createPreviewFIleView，getCurrentPreview，getPreviewList函数返回值的相关参数

详情

createPreviewFIleView，getCurrentPreview，getPreviewList函数返回值的相关参数

方法

flipPage

flipPage(page: number, step?: number): void

跳转到动态 PPT 指定页面的指定步骤

参数

名称	类型	描述
page	number	跳转目标页，页码从 1 开始。
step	number	目标页的步骤序号，步骤从 1 开始。

详情

跳转到动态 PPT 指定页面并播放该页面的指定动画步骤

支持版本：2.19.0

getContentSize

getContentSize(): Size

获取文档内容的宽高

获取文档内容的宽高。

支持版本：2.19.0

文档内容的宽高。

getCurrentPage

getCurrentPage(): number

获取当前展示的文件页码

支持版本：2.19.0及以上

当前展示的文件页码

getFileID

getFileID(): string

获取文件ID

支持版本：2.19.0

文件ID

getFileType

getFileType(): ZegoSuperBoardPreviewFileType

获取文件类型

支持版本：2.19.0及以上

文件类型对应的数字

getPPTNotes

getPPTNotes(page: number): string

获取 PPT 指定页码的备注

参数

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

详情

获取 PPT 指定页码的备注。

支持版本：2.19.0

返回值

该页备注，若没有备注，则返回 ""

getPageCount

getPageCount(): number

获取当前已加载文件的总页数。

支持版本：2.19.0及以上

当前已加载文件的总页数。

getThumbnailUrlList

getThumbnailUrlList(): Array<string>

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

支持版本：2.19.0

文件缩略图 URL 列表

getVerticalPercent

getVerticalPercent(): number

获取当前纵向偏移（垂直滚动条）的百分比

支持版本：2.19.0及以上

当前纵向偏移（垂直滚动条）的百分比，取值范围 0.00 - 1.00。

getVisibleSize

getVisibleSize(): Size

获取当前文件可见区域的宽高

当前文件可见区域的宽高，在当前 View 下的可见区域的大小，不是原始的 Size

支持版本：2.19.0

当前文件可见区域的宽高，在当前 View 下的可见区域的大小，不是原始的 size

loadFile

loadFile(fileID: string, authKey: string, listener?: onLoadFileCallBack, loadOption: ZegoLoadOption): void

加载并渲染文件

参数

名称	类型	描述
fileID	string	文件ID
authKey	string	鉴权信息。
listener	onLoadFileCallBack	监听预览文件加载操作。
loadOption	ZegoLoadOption	加载文件配置项。

详情

加载并渲染文件

支持版本：2.19.0

nextStep

nextStep(): void

动态ppt的下一步

支持版本：2.19.0

onLoadFileCallBack

onLoadFileCallBack(data: ZegoSuperBoardLoadFileModel): void

加载预览文件回调

参数

名称	类型	描述
data	ZegoSuperBoardLoadFileModel	预览文件加载回调返回结果

详情

加载预览文件回调。

支持版本：2.19.0

playAnimation

playAnimation(animationInfo: number): void

播放动态 PPT 的动画

参数

名称	类型	描述
animationInfo	number	播放动画的信息

详情

当用户直接点击到动态 PPT 上播放动画的元素时候，会回调 onPlayAnimation(String animationInfo) 。其中参数 animationInfo 为播放该动画的信息。可以通过 playAnimation(String animationInfo) 传入该参数，达到相同播放动画的效果。（注意：playAnimation 方法执行之后，并不会产生 onPlayAnimation 回调。

支持版本：2.19.0

previousStep

previousStep(): void

动态 PPT 的上一步

返回动态 PPT 的上一步

支持版本：2.19.0

reloadView

reloadView(options: ReloadOptions): void

重新加载文件 View

参数

名称	类型	描述
options	ReloadOptions	重新加载配置。

详情

重新加载文件 View

支持版本：2.19.0

scrollTo

scrollTo(verticalPercent: number): void

按百分比跳转至文件的特定位置。

参数

名称	类型	描述
verticalPercent	number	参数取值范围 0.00 ~ 1.00 ，例如要跳转到文件一半的位置，则传入参数为 0.50。

详情

按百分比跳转至文件的特定位置。

支持版本：2.19.0

setScaleFactor

setScaleFactor(scaleFactor: number, scaleOffsetX: number, scaleOffsetY: number): void

缩放当前预览视图

参数

名称	类型	描述
scaleFactor	number	缩放比例，取值需大于 1。
scaleOffsetX	number	缩放偏移量X
scaleOffsetY	number	缩放偏移量Y

详情

缩放当前预览视图。

支持版本：2.19.0

stopPlay

stopPlay(pageNumber: number): void

停止本端动态 PPT 文件某一页的音视频播放

参数

名称	类型	描述
pageNumber	number	pageNumber 当为 0 时，表示停止掉当前页的音视频，否则，停止掉指定页的音视频

详情

该接口的使用场景一般用于切换文件时，停止掉上个动态 PPT 文件的音视频播放

支持版本：2.19.0

switchSheet

switchSheet(index: number): void

将 Excel 文件切换到指定 sheet。

参数

名称	类型	描述
index	number	index sheet 的下标，从 0 开始。

详情

将Excel文件切换到指定sheet

支持版本：2.19.0

unloadFile

unloadFile(): void

将文件从视图中卸载

将文件从视图中卸载。

调用时机：loadFile 成功之后。

支持版本：2.19.0

ZegoSuperboardCustomH5Config

详情

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

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

属性

width

width: number

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

支持版本：2.0.0及以上

height

height: number

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

支持版本：2.0.0及以上

pageCount

pageCount: number

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

支持版本：2.0.0及以上

thumbnailList

thumbnailList: string[]

支持版本：2.0.0及以上

ZegoWhiteboardScaleModel

缩放信息

属性

scaleFactor

scaleFactor: number

当前的缩放系数

scaleOffsetX

scaleOffsetX: number

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

scaleOffsetY

scaleOffsetY: number

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

loadOptions

加载文件配置

详情

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

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

属性

PPTReady

PPTReady: boolean

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

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

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

uploadOptions

上传文件配置项

详情

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

属性

renderImgType

renderImgType: RenderImgType

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