回调

public abstract class com.ss.video.byteboard.IWhiteBoardEventHandler

白板 SDK 的事件回调类

成员函数

函数说明

onError

public void com.ss.video.byteboard.IWhiteBoardEventHandler.onError(
    String errCode,
    String message
)

当内部发生错误信息时回调该事件。

传入参数

onBoardLock

public void com.ss.video.byteboard.IWhiteBoardEventHandler.onBoardLock(
    boolean lock,
    String reason
)

当白板锁定状态发生改变时，将触发该回调。

传入参数

onCanUndoStateChanged

public void com.ss.video.byteboard.IWhiteBoardEventHandler.onCanUndoStateChanged(boolean isCanUndo)

可撤销状态改变的回调。

传入参数

注意

用户对白板进行编辑，也包括调用 redo 和 undo 接口，本端会收到本回调。

onCanRedoStateChanged

public void com.ss.video.byteboard.IWhiteBoardEventHandler.onCanRedoStateChanged(boolean isCanRedo)

可重做状态改变的回调。

传入参数

注意

用户对白板进行编辑，也包括调用 redo 和 undo 接口，本端会收到本回调。

onCreatePagesProgress

public void com.ss.video.byteboard.IWhiteBoardEventHandler.onCreatePagesProgress(
    int boardId,
    List<PageInfo> pages,
    String insertPageId,
    int progress,
    int totalCount
)

已创建一个新页面回调。

传入参数

注意

调用 createPages 后，房间中所有用户将收到本回调。

onRemovePages

public void com.ss.video.byteboard.IWhiteBoardEventHandler.onRemovePages(
    String userId,
    int boardId,
    List<String> pages
)

已删除页面回调。

传入参数

注意

调用 removePages 后，房间中所有用户将收到本回调。

onClearPage

public void com.ss.video.byteboard.IWhiteBoardEventHandler.onClearPage()

白板清空回调。 调用 clearPage 后，房间中所有用户将收到本回调。

onPageIndexChanged

public void com.ss.video.byteboard.IWhiteBoardEventHandler.onPageIndexChanged(int currentIndex)

当前页发生改变时触发此回调，例如，翻页或删除操作。监听本回调及时更新 UI 画面。

传入参数

注意

翻页，例如调用 flipPage 或调用 removePages 删除页面后，在本端和远端触发本回调。

onPageCountChanged

public void com.ss.video.byteboard.IWhiteBoardEventHandler.onPageCountChanged(int totalCount)

总页数发生改变时触发此回调，例如，创建新页面或删除操作。监听本回调及时更新 UI 画面。

传入参数

注意

成功调用 createPages 或 removePages 后，在本端和远端触发本回调。

onPageBackgroundChanged

public void com.ss.video.byteboard.IWhiteBoardEventHandler.onPageBackgroundChanged(
    String userId,
    String boardId,
    String pageId,
    BackgroundInfo bkInfo
)

页面背景信息被修改时触发该回调。

传入参数

注意

调用 setPageBackground 后在本端和远端触发本回调。

onBoardBackgroundChanged

public void com.ss.video.byteboard.IWhiteBoardEventHandler.onBoardBackgroundChanged(
    String userId,
    int boardId,
    BackgroundInfo backgroundInfo
)

白板背景信息被修改时触发该回调。

传入参数

注意

• 调用 setBoardBackground 后在本端和远端触发本回调。

• 默认背景将应用在所有页面上。调用 setBoardBackground 可以设置单个白板页面背景。

onZoomInfoChanged

public void com.ss.video.byteboard.IWhiteBoardEventHandler.onZoomInfoChanged(
    double zoom,
    double offsetX,
    double offsetY
)

当前白板的缩放信息改变时通知，以便更新 UI。

传入参数

注意

成功调用 zoomTo 或 resetZoom 后，在本端和远端触发本回调。

onExportSnapshot

public void com.ss.video.byteboard.IWhiteBoardEventHandler.onExportSnapshot(
    int pageIndex,
    String filePath
)

保存当前页的快照。

传入参数

注意

成功调用 exportSnapshot 后，在本端触发本回调。返回快照地址不会为 null

onImageLoading

public void com.ss.video.byteboard.IWhiteBoardEventHandler.onImageLoading(
    WhiteBoardDefine.ImageLoadStatus status,
    String pageId,
    int boardId,
    String imageUrl
)

加载画面回调。

传入参数

onPptStepChanged

public void com.ss.video.byteboard.IWhiteBoardEventHandler.onPptStepChanged(
    String userId,
    int currentStep,
    int totalStep,
    int currentPageIndex
)

PPT 当前动画步数改变。任何与 PPT 动画步数相关事件发生时，都会触发本回调。

传入参数

注意

成功调用 pptNextStep 或 pptPrevStep 后，在本端和远端触发一次本回调。

public abstract class com.ss.video.byteboard.IWhiteBoardRoomEventHandler

回调

成员函数

函数说明

onError

public void com.ss.video.byteboard.IWhiteBoardRoomEventHandler.onError(
    String errCode,
    String message
)

当内部发生错误信息时回调该事件。

传入参数

onCreateWhiteBoard

public void com.ss.video.byteboard.IWhiteBoardRoomEventHandler.onCreateWhiteBoard(
    String userId,
    int boardId,
    WhiteBoard whiteBoard,
    PPTInfo pptInfo
)

白板创建回调。

传入参数

注意

调用 createWhiteBoard 或 createFileWhiteBoard 成功创建白板后，房间内所有用户收到本回调。

onRemoveWhiteBoard

public void com.ss.video.byteboard.IWhiteBoardRoomEventHandler.onRemoveWhiteBoard(
    String userId,
    int boardId,
    PPTInfo pptInfo
)

白板被删除时，房间内其他用户收到本回调。

传入参数

注意

删除白板的的接口是 removeWhiteBoard。

onCurrentWhiteBoardChanged

public void com.ss.video.byteboard.IWhiteBoardRoomEventHandler.onCurrentWhiteBoardChanged(
    String userId,
    int activeBoardId,
    WhiteBoard whiteBoard
)

当前白板切换时，房间内其他用户收到本回调。

传入参数

注意

切换当前白板的的接口是 switchWhiteBoard。

onPlaybackDataLoaded

public void com.ss.video.byteboard.IWhiteBoardRoomEventHandler.onPlaybackDataLoaded(
    long startTimestamp,
    long endTimestamp
)

回放录像加载成功回调。

传入参数

onPlaybackStateChanged

public void com.ss.video.byteboard.IWhiteBoardRoomEventHandler.onPlaybackStateChanged(
    int state,
    int reason
)

当白板录像播放状态发生改变时触发此回调。

传入参数

onPlaybackProgressUpdate

public void com.ss.video.byteboard.IWhiteBoardRoomEventHandler.onPlaybackProgressUpdate(
    long progress,
    long duration
)

白板录像播放进度回调。调用 startPlayback 后触发本回调 200 ms 一次。

传入参数

onConnectionStateChanged

public void com.ss.video.byteboard.IWhiteBoardRoomEventHandler.onConnectionStateChanged(WhiteBoardDefine.ConnectionState state)