类型: interface

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

• 类型

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

• 参数

  • event

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

    • 成员

      名称	类型	描述
      errorCode	ErrorCode	错误码
      message	string | undefined

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

• 类型

  (event: { errorCode: any;}) => void
  ts

• 参数

  • event

    类型: { errorCode: any; }

    • 成员

      名称	类型	描述
      errorCode	any	错误码

告警回调

• 类型

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

• 参数

  • event

    类型: { errorCode: ErrorCode; }

    • 成员

      名称	类型	描述
      errorCode	ErrorCode	告警码

用户加入房间

• 类型

  (event: { room_id: string; user_id: string; code: ErrorCode | string; message: string;}) => void
  ts

• 注意

  本端调用 joinRoom 后触发本回调

• 参数

  • event

    类型: { room_id: string; user_id: string; code: ErrorCode | string; message: string; }

    • 成员

      名称	类型	描述
      room_id	string	房间ID
      user_id	string	用户ID
      code	string	错误码
      message	string	进房信息

本端调用 joinRoom 进房的结果回调。

• 类型

  (event: { room_id: string; user_id: string; error_code: string; is_rejoin: boolean; message: string;}) => void
  ts

• 参数

  • event

    类型: { room_id: string; user_id: string; error_code: string; is_rejoin: boolean; message: string; }

    进房事件

    • 成员

      名称	类型	描述
      room_id	string	房间 ID
      user_id	string	用户 ID
      error_code	string	错误码。0： 成功。
      is_rejoin	boolean	是否重进房
      message	string	进房信息

本端调用 leaveRoom 的退房结果回调。

• 类型

  (event: { room_id: string; error_code: number;}) => void
  ts

• 参数

  • event

    类型: { room_id: string; error_code: number; }

    • 成员

      名称	类型	描述
      room_id	string	房间 ID
      error_code	number	错误码。0： 成功。

回放状态回调​

• 类型

  (event: { state: PlaybackState; reason: number; data?: number[];}) => void
  ts

• 参数

  • event

    类型: { state: PlaybackState; reason: number; data?: number[] | undefined; }

    • 成员

      名称	类型	描述
      state	PlaybackState	播放状态
      reason	number	状态原因
      data	number[] | undefined	回放数据

回放进度回调

• 类型

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

• 参数

  • event

    类型: { progress: number; }

    • 成员

      名称	类型	描述
      progress	number	回放进度 0-1

回放数据加载完毕回调

• 类型

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

• 参数

  • event

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

    回放数据加载完毕回调事件

    • 成员

      名称	类型	描述
      startTimestamp	number	回放开始时间戳
      endTimestamp	number	回放结束时间戳

白板创建回调。进房后自动创建白板。

• 类型

  (event: { white_board: IWhiteBoard; boardInfo: GetBoardInfoResponse; elapsed: number;}) => void
  ts

• 参数

  • event

    类型: { white_board: IWhiteBoard; boardInfo: GetBoardInfoResponse; elapsed: number; }

    • 成员

      名称	类型	描述
      white_board	IWhiteBoard	白板实例
      boardInfo	GetBoardInfoResponse	白板信息
      elapsed	number	从进房成功到该回调的时长

调用 getBoardInfo 后触发本回调，返回当前房间内的白板信息。

• 类型

  (event: { boardInfo: GetBoardInfoResponse;}) => void
  ts

• 参数

  • event

    类型: { boardInfo: GetBoardInfoResponse; }

    返回白板信息后，SDK 将自动创建白板对象。
    如果当前房间没有白板，需要调用 createWhiteBoard 创建一个白板。

    • 成员

      名称	类型	描述
      boardInfo	GetBoardInfoResponse	白板信息响应

当有用户进房或退房时，房间内其他端收到本回调

• 类型

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

• 参数

  • event

    类型: { count: number; }

    有用户进房或退房

    • 成员

      名称	类型	描述
      count	number	房间内当前用户人数

回调 SDK 与信令服务器连接状态相关事件。当 SDK 与信令服务器的网络连接状态改变时回调该事件。

• 类型

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

• 注意

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

• 参数

  • event

    类型: { state: ConnectionState; }

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

    • 成员

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

当前活跃的白板被改变

• 类型

  (event: { activeBoardId: number; whiteBoard: IWhiteBoard;}) => void
  ts

• 参数

  • event

    类型: { activeBoardId: number; whiteBoard: IWhiteBoard; }

    当前活跃的白板变更事件

    • 成员

      名称	类型	描述
      activeBoardId	number	当前白板 ID
      whiteBoard	IWhiteBoard	当前白板实例

关闭白板回调

• 类型

  (event: { white_board: IWhiteBoard; boardId: number;}) => void
  ts

• 参数

  • event

    类型: { white_board: IWhiteBoard; boardId: number; }

    关闭白板事件

    • 成员

      名称	类型	描述
      white_board	IWhiteBoard	已关闭的白板
      boardId	number	关闭的白板 ID

类型: interface

白板初始化时回调白板信息。

• 类型

  (events: IonInitBoard) => void
  ts

• 参数

  • events

    类型: IonInitBoard

    白板初始化信息。

已创建一个新页面回调。

• 类型

  (events: { boardId: number; pages: PageInfo[]; insertPageId: string; currentPageId: string; createComplete?: boolean; taskId?: string;}) => void
  ts

• 注意

  调用 createPage 后在本端和远端触发本回调。

• 参数

  • events

    类型: { boardId: number; pages: PageInfo[]; insertPageId: string; currentPageId: string; createComplete?: boolean | undefined; taskId?: string | undefined; }

    刚创建的白板页面。

    • 成员

      名称	类型	描述
      boardId	number	刚创建的白板页面所属board。
      pages	PageInfo[]	刚创建的白板页面信息。
      insertPageId	string	刚创建的白板页面 ID。
      currentPageId	string	当前页面 ID。
      createComplete	boolean | undefined	是否所有批次都创建完毕
      taskId	string | undefined	批量创建的批次号

翻页回调。

• 类型

  (events: { currentPageId: string; pages: PageInfo[];}) => void
  ts

• 注意

  本端或远端调用 flipPage 后触发本回调。调用 createPage 和 createPages 插入新页面并设置为自动翻页时，也会触发本回调。

• 参数

  • events

    类型: { currentPageId: string; pages: PageInfo[]; }

    • 成员

      名称	类型	描述
      currentPageId	string	当前页面 ID。
      pages	PageInfo[]	页面信息。

删除页面回调。

• 类型

  (events: { boardId: number; pages: PageInfo[]; currentPageId: string;}) => void
  ts

• 注意

  本端或远端调用 removePages 后触发本回调。

• 参数

  • events

    类型: { boardId: number; pages: PageInfo[]; currentPageId: string; }

    • 成员

      名称	类型	描述
      boardId	number	刚创建的白板页面所属board。
      pages	PageInfo[]	页面信息。
      currentPageId	string	当前页面 ID。

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

• 类型

  (events: { currentIndex: number;}) => void
  ts

• 注意

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

• 参数

  • events

    类型: { currentIndex: number; }

    当前页发生改变事件。

    • 成员

      名称	类型	描述
      currentIndex	number	当前页面索引。

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

• 类型

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

• 注意

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

• 参数

  • events

    类型: { totalCount: number; }

    页数发生改变事件。

    • 成员

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

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

• 类型

  (events: { pageId: string; bkInfo: WebBoardInfo['bkInfo'];}) => void
  ts

• 注意

  调用 changePageBackground 后在本端和远端触发本回调。

• 参数

  • events

    类型: { pageId: string; bkInfo: WebBoardInfo['bkInfo']; }

    页面背景发生改变事件。

    • 成员

      名称	类型	描述
      pageId	string	被修改的页面 ID。
      bkInfo	BackgroundInfoCache | undefined	背景信息。

修改白板默认背景回调。

• 类型

  (events: { bkInfo: WebBoardInfo['bkInfo'];}) => void
  ts

• 注意

  • 调用 changeBoardBackground 后在本端和远端触发本回调。
  • 默认背景将应用在所有页面上。调用 changePageBackground 可以设置单个白板页面背景。

• 参数

  • events

    类型: { bkInfo: WebBoardInfo['bkInfo']; }

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

    • 成员

      名称	类型	描述
      bkInfo	BackgroundInfoCache | undefined	背景设置。

当内部发生警告信息时回调该事件。

• 类型

  (events: { reason: string;}) => void
  ts

• 参数

  • events

    类型: { reason: string; }

    • 成员

      名称	类型	描述
      reason	string	告警详情。

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

• 类型

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

• 参数

  • events

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

    • 成员

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

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

• 类型

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

• 注意

  用户对白板进行编辑，也包括调用 redo 和 undo 接口，都会触发本回调。

• 参数

  • events

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

    • 成员

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

锁定画板图形。

• 类型

  (events: { lockObjId: string; reason: LockBoardElementReason;}) => void
  ts

• 参数

  • events

    类型: { lockObjId: string; reason: LockBoardElementReason; }

    • 成员

      名称	类型	描述
      lockObjId	string	是否锁定。
      reason	LockBoardElementReason	锁定原因。

错误回调。

• 类型

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

• 参数

  • events

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

    错误事件。

    • 成员

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

加载画面回调。

• 类型

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

• 参数

  • events

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

    画面加载事件。

    • 成员

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

白板清空回调。

• 类型

  (events: {}) => void
  ts

• 注意

  调用 clearPage 后触发本回调。

• 参数

  • events

    类型: {}

    白板清空事件。

当触发zoom相关操作时触发

• 类型

  (events: { zoom: number; centerPoint: { offset_x: number; offset_y: number; };}) => void
  ts

• 注意

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

• 参数

  • events

    类型: { zoom: number; centerPoint: { offset_x: number; offset_y: number;}; }

    zoom相关信息触发了。

    • 成员

      名称	类型	描述
      zoom	number
      centerPoint	{ offset_x: number; offset_y: number; }
      centerPoint.offset_x	number
      centerPoint.offset_y	number