IWhiteBoardRoomManager

类型: interface

• API

getSdkVersion()

获得当前SDK版本号

• 类型

ts () => string

• 返回值

类型: string

版本号

createWhiteBoardRoom()

创建白板 WhiteBoardRoom

• 类型

ts (boardViewId: string, appId: string, room_id: string, user_id: string, token: string, options?: { autoFlip: boolean;}) => WhiteBoardRoom

• 参数

• boardViewId

  类型: string

  白板绑定的视图domID，

• appId

  类型: string

  应用ID

• room_id

  类型: string

  房间ID

• user_id

  类型: string

  用户ID

• token

  类型: string

  token

• options

  类型: { autoFlip: boolean; }

  • 成员

  名称	类型	描述
  autoFlip	boolean

• 返回值

类型: WhiteBoardRoom

白板房间对象

destroyWhiteBoardRoom()

销毁白板房间 WhiteBoardRoom

• 类型

ts (whiteBoardRoom: WhiteBoardRoom) => void

• 参数

• whiteBoardRoom

  类型: WhiteBoardRoom

  待销毁白板

getWhiteBoardRoom()

通过房间ID获取白板房间对象

• 类型

ts (room_id: number) => WhiteBoardRoom

• 参数

• room_id

  类型: number

  白板ID

• 返回值

类型: WhiteBoardRoom

白板房间对象 (可能为nullptr)

setFromOnerRTC()

表示后续传入SDK的token是onertoken（默认认为是byte token）

• 类型

ts () => void

IWhiteBoardRoom

类型: interface

• API

getRoomID()

获得当前WhiteBoardRoom的房间ID

• 类型

ts () => string | undefined

• 返回值

类型: string | undefined

房间ID

joinRoom()

进房

• 类型

ts () => Promise<void>

• 注意

成功调用后触发 onJoinRoomResult 回调

• 返回值

类型: Promise<void>

leaveRoom()

退房

• 类型

ts () => void

• 注意

成功调用后触发 onLeaveRoomResult 回调

getBoardInfo()

获取白板信息

• 类型

ts () => void

• 注意

触发 onGetBoardInfo 回调

destroyWhiteBoard()

销毁白板 WhiteBoard

• 类型

ts (white_board: WhiteBoard) => void

• 参数

• white_board

  类型: WhiteBoard

  待销毁白板

createWhiteBoard()

在房间内创建白板

• 类型

ts (boardId: number, pages: WebPageInfo, boardBKInfo?: WebPageInfo['bkInfo']) => WhiteBoard

• 注意

成功调用后触发 onCreateWhiteBoard 回调

• 参数

• boardId

  类型: number

  白板ID

• pages

  类型: WebPageInfo

  白板的单页元素

• boardBKInfo

  类型: { bkColor?: string; bkImage?: string; bkImageFillType?: BkFillType; bkImageSize?: BkImageSize; }

  白板信息

• 返回值

类型: WhiteBoard

closeAllWhiteBoard()

关闭所有白板，重进房间后无法进行写画

• 类型

ts () => void

getWhiteBoard()

通过白板ID获取白板对象

• 类型

ts (board_id: number) => WhiteBoard

• 参数

• board_id

  类型: number

  白板ID

• 返回值

类型: WhiteBoard

白板对象 (可能为null)

startPlaybackWhiteBoard()

开始播放白板录像

• 类型

ts () => void

• 注意

调用后将触发 onPlaybackWhiteBoardStateChanged

pausePlaybackWhiteBoard()

暂停播放录像

• 类型

ts () => void

• 注意

调用后将触发 onPlaybackWhiteBoardStateChanged

stopPlaybackWhiteBoard()

通过白板ID获取白板对象

• 类型

ts () => void

• 注意

调用后将触发 onPlaybackWhiteBoardStateChanged

setPlaybackWhiteBoardProgress()

设置白板回放进度

• 类型

ts (progress: number) => void

• 注意

调用后将触发 onPlaybackWhiteBoardProgressUpdate

• 参数

• progress

  类型: number

  number 0-1

cancelPausePlaybackWhiteBoard()

暂停

• 类型

ts () => void

• 注意

调用后将触发 onPlaybackWhiteBoardStateChanged

IWhiteBoard

类型: interface

• API

getWhiteBoardID()

获取当前白板的ID

• 类型

ts () => number

• 返回值

类型: number

白板ID

getCurrentPageId()

获取当前白板的 PageId

• 类型

ts () => string

• 返回值

类型: string

白板ID

getWhiteBoardRoomID()

获取当前白板的 ID

• 类型

ts () => string

• 返回值

类型: string

白板ID

setEditMode()

设置当前白板是否可以编辑

• 类型

ts (mode: EditMode) => void

• 参数

• mode

  类型: EditMode

  当前用户是否有白板的编辑权限

hideDrawing()

隐藏白板

• 类型

ts () => void

setEditType()

设置图形类型

• 类型

ts (key: IToolMode) => void

• 参数

• key

  类型: IToolMode

  画笔或图形类型

enableDrawMode()

启用画板模式

• 类型

ts () => void

setDrawMode()

设置画板模式

• 类型

ts (param: DrawConf) => void

• 参数

• param

  类型: DrawConf

  参数设置

cancelDrawMode()

取消画板模式

• 类型

ts () => void

getCurrentRecord()

启用画板模式

• 类型

ts () => RecordCommand | undefined

• 返回值

类型: RecordCommand | undefined

redo()

重做

• 类型

ts () => void

undo()

撤销

• 类型

ts () => void

clearPage()

清空白板页面

• 类型

ts () => void

• 注意

调用本方法后触发 onClearPage 回调。

setShapeSize()

设置图形线条尺寸

• 类型

ts (thickness: number) => void

• 参数

• thickness

  类型: number

  图形线条尺寸

setShapeColor()

设置图形颜色

• 类型

ts (color: string) => void

• 参数

• color

  类型: string

  图形的颜色，例如 rgba(0,0,0,255)

setPenSize()

设置画笔尺寸

• 类型

ts (thickness: number) => void

• 参数

• thickness

  类型: number

  笔尖尺寸

setPenColor()

设置画笔颜色

• 类型

ts (color: string) => void

• 参数

• color

  类型: string

  画笔的颜色，例如 rgba(0,0,0,255)

setTextColor()

设置文字颜色

• 类型

ts (color: string) => void

• 参数

• color

  类型: string

  文字的颜色，例如 rgba(0,0,0,255)

setTextFontSize()

设置文本字号大小

• 类型

ts (thickness: number) => void

• 参数

• thickness

  类型: number

  文本字号大小

createPage()

创建一页

• 类型

ts (insertPageId: string, pageConfig: Partial<WebPageInfo>) => void

• 注意

调用本方法后触发 onClearPage 回调。

• 参数

• insertPageId

  类型: string

  插入页面 ID

• pageConfig

  类型: Partial<WebPageInfo>

  页面信息

getCurrentPageInfo()

获取当前页面信息

• 类型

ts () => WebPageInfo | undefined

• 返回值

类型: WebPageInfo | undefined

白板页信息

getAllPageInfo()

获取所有页面信息

• 类型

ts () => WebPageInfo[] | undefined

• 返回值

类型: WebPageInfo[] | undefined

白板页信息

getCurrentPageIndex()

获取当前页面索引

• 类型

ts () => number

• 返回值

类型: number

索引, -1 表示没有找到索引

getPageInfoByIndex()

通过索引号获取白板页信息

• 类型

ts (index: number) => WebPageInfo

• 参数

• index

  类型: number

  索引

• 返回值

类型: WebPageInfo

白板信息

changePageBackground()

修改某页背景图、背景色

• 类型

ts (params: { pageId: string; color?: string; img?: string; fillType?: BkFillType;}) => void

• 注意

调用本方法后在本端和远端触发 onChangePageBackground 回调。

• 参数

• pageId

  类型: { pageId: string; color?: string; img?: string; fillType?: BkFillType; }

  要修改页的pageId

  • 成员

  名称	类型	描述
  pageId	string
  color	string
  img	string
  fillType	BkFillType

changeBoardBackground()

修改白板默认背景图、背景色

• 类型

ts (params: BackgroundInfoCache) => void

• 注意

调用本方法后在本端和远端触发 onChangeBoardBackground 回调。

• 参数

• params

  类型: BackgroundInfoCache

  背景信息

removePages()

批量删除白板页

• 类型

ts (pageId: string[], isContinuousPages: boolean) => void

• 注意

成功调用后将触发 onRemovePages 和 onPagesCountChanged 回调。

• 参数

• pageId

  类型: string[]

  需要删除的页面 ID

• isContinuousPages

  类型: boolean

  是否为连续页面

flipPage()

翻页

• 类型

ts (pageId: string) => void

• 注意

调用本方法后在本端和远端触发 onFlipPage 回调。

• 参数

• pageId

  类型: string

  页面 ID

• 返回值

True: 成功 False: 失败。频繁调用，小于 500 ms；或传入的参数为空。