IWhiteBoardRoomEvents

类型: interface

• API

onError()

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

• 类型

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

• 参数

• event

  类型: { errorCode: ErrorCode; }

  • 成员

  名称	类型	描述
  errorCode	ErrorCode	错误码

onVRTCError()

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

• 类型

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

• 参数

• event

  类型: { errorCode: any; }

  • 成员

  名称	类型	描述
  errorCode	any

onWarning()

告警回调

• 类型

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

• 参数

• event

  类型: { errorCode: ErrorCode; }

  • 成员

  名称	类型	描述
  errorCode	ErrorCode	告警码

onLoginResult()

用户加入房间

• 类型

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

• 注意

本端调用 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	进房信息

onJoinRoomResult()

用户加入房间

• 类型

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

• 注意

本端调用 joinRoom 后触发本回调

• 参数

• 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	错误码
  is_rejoin	boolean	是否重进房
  message	string	进房信息

onLeaveRoomResult()

用户加入房间

• 类型

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

• 注意

本端调用 leaveRoom 后触发本回调

• 参数

• event

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

  • 成员

  名称	类型	描述
  room_id	string	房间ID
  error_code	number	错误码

onPlaybackWhiteBoardStateChanged()

回放状态回调​

• 类型

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

• 参数

• event

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

  • 成员

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

onPlaybackWhiteBoardProgressUpdate()

回放进度回调

• 类型

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

• 参数

• event

  类型: { progress: number; }

  • 成员

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

onCreateWhiteBoard()

用户创建新白板回调(WhiteBoard)

• 类型

ts (event: { white_board: WhiteBoard; boardInfo: { pages: WebPageInfo[]; status: StatusType; }; elapsed: number;}) => void

• 参数

• event

  类型: { white_board: WhiteBoard; boardInfo: { pages: WebPageInfo[]; status: StatusType;}; elapsed: number; }

  • 成员

  名称	类型	描述
  white_board	WhiteBoard	单个白板
  boardInfo	{ pages: WebPageInfo[]; status: StatusType; }	白板信息
  boardInfo.pages	WebPageInfo[]	页面信息
  boardInfo.status	StatusType	状态类型
  elapsed	number	从进房成功到该回调的时长

onGetBoardInfo()

获取白板信息回调

• 类型

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

• 注意

调用 getBoardInfo 后触发本回调

• 参数

• event

  类型: { boardInfo: GetBoardInfoResponse; }

  • 成员

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

IWhiteBoardEvents

类型: interface

• API

onInitBoard()

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

• 类型

ts (events: IonInitBoard) => void

• 参数

• event

  类型: IonInitBoard

onCreatePages()

创建新页

• 类型

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

• 注意

调用 createPage 接口后触发本回调。

• 参数

• event

  类型: { pages: WebPageInfo[]; insertPageId: string; currentPageId: string; }

  • 成员

  名称	类型	描述
  pages	WebPageInfo[]	页面信息
  insertPageId	string	插入页面 ID
  currentPageId	string	当前页面 ID

onFlipPage()

翻页

• 类型

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

• 注意

调用 flipPage 接口后触发本回调。

• 参数

• event

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

  • 成员

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

onRemovePages()

删除页

• 类型

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

• 注意

调用 removePages 接口后触发本回调。

• 参数

• event

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

  • 成员

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

onPageIndexChanged()

当前页发生改变时通知（跳转或删除），以便更新 UI

• 类型

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

• 注意

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

• 参数

• events

  类型: { currentIndex: number; }

  当前页发生改变事件

  • 成员

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

onPagesCountChanged()

总页数发生改变时通知（添加或删除），以便更新 UI

• 类型

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

• 注意

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

• 参数

• events

  类型: { totalCount: number; }

  页数发生改变事件

  • 成员

  名称	类型	描述
  totalCount	number	总页面

onChangePageBackground()

页面背景信息被修改回调

• 类型

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

• 注意

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

• 参数

• events

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

  页面背景发生改变事件

  • 成员

  名称	类型	描述
  pageId	string	页面 ID
  bkInfo	BackgroundInfoCache	白板背景设置

onChangeBoardBackground()

修改白板默认背景回调。

• 类型

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

• 注意

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

• 默认背景将应用在所有页面上。调用 changePageBackground 可以设置单个白板页面背景。

• 参数

• events

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

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

  • 成员

  名称	类型	描述
  bkInfo	BackgroundInfoCache

onWarning()

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

• 类型

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

• 参数

• events

  类型: { reason: string; }

  • 成员

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

onLockBoard()

锁住画板 UI

• 类型

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

• 参数

• lock

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

  是否锁住

  • 成员

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

onRecordUpdated()

画板记录堆栈变化

• 类型

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

• 参数

• events

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

  • 成员

  名称	类型	描述
  offset	number	当前位移
  stackLength	number	全部堆栈

onLockElement()

锁定画板图形

• 类型

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

• 参数

• events

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

  • 成员

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

onError()

错误回调

• 类型

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

• 参数

• events

  类型: { errorCode: ErrorCode; }

  错误事件

  • 成员

  名称	类型	描述
  errorCode	ErrorCode	锁定错误码

onLoadingImage()

加载画面回调

• 类型

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

• 参数

• events

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

  画面加载事件

  • 成员

  名称	类型	描述
  status	ImageLoadStatus	图片加载状态
  pageId	string	页面 ID

onClearPage()

白板清空回调

• 类型

ts (events: {}) => void

• 注意

调用 clearPage 后触发本回调。

• 参数

• events

  类型: {}

  白板清空事件