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

WhiteBoard 对外的接口类，用户通过这个类来操作白板接口。

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.setEditMode(
    WhiteBoardDefine.EditMode editMode)
java

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

传入参数

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

设置是否隐藏白板。

传入参数

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

设置编辑动作类型。

传入参数

返回值
调用结果
0: 成功

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

public abstract int com.ss.video.byteboard.WhiteBoard.setPenWidth(
    float width)
java

设置笔画笔迹宽度。

传入参数

返回值
调用结果
0: 成功

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

设置笔画颜色。

传入参数

返回值
调用结果
0: 成功

public abstract int com.ss.video.byteboard.WhiteBoard.setShapeWidth(
    float width)
java

设置形状线条宽度。

传入参数

返回值
调用结果
0: 成功

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

设置形状颜色。

传入参数

返回值
调用结果
0: 成功

public abstract int com.ss.video.byteboard.WhiteBoard.setTextSize(
    float size)
java

设置文本字号大小。

传入参数

返回值
调用结果
0: 成功

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

设置文字颜色。

传入参数

返回值
调用结果
0: 成功

public abstract int com.ss.video.byteboard.WhiteBoard.setShapeStyle(
    ShapeStyle shapeStyle)
java

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

传入参数

返回值
调用结果
0: 成功

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

设置白板视图跟随模式。

传入参数

注意

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

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

按指定倍数放大当前白板视图。

传入参数

返回值
调用结果

• true: 成功
• false: 失败。例如缩放系数错误超过合法范围。缩放系数，范围 [1, 20]。1 表示原始大小。放大系数上限默认为 20，以调用 setMaxZoom 设置的为准。

注意

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

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

按指定倍数缩小当前白板视图。

传入参数

返回值
调用结果

• true: 成功
• false: 失败。例如缩放系数错误超过合法范围。缩放系数，范围 [1, 20]。1 表示原始大小。

注意

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

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

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

传入参数

返回值
调用结果

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

注意

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

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

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

返回值
调用结果

• true: 成功
• false: 失败。

public abstract double com.ss.video.byteboard.WhiteBoard.getZoomFactor()
java

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

返回值
当前白板视图缩放系数。范围 [1, 20]。1 表示原始大小。放大系数上限默认为 20，以调用 setMaxZoom 设置的为准。

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

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

传入参数

注意
设置成功后，将改变调用以下 API 的参数上限： zoomIn ， zoomOut 或 zoomTo。

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

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

传入参数

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

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

传入参数

返回值
调用结果

public abstract boolean com.ss.video.byteboard.WhiteBoard.addImage(
    String url,
    Rect imagePosition)
java

在当前页面中添加图片

传入参数

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

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

撤销

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

返回值
调用结果
0: 成功

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

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

重做

返回值
调用结果
0: 成功

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

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

清除页面

注意
调用成功后在房间内所有客户端触发 onClearPage 回调，返回调用结果状态码

public abstract boolean com.ss.video.byteboard.WhiteBoard.createPage(
    String insertPageId,
    PageInfo pageInfo,
    boolean autoFlip)
java

新建页面

传入参数

返回值

• True: 成功
• False: 失败。频繁调用，小于 500 ms。

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

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

新建多个白板页

传入参数

返回值

• True: 成功
• False: 失败。频繁调用，小于 500 ms。

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

public abstract PageInfo com.ss.video.byteboard.WhiteBoard.getCurrentPageInfo()
java

获取当前页面信息

返回值
白板页信息，详见 PageInfo

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

获取所有页面信息

返回值
白板页信息，详见 PageInfo

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

获取当前页面索引

返回值
索引, -1 表示没有找到索引

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

获取白板总页数

返回值
总数

public abstract int com.ss.video.byteboard.WhiteBoard.getPageIndexByPageId(
    String pageId)
java

获取白板页所在索引号

传入参数

返回值
索引, -1 表示没有找到索引

public abstract PageInfo com.ss.video.byteboard.WhiteBoard.getPageInfoByIndex(
    int index)
java

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

传入参数

返回值
白板信息，详见 PageInfo

public abstract boolean com.ss.video.byteboard.WhiteBoard.removePage(
    List<String> pageIds)
java

批量删除白板页

传入参数

返回值

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

注意

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

public abstract boolean com.ss.video.byteboard.WhiteBoard.changePageBackground(
    String pageId,
    BackgroundInfo backgroundInfo)
java

修改单个页面的背景图、背景色

传入参数

返回值

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

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

public abstract boolean com.ss.video.byteboard.WhiteBoard.changeBoardBackground(
    BackgroundInfo backgroundInfo)
java

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

传入参数

返回值

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

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

public abstract boolean com.ss.video.byteboard.WhiteBoard.flipPage(
    String pageId)
java

翻页

传入参数

返回值

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

public abstract int com.ss.video.byteboard.WhiteBoard.bindToWindow(
    WindowConfig config)
java

将白板绑定到 UI 控件。

调用 unBindFromWindow 进行解绑。

传入参数

返回值
调用结果
0: 成功

注意
注意各端的 UI 控件比例要保持一致，例如固定为 4:3

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

解除白板和 UI 控件的绑定

调用 bindToWindow 将白板绑定到 UI 控件。

public abstract void com.ss.video.byteboard.WhiteBoard.setMediaSyncTimestamp(
    long timestamp)
java

设置时间戳

传入参数

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

保存当前白板快照。

注意
调用本 API 之后，将立即触发 onExportSnapshot 回调

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

WhiteBoard 房间接口类，用户通过这个类来进行白板房间相关操作

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

获取房间 ID

返回值
房间 ID

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

进房

返回值
调用结果

• 0: 成功
• !0: 失败

注意
调用后，本端触发 onJoinRoomResult 回调调用结果。

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

退房

注意
调用后，本端触发 onLeaveRoomResult 回调调用结果。

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

创建白板。

传入参数

返回值

• True: 成功
• False: 失败。

注意

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

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

关闭白板。

传入参数

注意
调用成功后，房间内所有用户都将收到 onCloseWhiteBoard 回调。

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

获取当前白板 ID。

返回值
当前白板 ID。-1 表示获取失败。

注意
获取到当前白板 ID后，可以调用 getWhiteBoard 获取相应的白板对象。

public abstract boolean com.ss.video.byteboard.WhiteBoardRoom.setActiveWhiteBoard(
    int boardId)
java

根据白板 ID 将其指定为当前白板。

传入参数

返回值

• True: 成功。调用成功后，房间内所有用户都将收到 onActiveWhiteBoardChanged。
• False: 失败。

注意
如无特殊说明，对白板进行编辑操作的 API 都只作用在当前白板上。

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

获取房间内所有白板。

返回值
白板列表。详见 BoardInfo。

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

关闭白板房间。关闭房间后，无法在白板上进行编辑操作。

注意

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

public abstract void com.ss.video.byteboard.WhiteBoardRoom.destroyWhiteBoard(
    WhiteBoard whiteBoard)
java

销毁本地白板实例。

传入参数

注意

• 调用本 API 后，房间内的白板仍保存在服务器。你可以在下次进房时继续使用这些白板。
• 如果你需要关闭白板，请调用 closeWhiteBoard。

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

通过白板 ID 获取白板对象

传入参数

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

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

开始播放白板录像

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

注意

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

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

暂停播放白板录像

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

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

停止播放白板录像

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

public abstract int com.ss.video.byteboard.WhiteBoardRoom.setPlaybackWhiteBoardProgress(
    long progress)
java

设置白板录像播放进度

传入参数

返回值
调用结果
0: 成功

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

WhiteBoard 对外的接口类，用户通过这个类来操作白板接口

public static void com.ss.video.byteboard.WhiteBoardRoomManager.setEnv(
    WhiteBoardDefine.Env env)
java

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

设置设备 ID

传入参数

public static void com.ss.video.byteboard.WhiteBoardRoomManager.setAid(
    String aid)
java

设置设备 ID

传入参数

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

设置日志路径

传入参数

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

设置文件路径

传入参数

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

获取白板 SDK 版本号。

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

返回值
SDK 版本号的字符串

public static void com.ss.video.byteboard.WhiteBoardRoomManager.outputLog(
    @WhiteBoardDefine.LogLevel int logLevel,
    String log)
java

将日志写入日志文件

静态方法，无需创建白板实例
日志存放目录 ./files/Logs

传入参数

public abstract WhiteBoardRoom com.ss.video.byteboard.WhiteBoardRoomManager.createWhiteBoardRoom(
    String roomID,
    String userID,
    String token,
    IWhiteBoardRoomEventHandler handler)
java

创建白板房间实例

传入参数

返回值
whiteBoardRoom 实例。参数校验失败时返回空的实例

注意
白板房间创建成功后自动创建白板，成功后将触发 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 void com.ss.video.byteboard.WhiteBoardRoomManager.enableMediaTimeSync(
    boolean enable)
java

开启/关闭时间戳回调

传入参数

注意
在参与白板互动的用户中，选择一个端作为参考对象。在这个端调用本接口，成功开启后将触发 2 秒一次的 onMediaSyncTimestamp 时间戳回调。将时间戳传给房间中的其他客户端，实现时间同步。