public abstract class com.ss.video.byteboard.WhiteBoard
java

白板接口类。调用 getCurrentWhiteBoard 将返回当前的白板实例，你可以通过这个类来操作当前白板。

public abstract int com.ss.video.byteboard.WhiteBoard.getWhiteBoardId()
java

获取当前白板 ID。

返回值
白板 ID

public abstract String com.ss.video.byteboard.WhiteBoard.getWhiteBoardRoomId()
java

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

返回值
房间 ID

public abstract void com.ss.video.byteboard.WhiteBoard.setEventHandler(
    IWhiteBoardEventHandler handler)
java

设置白板事件回调。

传入参数

public abstract void com.ss.video.byteboard.WhiteBoard.setWritable(
    boolean writable)
java

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

传入参数

public abstract void com.ss.video.byteboard.WhiteBoard.setEditType(
    WhiteBoardDefine.EditType editType)
java

设置编辑动作类型。

传入参数

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

public abstract void com.ss.video.byteboard.WhiteBoard.setPenSize(
    float width)
java

设置笔画笔迹宽度。

传入参数

public abstract void com.ss.video.byteboard.WhiteBoard.setPenColor(
    int color)
java

设置笔画颜色。

传入参数

public abstract void com.ss.video.byteboard.WhiteBoard.setShapeSize(
    float width)
java

设置形状线条宽度。

传入参数

public abstract void com.ss.video.byteboard.WhiteBoard.setShapeColor(
    int color)
java

设置形状颜色。

传入参数

public abstract void com.ss.video.byteboard.WhiteBoard.setTextFontSize(
    float size)
java

设置文本字号大小。

传入参数

public abstract void com.ss.video.byteboard.WhiteBoard.setTextColor(
    int color)
java

设置文字颜色。

传入参数

public abstract void com.ss.video.byteboard.WhiteBoard.setSelectionBoxStyle(
    ShapeStyle shapeStyle)
java

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

传入参数

public abstract void com.ss.video.byteboard.WhiteBoard.enableCursorSync(
    boolean enable)
java

开启光标同步功能，默认关闭。开启后，房间中其他用户可以看到当前用户光标的实时移动轨迹。

传入参数

public abstract void com.ss.video.byteboard.WhiteBoard.setCursorStyle(
    HashMap<UserCursorInfo.CursorType, CursorInfo> cursorStyles)
java

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

传入参数

public abstract void com.ss.video.byteboard.WhiteBoard.addImage(
    String url,
    Rect imagePosition,
    OnResult<String> onResult)
java

在当前页面中添加图片。

传入参数

public abstract void com.ss.video.byteboard.WhiteBoard.undo()
java

撤销本端对白板的编辑操作。

注意
当 onCanUndoStateChanged 返回的状态为 false 时，调用本接口无效。

public abstract void com.ss.video.byteboard.WhiteBoard.redo()
java

重做本端对白板的编辑操作。

注意
当 onCanRedoStateChanged 返回的状态为 false 时，调用本接口无效。

public abstract void com.ss.video.byteboard.WhiteBoard.clearPage()
java

清除页面。

注意
调用成功后在房间内所有客户端触发 onClearPage 回调

public abstract void com.ss.video.byteboard.WhiteBoard.createPages(
    List<PageInfo> pageConfigs,
    int prePageIndex,
    boolean autoFlip)
java

新建多个白板页。

传入参数

注意
调用成功后在本端和远端触发 onCreatePagesProgress 回调。

public abstract void com.ss.video.byteboard.WhiteBoard.removePages(
    List<String> pageIds,
    int flipPageIndex)
java

批量删除白板页。

传入参数

注意

• 成功调用后将触发 onRemovePages 回调。
• 当删除的画面为当前页面时，还将触发当前页面改变 onPageIndexChanged 回调。

public abstract void com.ss.video.byteboard.WhiteBoard.flipPage(
    int index)
java

白板翻页。

传入参数

public abstract void com.ss.video.byteboard.WhiteBoard.flipNextPage()
java

翻到下一页。
@note 调用成功后在房间内所有客户端触发 onPageIndexChanged。

public abstract void com.ss.video.byteboard.WhiteBoard.flipPrevPage()
java

翻到上一页。
@note 调用成功后在房间内所有客户端触发 onPageIndexChanged。

public abstract void com.ss.video.byteboard.WhiteBoard.setPageBackground(
    BackgroundInfo backgroundInfo)
java

修改当前页面的背景图、背景色。

传入参数

注意

• 调用 setBoardBackground 可以设置白板背景。页面背景显示优先级高于白板背景，与调用顺序无关。
• 成功调用本接口后在本端和远端触发 onPageBackgroundChanged 回调。

public abstract void com.ss.video.byteboard.WhiteBoard.setBoardBackground(
    BackgroundInfo backgroundInfo)
java

修改当前白板的背景设置，例如背景图片颜色等。

传入参数

注意

• 调用本回调后会在本端和远端触发 [onBoardBackgroundChanged] 回调。

public abstract void com.ss.video.byteboard.WhiteBoard.getCurrentPageInfo(
    OnResult<PageInfo> onResult)
java

获取当前页面信息。

传入参数

public abstract void com.ss.video.byteboard.WhiteBoard.getCurrentPageIndex(
    OnResult<Integer> onResult)
java

获取当前页面索引。

传入参数

public abstract void com.ss.video.byteboard.WhiteBoard.getPageInfoByIndex(
    int index,
    OnResult<PageInfo> onResult)
java

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

传入参数

public abstract void com.ss.video.byteboard.WhiteBoard.getAllPageInfo(
    OnResult<List<PageInfo>> onResult)
java

获取所有页面信息。

传入参数

public abstract void com.ss.video.byteboard.WhiteBoard.getPageCount(
    OnResult<Integer> onResult)
java

获取白板总页数。

传入参数

public abstract void com.ss.video.byteboard.WhiteBoard.setViewMode(
    WhiteBoardDefine.ViewMode viewMode)
java

设置白板视角同步方式。

传入参数

public abstract void com.ss.video.byteboard.WhiteBoard.getViewMode(
    OnResult<Integer> onResult)
java

获取视图模式。

传入参数

public abstract void com.ss.video.byteboard.WhiteBoard.zoomIn(
    double scale)
java

按照当前中心点和缩放系数放大白板视图。

传入参数

注意

• 缩放中心点为当前视图中心。
• 当多个用户同时进行缩放设置时，发起较晚的用户设置失败。

public abstract void com.ss.video.byteboard.WhiteBoard.zoomOut(
    double scale)
java

按照当前中心点和缩放系数缩小白板视图。

传入参数

注意

• 缩放中心点为当前视图中心。
• 当多个用户同时进行缩放设置时，发起较晚的用户设置失败。

public abstract void com.ss.video.byteboard.WhiteBoard.zoomTo(
    double scale,
    int offsetX,
    int offsetY)
java

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

传入参数

注意

• 缩放中心点为当前视图中心。
• 当多个用户同时进行缩放设置时，将按服务端收到指令的时间顺序应用设置。

public abstract void com.ss.video.byteboard.WhiteBoard.resetZoom()
java

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

public abstract void com.ss.video.byteboard.WhiteBoard.getZoomFactor(
    OnResult<Double> onResult)
java

获取当前白板视图缩放系数。

传入参数

public abstract void com.ss.video.byteboard.WhiteBoard.setMaxZoom(
    double maxScale)
java

设置白板视图最大放大系数。

传入参数

注意

• 设置成功后，将改变调用以下 API 的参数上限：  [zoomIn](#WhiteBoard-zoomin) ， [zoomOut](#WhiteBoard-zoomout) 或 [zoomTo](#WhiteBoard-zoomto)。
  

• PPT 白板的最大放大倍数设置为 2。超过时，可能在 Android 端引起卡顿问题。
  

public abstract void com.ss.video.byteboard.WhiteBoard.exportSnapshot(
    Integer pageIndex,
    boolean withElements,
    boolean withBackGround)
java

将当前白板中指定页面保存为一张本地图片。

传入参数

注意

• 调用成功后，将通过 onExportSnapshot 回调图片在本设备的绝对路径。
• 短时间内多次调用本 API 时，等待获取结果回调时间可能增加。
• PPT 白板页导出的快照仅包含预加载状态的图片。

public abstract void com.ss.video.byteboard.WhiteBoard.getCurrentPageId(
    OnResult<String> onResult)
java

获取当前页面的 PageId。

传入参数

public abstract void com.ss.video.byteboard.WhiteBoard.getPptInfo(
    OnResult<PPTInfo> onResult)
java

获取当前 PPT 信息，非 PPT 白板返回空

传入参数

注意
调用 createFileWhiteBoard 可以创建一个 PPT 白板。

public abstract void com.ss.video.byteboard.WhiteBoard.pptNextStep()
java

下一个 PPT 动画，如果是最后一个动画，翻到下一页

注意

• 非 PPT 白板调用无效
• 调用 createFileWhiteBoard 可以创建一个 PPT 白板。
• 成功调用后在在房间内所有客户端触发 onPptStepChanged 回调。

public abstract void com.ss.video.byteboard.WhiteBoard.pptPrevStep()
java

上一个 PPT 动画，如果是第一个动画，翻到上一页

注意

• 非 PPT 白板调用无效
• 调用 createFileWhiteBoard 可以创建一个 PPT 白板。
• 成功调用后在在房间内所有客户端触发 onPptStepChanged 回调。

public abstract class com.ss.video.byteboard.WhiteBoardRoom
java

白板房间接口类。
调用 joinRoom 之后，自动返回一个可以操作的 WhiteBoardRoom 实例。你可以通过这个类来进行白板房间相关操作。

public abstract String com.ss.video.byteboard.WhiteBoardRoom.getRoomID()
java

获取房间 ID。

返回值
房间 ID

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

public abstract void com.ss.video.byteboard.WhiteBoardRoom.getRoomStatus(
    OnResult<WhiteBoardDefine.StatusType> onResult)
java

获取房间状态。

传入参数

public abstract void com.ss.video.byteboard.WhiteBoardRoom.leaveRoom()
java

退房。

注意

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

public abstract void com.ss.video.byteboard.WhiteBoardRoom.destroyRoom()
java

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

注意

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

public abstract void com.ss.video.byteboard.WhiteBoardRoom.createWhiteBoard(
    int boardId,
    List<PageInfo> pages,
    BackgroundInfo boardBKInfo,
    String boardName)
java

在房间内创建一个白板。

传入参数

注意
成功调用后将触发 onCreateWhiteBoard

public abstract void com.ss.video.byteboard.WhiteBoardRoom.createFileWhiteBoard(
    int boardId,
    String boardName,
    PPTInfo pptInfo)
java

在房间内创建一个 PPT 白板，用于本端发起一个 PPT。

传入参数

注意

• 进行 PPT 共享时，只需要发起端调用本接口，房间中的其他用户端将自动创建 PPT 白板，无需手动调用本接口。
• 成功调用后将触发 onCreateWhiteBoard

public abstract void com.ss.video.byteboard.WhiteBoardRoom.removeWhiteBoard(
    int boardId)
java

关闭指定白板。

传入参数

注意
调用后将触发 onRemoveWhiteBoard

public abstract void com.ss.video.byteboard.WhiteBoardRoom.switchWhiteBoard(
    int boardId)
java

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

传入参数

注意
调用后将触发 onCurrentWhiteBoardChanged

public abstract WhiteBoard com.ss.video.byteboard.WhiteBoardRoom.getWhiteBoard(
    int boardID)
java

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

传入参数

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

public abstract WhiteBoard com.ss.video.byteboard.WhiteBoardRoom.getCurrentWhiteBoard()
java

获取当前白板对象。

返回值
白板对象

public abstract int com.ss.video.byteboard.WhiteBoardRoom.getCurrentWhiteBoardID()
java

获取当前的白板 ID。

返回值
白板 ID

public abstract void com.ss.video.byteboard.WhiteBoardRoom.getWhiteBoardInfo(
    int boardId,
    OnResult<BoardInfo> onResult)
java

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

传入参数

public abstract void com.ss.video.byteboard.WhiteBoardRoom.getAllWhiteBoardInfo(
    OnResult<List<BoardInfo>> onResult)
java

获取所有白板信息。

传入参数

public abstract void com.ss.video.byteboard.WhiteBoardRoom.startPlayback()
java

开始播放白板录像。

成功调用后，触发 onPlaybackStateChanged 播放状态回调。

注意

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

public abstract void com.ss.video.byteboard.WhiteBoardRoom.pausePlayback()
java

暂停播放白板录像。

成功调用后，触发 onPlaybackStateChanged 播放状态回调。

public abstract void com.ss.video.byteboard.WhiteBoardRoom.stopPlayback()
java

停止播放白板录像。

成功调用后，触发 onPlaybackStateChanged 播放状态回调。

public abstract void com.ss.video.byteboard.WhiteBoardRoom.setPlaybackProgress(
    long progress,
    OnResult<Boolean> onResult)
java

设置白板回放进度。

传入参数

注意
调用后将触发 onPlaybackProgressUpdate 回调。

public abstract class com.ss.video.byteboard.WhiteBoardRoomManager
java

白板房间管理接口类，你可以通过这个类来操作白板 SDK 接口。

public static void com.ss.video.byteboard.WhiteBoardRoomManager.setDeviceID(
    String deviceId)
java

设置设备 ID。

传入参数

public static void com.ss.video.byteboard.WhiteBoardRoomManager.setLogLocation(
    String path)
java

设置日志路径。

传入参数

public synchronized static void com.ss.video.byteboard.WhiteBoardRoomManager.create(
    Context context,
    String appID,
    ViewGroup view,
    OnResult<WhiteBoardRoomManager> onResult)
java

创建和初始化白板 WhiteBoardRoomManager 实例。

传入参数

public synchronized static void com.ss.video.byteboard.WhiteBoardRoomManager.destroy()
java

销毁 whiteBoardRoomManager 实例，释放资源。

public static String com.ss.video.byteboard.WhiteBoardRoomManager.getSdkVersion()
java

获取白板 SDK 版本号。

静态方法，无需创建白板实例。

返回值
SDK 版本号

public abstract void com.ss.video.byteboard.WhiteBoardRoomManager.joinRoom(
    String roomID,
    String userID,
    String token,
    BoardInfo defaultBoardInfo,
    IWhiteBoardRoomEventHandler handler,
    OnResult<WhiteBoardRoom> onResult)
java

加入白板房间。

传入参数

注意
如果当前房间没有白板，将按照传入的参数创建一个白板，成功后将触发 onCreateWhiteBoard 回调。

public abstract int com.ss.video.byteboard.WhiteBoardRoomManager.destroyWhiteBoardRoom(
    WhiteBoardRoom whiteBoardRoom)
java

销毁白板房间实例。

传入参数

返回值
调用结果
0: 成功

public abstract WhiteBoardRoom com.ss.video.byteboard.WhiteBoardRoomManager.getWhiteBoardRoom(
    String roomID)
java

获取白板实例。创建多个房间后，可以通过调用接口获得相应实例。

传入参数

返回值
whiteBoard 详见 WhiteBoardRoom。失败时返回空的实例

public abstract WebView com.ss.video.byteboard.WhiteBoardRoomManager.getView()
java

获取当前白板视图。

返回值
白板视图