You need to enable JavaScript to run this app.
导航
API 详情
最近更新时间:2023.09.15 18:44:35首次发布时间:2023.08.07 20:50:14

IWhiteBoardRoomManager

类型: interface

  • API
方法描述
getSdkVersion获得当前 SDK 版本号。
init白板 SDK 初始化。
joinRoom创建白板实例并加入白板房间。

getSdkVersion

获得当前 SDK 版本号。

  • 类型

    () => string
    
  • 返回值

    类型: string

    版本号。

init

白板 SDK 初始化。

  • 类型

    (params: IInitParams) => void
    
  • 注意

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

  • 参数

joinRoom

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

  • 类型

    (params: IJoinRoomParams) => Promise<IWhiteBoardRoom>
    
  • 注意

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

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

  • 返回值

    类型: Promise<IWhiteBoardRoom>

    白板房间实例

IWhiteBoardRoom

类型: interface

  • API
方法描述
leaveRoom退出白板房间。
getCurrentWhiteBoard获取当前的白板实例。
createWhiteBoard在房间内创建一个白板。
switchWhiteBoard通过白板 ID 指定当前白板。在对白板进行编辑等操作前,需要将该白板设置为当前白板。
getWhiteBoardInfo通过白板 ID 获取白板信息。
getAllWhiteBoardInfo获取房间内所有白板的信息。
createTranscodeTask创建一个转码任务。

leaveRoom

退出白板房间。

  • 类型

    () => Promise<void>
    
  • 注意

    • 互动白板按照用户在房间内的时长进行计费,你应在当前用户结束白板使用时调用本接口退出房间。
    • 用户退出房间后,可以调用 joinRoom 再次加入该房间。
  • 返回值

    类型: Promise<void>

    调用成功后,你将无法继续操作 IWhiteBoardRoom 中的方法。

getCurrentWhiteBoard

获取当前的白板实例。

  • 类型

    () => Promise<IWhiteBoard | null>
    
  • 注意

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

    类型: Promise<IWhiteBoard | null>

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

createWhiteBoard

在房间内创建一个白板。

  • 类型

    (createBoardOptions?: CreateWhiteBoardInfo) => Promise<CreateWhiteBoardResult>
    
  • 注意

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

  • 返回值

    类型: Promise<CreateWhiteBoardResult>

    创建白板结果

switchWhiteBoard

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

getWhiteBoardInfo

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

  • 类型

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

    • boardId

      类型: number

      白板 ID

  • 返回值

    类型: Promise<WebBoardInfo | undefined>

    白板信息。
    获取失败时,返回 null。例如,传入的 boardID 有误。

getAllWhiteBoardInfo

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

  • 类型

    () => Promise<WebBoardInfo[]>
    
  • 返回值

    类型: Promise<WebBoardInfo[]>

    房间内所有白板的信息

createTranscodeTask

创建一个转码任务。

  • 类型

    (params: IDocsCreateTranscodeTask) => Promise<IDocsTranscodeResult>
    
  • 注意

    由于微信小程序端不支持创建 PPT 白板,不建议在微信小程序端创建动态转码任务。

  • 参数

  • 返回值

    类型: Promise<IDocsTranscodeResult>

    转码任务结果。

IWhiteBoard

类型: interface

  • API
方法描述
getWhiteBoardId获取当前的白板 ID。
createPages创建多个白板页面。在使用文档转码功能后,可以调用本接口,将生成的多个图片批量插入到多个新的白板页面中。
flipPage通过页面索引指定白板当前页。
flipNextPage白板翻到下一页。
flipPrevPage白板翻到上一页。
getAllPageInfo获取所有页面信息。
getCurrentPageIndex获取当前页面索引。
getPageCount获取当前页面总数。

getWhiteBoardId

获取当前的白板 ID。

  • 类型

    () => number
    
  • 返回值

    类型: number

    白板 ID

createPages

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

  • 类型

    (pageConfigs: WebPageInfo[], options?: CreatePageOptions) => Promise<CreatePageProgressResult>
    
  • 参数

  • 返回值

    类型: Promise<CreatePageProgressResult>

    • Resolve:调用成功后,本端和远端都将收到 onCreatePagesProgress 回调,提示页面创建进度。
    • Reject:失败原因。

flipPage

通过页面索引指定白板当前页。

  • 类型

    (pageIndex: number) => Promise<FlipPageResult>
    
  • 参数

    • pageIndex

      类型: number

      目标页索引

  • 返回值

    类型: Promise<FlipPageResult>

    • Resolve: 成功。返回当前页索引。并在房间内所有客户端触发 onPageIndexChanged
    • Reject: 失败。频繁调用,小于 500 ms;或传入的参数为空。

flipNextPage

白板翻到下一页。

  • 类型

    () => Promise<FlipPageResult>
    
  • 返回值

    类型: Promise<FlipPageResult>

    • True: 成功。返回当前页 Index。并在房间内所有客户端触发 onPageIndexChanged
    • False: 失败。频繁调用,小于 500 ms;或传入的参数为空。

flipPrevPage

白板翻到上一页。

  • 类型

    () => Promise<FlipPageResult>
    
  • 返回值

    类型: Promise<FlipPageResult>

    • True: 成功。返回当前页 Index。并在房间内所有客户端触发 onPageIndexChanged
    • False: 失败。频繁调用,小于 500 ms;或传入的参数为空。

getAllPageInfo

获取所有页面信息。

  • 类型

    () => WebPageInfo[]
    
  • 返回值

    类型: WebPageInfo[]

    白板页信息。

getCurrentPageIndex

获取当前页面索引。

  • 类型

    () => number
    
  • 返回值

    类型: number

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

getPageCount

获取当前页面总数。

  • 类型

    () => number
    
  • 返回值

    类型: number

    页面总数