类型: interface

获得当前SDK版本号。

• 类型

  () => string
  ts

• 返回值

  类型: string

  版本号。

创建白板 WhiteBoardRoom

• 类型

  (boardViewId: string, appId: string, room_id: string, user_id: string, token: string, boardSize?: { width: number; height: number; } | undefined, options?: { autoFlip: boolean; } | undefined) => IWhiteBoardRoom
  ts

• 注意

  白板房间创建成功后自动创建白板，成功后将触发 onCreateWhiteBoard。

• 参数

  • boardViewId

    类型: string

    白板绑定的视图 domID。

  • appId

    类型: string

    应用 ID。每个应用的唯一标识符，由 RTC 控制台随机生成的。
    不同的 AppId 生成的实例在互动白板中是天然隔离的，无法互通。

  • room_id

    类型: string

    房间 ID。

  • user_id

    类型: string

    用户 ID。

  • token

    类型: string

    鉴权密钥。

  • boardSize

    类型: { width: number; height: number; } | undefined

    设置白板默认宽高。

    • 成员

      名称	类型	描述
      width	number	白板宽度。
      height	number	白板高度。

  • options

    类型: { autoFlip: boolean; } | undefined

    设置参数。

    • 成员

      名称	类型	描述
      autoFlip	boolean	是否自动翻页。

• 返回值

  类型: IWhiteBoardRoom

  白板房间对象。

销毁白板房间 WhiteBoardRoom。

• 类型

  (whiteBoardRoom: IWhiteBoardRoom) => void
  ts

• 参数

  • whiteBoardRoom

    类型: IWhiteBoardRoom

    待销毁白板。

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

• 类型

  (room_id: number) => IWhiteBoardRoom | null
  ts

• 参数

  • room_id

    类型: number

    白板ID。

• 返回值

  类型: IWhiteBoardRoom | null

  白板房间对象。

类型: interface

获得当前 WhiteBoardRoom 的房间 ID

• 类型

  () => string | undefined
  ts

• 返回值

  类型: string | undefined

  房间ID

登录即时消息服务器

• 类型

  () => void
  ts

• 返回值

  房间ID

进房

• 调用后，本端触发 onJoinRoomResult 回调调用结果。
• 进房成功后，远端触发 onUserCountChanged 房间内人数回调。

• 类型

  () => Promise<void>
  ts

• 返回值

  类型: Promise<void>

  进房后调用 getBoardInfo 获取当前房间内的白板信息。

退房

• 调用后，本端触发 onLeaveRoomResult 回调调用结果。
• 退房成功后，远端触发 onUserCountChanged 房间内人数回调。

• 类型

  () => void
  ts

进房成功后，调用本接口获取当前房间内的白板信息，同时在内部恢复已有白板
// *

• 类型

  () => void
  ts

• 注意

  触发 onGetBoardInfo 回调

进房成功后，调用本接口获取当前房间内的白板信息
// *

• 类型

  () => void
  ts

• 注意

  触发 onGetBoardInfo 回调

恢复白板 WhiteBoard

• 类型

  (res: GetBoardInfoResponse) => void
  ts

• 参数

  • res

    类型: GetBoardInfoResponse

    GetBoardInfoResponse

销毁白板 WhiteBoard

• 类型

  (white_board: IWhiteBoard) => void
  ts

• 参数

  • white_board

    类型: IWhiteBoard

    待销毁白板

在房间内创建白板

• 类型

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

• 注意

  • 调用成功后将触发 onCreateWhiteBoard 回调。
    
  • 你可以在一个房间内创建多个白板。

• 参数

  • boardId

    类型: number

  • pages

    类型: WebPageInfo

  • boardBKInfo

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

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

• 类型

  () => void
  ts

• 注意

  • 如果你希望在下次进房时仍可以继续进行白板互动，应调用 leaveRoom 退房，此后调用 joinRoom 进房，可以继续此前的白板操作。
  • 如果已经在控制台开通和配置了白板录制，白板创建后自动录制。只有当调用本接口关闭白板之后，才可以开始播放录像。

通过白板 ID 获取白板对象

• 类型

  (board_id: number) => IWhiteBoard
  ts

• 参数

  • board_id

    类型: number

    白板ID

• 返回值

  类型: IWhiteBoard

  白板对象。获取失败时，返回 null。例如，传入的 boardID 有误。

开始播放白板录像

• 类型

  () => void
  ts

• 注意

  • 调用后将触发 onPlaybackWhiteBoardStateChanged。
  • 使用录像和回放时，需要在控制台开通和配置白板录制功能。
  • 调用时机：房间中至少有一个用户 closeAllWhiteBoard 关闭白板，之后，所有用户在重新进房后，即调用 leaveRoom 退房，再调用 joinRoom 重新进房后，才可以调用本接口开始播放录像。
  • 录像存储路径 ./AppData/Library/Caches

暂停播放录像

• 类型

  () => void
  ts

• 注意

  调用后将触发 onPlaybackWhiteBoardStateChanged

通过白板ID获取白板对象

• 类型

  () => void
  ts

• 注意

  调用后将触发 onPlaybackWhiteBoardStateChanged

设置白板回放进度

• 类型

  (progress: number) => void
  ts

• 注意

  调用后将触发 onPlaybackWhiteBoardProgressUpdate

• 参数

  • progress

    类型: number

    number 0-1

暂停

• 类型

  () => void
  ts

• 注意

  调用后将触发 onPlaybackWhiteBoardStateChanged

• 类型

  (pageId: string) => Promise<string | undefined>
  ts

• 参数

  • pageId

    类型: string

• 返回值

  类型: Promise<string | undefined>

类型: interface

批量删除白板页。

• 类型

  (pageId: string[], flipPageId?: string | undefined, isContinuousPages?: boolean | undefined) => boolean
  ts

• 注意

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

• 参数

  • pageId

    类型: string[]

    需要删除的页面 ID。

  • flipPageId

    类型: string | undefined

    删除后跳转的页面 ID。

  • isContinuousPages

    类型: boolean | undefined

    是否为连续页面。

• 返回值

  类型: boolean

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

获取当前的白板 ID。

• 类型

  () => number
  ts

• 返回值

  类型: number

  白板 ID。

获取当前白板的 PageId。

• 类型

  () => string
  ts

• 返回值

  类型: string

  白板ID。

获取当前白板所在的房间 ID。

• 类型

  () => string
  ts

• 返回值

  类型: string

  白板房间 ID。

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

• 类型

  (mode: EditMode) => void
  ts

• 参数

  • mode

    类型: EditMode

    EditMode 当前白板的编辑模式。

设置编辑动作类型。

• 类型

  (key: IToolMode) => void
  ts

• 注意

  如果默认的光标图形无法满足你的需求，调用 setCursorStyle，为不同工具过指定光标图形和样式。

• 参数

  • key

    类型: IToolMode

    编辑动作类型。

进行 Redo。

• 类型

  () => void
  ts

• 注意

  • onRecordUpdated 的偏移为 -1 时，表示当前无操作，调用本接口无效。
  • 调用本接口后，将触发 onRecordUpdated，偏移量 +1。

进行 Undo。

• 类型

  () => void
  ts

• 注意

  • onRecordUpdated 的偏移为 -1 时，表示当前无操作，调用本接口无效。
  • 调用本接口后，将触发 onRecordUpdated，偏移量 -1。

清空白板。

• 类型

  () => void
  ts

设置图形线条尺寸。

• 类型

  (thickness: number) => void
  ts

• 参数

  • thickness

    类型: number

    图形线条尺寸。

设置图形颜色。

• 类型

  (color: string) => void
  ts

• 参数

  • color

    类型: string

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

设置画笔尺寸。

• 类型

  (thickness: number) => void
  ts

• 参数

  • thickness

    类型: number

    笔尖尺寸。

设置画笔颜色。

• 类型

  (color: string) => void
  ts

• 参数

  • color

    类型: string

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

设置文字颜色。

• 类型

  (color: string) => void
  ts

• 参数

  • color

    类型: string

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

设置文本字号大小。

• 类型

  (thickness: number) => void
  ts

• 参数

  • thickness

    类型: number

    文本字号大小。

创建单个白板页面。

• 类型

  (insertPageId: string, pageConfig: Partial<WebPageInfo>, options?: { autoFlip: boolean; } | undefined) => boolean
  ts

• 参数

  • insertPageId

    类型: string

    创建的页面将插入到指定的页面 ID 之后。

  • pageConfig

    类型: Partial<WebPageInfo>

    页面信息。

  • options

    类型: { autoFlip: boolean; } | undefined

    是否自动翻页。

    • 成员

      名称	类型	描述
      autoFlip	boolean	默认不翻页，即创建页面后当前页面不变。 自动翻页: 在页面创建完成后，当前页面变更为刚创建的页面。

• 返回值

  类型: boolean

创建多个白板页面。在使用文件转码功能后，可以调用本接口，将生成的多个图片批量插入到多个新的白板页面中。

• 类型

  (insertPageId: string, pageConfigs: Partial<WebPageInfo>[], task_id: string, options?: { autoFlip: boolean; } | undefined) => boolean
  ts

• 参数

  • insertPageId

    类型: string

    创建的页面将插入到指定的页面 ID 之后。

  • pageConfigs

    类型: Partial<WebPageInfo>[]

    页面信息数组。

  • task_id

    类型: string

    创建多页的任务ID，设置不重复的uuid。

  • options

    类型: { autoFlip: boolean; } | undefined

    是否自动翻页。

    • 成员

      名称	类型	描述
      autoFlip	boolean	默认不翻页，即创建页面后当前页面不变。 自动翻页: 在页面创建完成后，当前页面变更为刚批量创建的第一页。

• 返回值

  类型: boolean

获取当前页面信息。

• 类型

  () => WebPageInfo | undefined
  ts

• 返回值

  类型: WebPageInfo | undefined

  白板页信息。

获取所有页面信息。

• 类型

  () => WebPageInfo[] | undefined
  ts

• 返回值

  类型: WebPageInfo[] | undefined

  白板页信息。

获取当前页面索引。

• 类型

  () => number
  ts

• 返回值

  类型: number

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

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

• 类型

  (index: number) => WebPageInfo
  ts

• 参数

  • index

    类型: number

    索引。

• 返回值

  类型: WebPageInfo

  白板信息。

修改指定白板页面的背景图或背景色。

• 类型

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

• 参数

  • params

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

    背景信息。

    • 成员

      名称	类型	描述
      pageId	string	修改目标页面 ID。
      color	string | undefined	背景颜色。例如 rgba(0,0,0,255)。
      img	string | undefined	背景图片 url。
      fillType	BkFillType | undefined	背景图片填充模式。

• 返回值

  类型: boolean

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

• 类型

  (params: BackgroundInfoCache) => boolean
  ts

• 参数

  • params

    类型: BackgroundInfoCache

    背景信息。

• 返回值

  类型: boolean

白板翻页

• 类型

  (pageId: string) => boolean
  ts

• 参数

  • pageId

    类型: string

    目标页 ID。

• 返回值

  类型: boolean

  • True: 成功。调用成功后在房间内所有客户端触发 onFlipPage。
  • False: 失败。频繁调用，小于 500 ms；或传入的参数为空。

在当前页面中添加图片。

• 类型

  (url: string, options: { top?: number; left?: number; width?: number; height?: number;}) => Promise<void>
  ts

• 参数

  • url

    类型: string

    图片的 url。

  • options

    类型: { top?: number | undefined; left?: number | undefined; width?: number | undefined; height?: number | undefined; }

    图片的位置，单位为画布宽度的万分之一。
    选填。默认居中放置，如果图片尺寸比白板页面小，不缩放；如果图片尺寸比白板页面大，按原始尺寸的比例缩小后居中放置。

    • 成员

      名称	类型	描述
      top	number | undefined	放置位置，垂直方向偏移量
      left	number | undefined	放置位置，水平方向偏移量
      width	number | undefined	宽度
      height	number | undefined	高度

• 返回值

  类型: Promise<void>

开启光标同步。

• 类型

  (param: boolean) => void
  ts

• 参数

  • param

    类型: boolean

    同步状态：

• true: 开启
• false: 关闭

自定义不同的工具光标样式。如果默认的光标图形无法满足你的需求，调用本接口，为不同工具过指定光标图形和样式。

• 类型

  (parama: Partial<CursorMap>) => void
  ts

• 参数

  • parama

    类型: Partial<CursorMap>

    自定义光标样式。[key in CursorType]: CursorInfo;
    CursorType 定义如下：

• kArrow = 0, //箭头光标
• kSelect = 1, //选择
• kPen = 2, //画笔
• kShape = 3, //形状
• kText = 4, //文字
• kErase = 5, //橡皮擦
• kLaserPen = 6, //激光笔
• kMove = 7, //图形平移光标，光标不同步此类型，仅 Web 端可见
• kRotate = 8, //图形旋转光标，光标不同步此类型，仅 Web 端可见
  CursorInfo 定义如下：
  export interface CursorInfo {
• useSystemCursor?: boolean; // Web 端特有，是否使用浏览器自带光标
• filePath?: string; // 光标资源路径 url
• systemCursorType?: SystemCursorType; // Web 端特有，对应 Web 端系统光标枚举
• offsetX?: number; // 焦点位置，在光标图形上 X 方向偏移量
• offsetY?: number; // 焦点位置，在光标图形上 Y 方向偏移量
• width?: number;// 光标宽度
• height?: number;// 光标高度
  }

设置选择框样式。如果默认的选择框样式无法满足你的需求，调用本接口，并传入需要修改的属性。

• 类型

  (shapeStyle: ShapeStyle) => void
  ts

• 参数

  • shapeStyle

    类型: ShapeStyle

    选择框样式。

设置本端白板画布大小。

• 类型

  (params: { width: number; height: number;}) => void
  ts

• 注意

  调用本接口不会影响房间中其他用户的白板的画布大小。

• 参数

  • params

    类型: { width: number; height: number; }

    本端白板画布大小。

    • 成员

      名称	类型	描述
      width	number	画板宽度
      height	number	画板高度