API 详情

IWhiteBoardRoomManager

类型：interface

getSdkVersion

获得当前 SDK 版本号。

• 类型

  () => string
  

• 返回值

  类型：string 版本号。

init

白板 SDK 初始化。

• 注意

  在开始使用白板服务前，应调用本接口初始化白板。

• 类型

  (params: IInitParams) => void
  

• 参数

  • IInitParams

    类型：IInitParams

    初始化参数

joinRoom

创建白板实例并加入白板房间。

• 注意

  如果白板房间在服务端不存在，则服务端按照传入参数创建房间，并触发 onCreateWhiteBoard。

  • 进房成功后，可以调用 leaveRoom 离开房间。
  • 如果房间内所有用户都已结束互动，你可以调用 destroyRoom 关闭房间。

• 类型

  (params: IJoinRoomParams) => Promise<IWhiteBoardRoom>
  

• 参数

  • params

    类型：IJoinRoomParams

    进入白板房间参数

• 返回值

  类型：Promise<IWhiteBoardRoom> 白板房间实例

destroy

销毁 IWhiteBoardRoomManager 对象，释放资源。

• 类型

  () => void
  

IWhiteBoardRoom

类型：interface

getRoomId

获得当前白板房间 ID。

• 注意

  当本端用户已经进入白板房间后，你可以调用本接口查询当前房间 ID。

• 类型

  () => string
  

• 返回值

  类型：string 白板房间 ID

getRoomStatus

获取房间状态。

• 类型

  () => Promise<StatusType>
  

• 返回值

  类型：Promise<StatusType> 房间状态

leaveRoom

退出白板房间。

• 注意

  • 互动白板按照用户在房间内的时长进行计费，你应在当前用户结束白板使用时调用本接口退出房间。
  • 用户退出房间后，可以调用 joinRoom 再次加入该房间。
  • 如果房间内所有用户都已结束互动，你可以调用 destroyRoom 关闭房间。

• 类型

  () => Promise<void>
  

• 返回值

  类型：Promise<void>

destroyRoom

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

• 注意

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

• 类型

  () => Promise<DestroyRoomResult>
  

• 返回值

  类型：Promise<DestroyRoomResult> 关闭白板提示

switchWhiteBoard

指定当前白板。在对白板进行编辑等操作前，需要将该白板设置为当前白板。

• 注意

  调用后将触发 onCurrentWhiteBoardChanged。

• 类型

  (boarId: number) => Promise<SwitchBoardResult>
  

• 参数

  • boarId

    类型：number

    白板Id

• 返回值

  类型：Promise<SwitchBoardResult>

removeWhiteBoard

关闭指定白板。

• 注意

  调用后将触发 onRemoveWhiteBoard

• 类型

  (boardId: number) => Promise<RemoveWhiteBoardResult>
  

• 参数

  • boarId

    类型：number

    白板 ID

• 返回值

  类型：Promise<RemoveWhiteBoardResult>

getCurrentWhiteBoard

获取当前的白板实例。

• 注意

  • 调用 joinRoom 加入房间后，调用本接口获取当前白板。如果返回 null，则调用 createWhiteBoard 创建一个白板。

• 类型

  () => Promise<IWhiteBoard | null>
  

• 返回值

  类型：Promise<IWhiteBoard | null>

  • 当前的白板实例
  • 当前房间内没有白板，返回 null

getCurrentWhiteBoardId

获取当前的白板 ID。

• 类型

  () => Promise<number>
  

• 返回值

  类型：Promise<number> 当前白板 ID

getAllWhiteBoardInfo

获取房间内所有白板的信息。

• 类型

  () => Promise<WebBoardInfo[]>
  

• 返回值

  类型：Promise<WebBoardInfo[]> 房间内所有白板的信息

createWhiteBoard

在房间内创建一个白板。

• 注意

  • 调用 joinRoom 加入房间后，你可以调用本接口创建白板。
  • 调用成功后，房间内所有用户都将收到 onCreateWhiteBoard 回调。
  • 如果当前房间已有白板，你应该调用 getCurrentWhiteBoard 获取当前白板。
  • 你可以传入不同的白板参数，在同一个房间内创建多个白板。

• 类型

  (createBoardOptions?: CreateWhiteBoardInfo) => Promise<CreateWhiteBoardResult>
  

• 参数

  • createBoardOptions

    类型：CreateWhiteBoardInfo | undefined

    白板初始化参数

• 返回值

  类型：Promise<CreateWhiteBoardResult>

createFileWhiteBoard

在房间内创建 PPT 白板

• 注意

  调用本接口前，应先调用 createTranscodeTask，传入 PPT 的 URL 地址，并获取到 fileId。
  调用成功后房间内所有用户将收到 onCurrentWhiteBoardChanged

• 类型

  (createBoardOptions?: CreateFileWhiteBoardInfo) => Promise<CreateWhiteBoardResult>
  

• 参数

  • createBoardOptions

    类型：CreateFileWhiteBoardInfo | undefined

    创建 PPT 白板的初始项目

• 返回值

  类型：Promise<CreateWhiteBoardResult>

getWhiteBoardInfo

通过白板 ID 获取白板信息。

• 类型

  (boardId: number) => Promise<WebBoardInfo | undefined>
  

• 参数

  • boardId

    类型：number

    白板 ID

• 返回值

  类型：Promise<WebBoardInfo | undefined> 白板信息。
  获取失败时，返回 null。例如，传入的 boardID 有误。

createTranscodeTask

创建一个转码任务。

• 注意

  转码成功后，调用 createFileWhiteBoard，并传入获取到的 fileId，得到可以交互的 PPT 白板。

• 类型

  (params: IDocsCreateTranscodeTask) => Promise<IDocsTranscodeResult>
  

• 参数

  • params

    类型：IDocsCreateTranscodeTask

    转码任务配置

• 返回值

  类型：Promise<IDocsTranscodeResult> 转码任务结果。

startPlayback

开始播放白板录像。

• 注意

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

• 类型

  () => Promise<void>
  

• 返回值

  类型：Promise<void>

pausePlayback

暂停播放录像。

• 注意

  • 调用 startPlayback 开始播放回放后，你可以调用本接口暂停播放。
  • 调用后将触发 onPlaybackStateChanged。

• 类型

  () => void
  

stopPlayback

停止播放录像。

• 注意

  • 调用 startPlayback 开始播放回放后，你可以调用本接口停止播放。
  • 调用后将触发 onPlaybackStateChanged。

• 类型

  () => void
  

setPlaybackProgress

设置白板回放进度。

• 注意

  • 调用 startPlayback 开始播放回放后，你可以调用本接口停止播放。
  • 调用后将触发 onPlaybackProgressUpdate。

• 类型

  (progress: number) => Promise<void>
  

• 参数

  • progress

    类型：number

    播放位置相当于录像时长的占比。范围 [0,1]。

• 返回值

  类型：Promise<void>

IWhiteBoard

类型：interface

setViewMode

设置白板视图跟随模式。

• 注意

  • 设置为跟随模式时，无需手动调用 zoomIn， zoomOut 或 zoomTo，SDK 将自动同步为控制方的视图设置。

• 类型

  (viewMode: ViewMode) => ViewMode
  

• 参数

  • viewMode

    类型：ViewMode

    视角同步模式。默认为跟随模式。

• 返回值

  类型：ViewMode 当前视角同步模式

getViewMode

获取视图模式。

• 类型

  () => ViewMode
  

• 返回值

  类型：ViewMode 视图跟随模式

removePages

按照指定的索引号，删除白板页。

• 注意

  调用本接口成功后，白板 SDK 将按原顺序给剩下的页面重新编号。被删除页面之后的页面索引号会发生改变，房间中所有用户将收到 onPageIndexChanged 回调。

• 类型

  (pageIdList: string[], flipPageIndex?: number) => Promise<RemovePagesResult>
  

• 参数

  • pageIdList

    类型：string[]

    需要删除的页面的 PageId 列表。

  • flipPageIndex

    类型：number | undefined

    删除页面后，跳转到指定索引号页面。参数为空时的表现：

• 当前页未被删除时，不翻页。
• 删除包含当前页在内的不连续多页时：翻到第一个被删除的页面的下一页。
• 删除当前页或包含当前页在内的连续多页时：翻到下一页，如果删除的页面为最末页，则翻到前一页。

• 返回值

  类型：Promise<RemovePagesResult>

  • Resolve: 成功。成功调用后，房间中所有用户将收到 onRemovePages 和 onPageCountChanged 回调。
  • Reject: 失败。频繁调用，小于 500 ms；或传入的参数为空。

zoomIn

以当前视图中心为中心点放大白板视图。

• 注意

  • 当多个用户同时进行缩放设置时，发起较晚的用户设置失败。
    
  • 如果需要用户通过手势进行缩放可以通过 setEditType 设置为 ZOOM。

• 类型

  (scale: number) => boolean
  

• 参数

  • scale

    类型：number

    缩放系数增量。每次调用后，缩放系数增加 scale。
    当缩放系数超过范围时，将置为临界点。缩放系数的范围 [1, 20]。1 表示原始大小。放大系数上限默认为 20，以调用 setMaxZoom 设置的为准。

• 返回值

  类型：boolean 调用结果

  • true: 成功
  • false: 失败。当前用户的视图设置为跟随模式 kFollow = 1。

zoomOut

以当前视图中心为中心点缩小白板视图。

• 注意

  • 当多个用户同时进行缩放设置时，发起较晚的用户设置失败。
    
  • 如果需要用户通过手势进行缩放可以通过 setEditType 设置为 ZOOM。

• 类型

  (scale: number) => boolean
  

• 参数

  • scale

    类型：number

    缩放系数减量。每次调用后，缩放系数减少 scale。
    当缩放系数超过范围时，将置为临界点。缩放系数的范围 [1, 20]。1 表示原始大小。放大系数上限默认为 20，以调用 setMaxZoom 设置的为准。

• 返回值

  类型：boolean 调用结果

  • true: 成功
  • false: 失败。当前用户的视图设置为跟随模式 kFollow = 1。

zoomTo

按照指定中心点和缩放系数缩放白板视图。

• 注意

  • 缩放中心点为当前视图中心。
    
  • 当多个用户同时进行缩放设置时，将按服务端收到指令的时间顺序应用设置。
    
  • 如果需要用户通过手势进行缩放可以通过 setEditType 设置为 ZOOM。

• 类型

  (scale: number, offsetX?: number, offsetY?: number) => boolean
  

• 参数

  • scale

    类型：number

    缩放系数，范围 [1, 20]。1 表示原始大小。放大系数上限默认为 20，以调用 setMaxZoom 设置的为准。

  • offsetX

    类型：number | undefined

    缩放中心点 X 坐标，默认为 0

  • offsetY

    类型：number | undefined

    缩放中心点 Y 坐标，默认为 0

• 返回值

  类型：boolean 调用结果

  • true: 成功
  • false: 失败。例如缩放系数错误超过合法范围。

resetZoom

恢复默认缩放视图。还原到原始大小，视图中心点恢复为白板中心点。

• 类型

  () => boolean
  

• 返回值

  类型：boolean 调用结果

  • true: 成功
  • false: 失败。