IWhiteBoardRoomEvents

类型： interface

onError

当内部发生错误信息时回调该事件

类型

(event: { errorCode: ErrorCode; message?: string;}) => void
ts

参数

event

类型： { errorCode: ErrorCode; message?: string | undefined; }

成员

名称	类型	描述
errorCode	`ErrorCode`	错误码
message	`string \| undefined`	错误提示

onPlaybackStateChanged

当白板录像播放状态发生改变时触发此回调

类型

(event: { state: PlaybackState; reason: PlaybackReason;}) => void
ts

参数

event

类型： { state: PlaybackState; reason: PlaybackReason; }

成员

名称	类型	描述
state	`PlaybackState`	播放状态
reason	`PlaybackReason`	状态原因

onPlaybackProgressUpdate

白板录像播放进度回调。调用 start 后触发本回调 200 ms 一次。

类型

(event: { progress: number; duration: number;}) => void
ts

参数

event

类型： { progress: number; duration: number; }

白板录像播放进度提示

成员

名称	类型	描述
progress	`number`	白板录像播放进度，单位秒
duration	`number`	总播放时长，单位秒

onPlaybackDataLoaded

录像加载成功回调

类型

(event: { startTimestamp: number; endTimestamp: number;}) => void
ts

参数

event

类型： { startTimestamp: number; endTimestamp: number; }

录像加载成功事件

成员

名称	类型	描述
startTimestamp	`number`	回放开始时间，为精确到毫秒的 UNIX 时间戳
endTimestamp	`number`	回放结束时间，为精确到毫秒的 UNIX 时间戳

onCreateWhiteBoard

白板创建回调。调用 createWhiteBoard 成功创建白板后，房间内所有用户收到本回调。

类型

(event: CreateWhiteBoardResult) => void
ts

参数

event

类型： CreateWhiteBoardResult

白板创建成功事件

onConnectionStateChanged

SDK 与信令服务器连接状态回调。当 SDK 与信令服务器的网络连接状态改变时触发。

注意

更多信息参见连接状态提示。

类型

(event: { state: ConnectionState;}) => void
ts

参数

event

类型： { state: ConnectionState; }

SDK 与信令服务器连接状态相关事件。

成员

名称	类型	描述
state	`ConnectionState`	当前 SDK 与信令服务器连接状态。

onCurrentWhiteBoardChanged

当前白板被更换时，房间内其他用户收到本回调。

类型

(event: SwitchBoardResult) => void
ts

参数

event

类型： SwitchBoardResult

当前白板更换事件

onRemoveWhiteBoard

白板被删除时，房间内其他用户收到本回调。

类型

(event: RemoveWhiteBoardResult) => void
ts

参数

event

类型： RemoveWhiteBoardResult

白板删除事件

IWhiteBoardEvents

类型： interface

onBoardBackgroundChanged

修改白板默认背景回调。

注意

调用 setBoardBackground 后，房间中所有用户将收到本回调。
默认背景将应用在所有页面上。调用 setPageBackground 可以设置单个白板页面背景。

类型

(event: SetBoardBackgroundResult) => void
ts

参数

event

类型： SetBoardBackgroundResult

默认页面背景发生改变事件。

onBoardLock

当白板锁定状态发生改变时，将触发该回调。

类型

(event: { lock: boolean; reason: LockBoardReason;}) => void
ts

参数

event

类型： { lock: boolean; reason: LockBoardReason; }

成员

名称	类型	描述
lock	`boolean`	锁定状态
reason	`LockBoardReason`	锁定原因。

onCreatePagesProgress

已创建一个新页面回调。

注意

调用 createPages 后，房间中所有用户将收到本回调。

类型

(event: CreatePageProgressResult) => void
ts

参数

event

类型： CreatePageProgressResult

刚创建的白板页面。

onRemovePages

删除页面回调。

注意

调用 removePages 后，房间中所有用户将收到本回调。

类型

(event: RemovePagesResult) => void
ts

参数

event

类型： RemovePagesResult

onClearPage

白板清空回调。

注意

调用 clearPage 后，房间中所有用户将收到本回调。

类型

(event: {}) => void
ts

参数

event

类型： {}

白板清空事件。

onPageIndexChanged

当前页发生改变时触发此回调，例如，翻页或删除操作。监听本回调及时更新 UI 画面。

注意

成功调用 flipPage、flipNextPage、flipPrevPage 或 removePages 后，在本端和远端触发本回调。

类型

(event: FlipPageResult) => void
ts

参数

event

类型： FlipPageResult

当前页发生改变事件。

onPageCountChanged

总页数发生改变时触发此回调，例如，创建新页面或删除操作。监听本回调及时更新 UI 画面。

注意

成功调用 createPages 或 removePages 后，在本端和远端触发本回调。

类型

(event: { totalCount: number;}) => void
ts

参数

event

类型： { totalCount: number; }

页数发生改变事件

成员

名称	类型	描述
totalCount	`number`	新的总页数

onPageBackgroundChanged

页面背景信息修改时触发该回调。

注意

调用 setPageBackground 后，房间中所有用户将收到本回调。

类型

(event: SetPageBackgroundResult) => void
ts

参数

event

类型： SetPageBackgroundResult

页面背景改变事件

onRecordUpdated

白板操作记录堆栈变化回调。

注意

用户对白板进行编辑，也包括调用 redo 和 undo 接口，本端会收到本回调。

类型

(event: { offset: number; stackLength: number;}) => void
ts

参数

event

类型： { offset: number; stackLength: number; }

白板操作记录堆栈变化详情

成员

名称	类型	描述
offset	`number`	当前操作数量位移量。初始值为 -1。每次操作 offset + 1，包括调用一次 redo。每次调用 undo，offset - 1。
stackLength	`number`	全部堆栈。

onError

错误回调。

类型

(event: { errorCode: ErrorCode; message?: string;}) => void
ts

参数

event

类型： { errorCode: ErrorCode; message?: string | undefined; }

错误事件。

成员

名称	类型	描述
errorCode	`ErrorCode`	错误码。
message	`string \| undefined`	错误提示。

onImageLoading

加载图片时触发，包含背景图片和白板页中的图片元素，例如设置背景图片和切换白板时。

注意

在加载白板背景时触发一次。
使用静态转码功能时，本质也是将图片设置为页面背景，因此也有可能触发本回调。

类型

(event: { status: ImageLoadStatus; pageId: string; boardId: number; imageUrl: string;}) => void
ts

参数

event

类型： { status: ImageLoadStatus; pageId: string; boardId: number; imageUrl: string; }

图片加载事件。

成员

名称	类型	描述
status	`ImageLoadStatus`	图片加载状态。
pageId	`string`	页面 ID。
boardId	`number`	白板 ID。
imageUrl	`string`	图片 URL 地址。

onZoomInfoChanged

本端成功调用视图缩放接口时触发本回调。

注意

当触发任何和zoom相关事件时，都会触发

类型

(event: ZoomInfoChangedEvent) => void
ts

参数

event

类型： ZoomInfoChangedEvent

当前白板的缩放信息改变事件

onPptStepChanged

PPT 当前动画步数改变时触发本回调。任何与 PPT 动画步数相关事件发生时，都会触发本回调。

注意

成功调用 pptNextStep 或 pptPrevStep 后，在本端和远端触发一次本回调。

类型

(event: PptStepChangedEvent) => void
ts

参数

event

类型： PptStepChangedEvent

PPT 当前动画步数改变事件