IWhiteBoardEventHandler

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

白板回调

成员函数

返回	名称
void	onWarning
void	onError
void	onInitBoard
void	onLockBoard
void	onCanUndoStateChanged
void	onCanRedoStateChanged
void	onWhiteBoardPrepared
void	onWhiteBoardAttachedToWindow
void	onWhiteBoardDetachedToWindow
void	onClearPage
void	onCreatePages
void	onRemovePages
void	onChangePageBackground
void	onChangeBoardBackground
void	onPageIndexChanged
void	onPagesCountChanged
void	onViewModeChanged
void	onZoomInfoChanged
void	onExportSnapshot

函数说明

onWarning

public void com.ss.video.byteboard.IWhiteBoardEventHandler.onWarning(
    int warningCode)
java

告警回调

传入参数

参数名	类型	说明
warningCode	int	告警码，详见 WarnCode

onError

public void com.ss.video.byteboard.IWhiteBoardEventHandler.onError(
    int errCode)
java

错误回调

传入参数

参数名	类型	说明
errCode	int	错误码，详见 ErrorCode

onInitBoard

public void com.ss.video.byteboard.IWhiteBoardEventHandler.onInitBoard(
    List<PageInfo> pages,
    String currentPageId,
    int status)
java

画板初始化。

传入参数

参数名	类型	说明
pages	List	所有画板页信息，详见 PageInfo
currentPageId	String	当前页
status	int	画板状态

onLockBoard

public void com.ss.video.byteboard.IWhiteBoardEventHandler.onLockBoard(
    boolean lock,
    int reason)
java

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

传入参数

参数名	类型	说明
lock	boolean	是否锁定
reason	int	锁定原因。详见 LockBoardReason。

onCanUndoStateChanged

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

可撤销状态改变的回调

传入参数

参数名	类型	说明
isCanUndo	boolean	可撤回状态，为 `true` 时可调用 undo 撤回前一步骤

onCanRedoStateChanged

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

可重做状态改变的回调

传入参数

参数名	类型	说明
isCanRedo	boolean	可重做状态，为 `true` 时可调用 redo 重复此前步骤。

onWhiteBoardPrepared

public void com.ss.video.byteboard.IWhiteBoardEventHandler.onWhiteBoardPrepared()
java

白板可用回调

onWhiteBoardAttachedToWindow

public void com.ss.video.byteboard.IWhiteBoardEventHandler.onWhiteBoardAttachedToWindow()
java

白板绑定到 UI 控件。成功调用 bindToWindow 后收到此回调

onWhiteBoardDetachedToWindow

public void com.ss.video.byteboard.IWhiteBoardEventHandler.onWhiteBoardDetachedToWindow()
java

白板解除和 UI 控件的绑定。成功调用 unBindFromWindow 后收到此回调

onClearPage

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

白板清空回调
调用 clearPage 后触发本回调。

onCreatePages

public void com.ss.video.byteboard.IWhiteBoardEventHandler.onCreatePages(
    String insertPageId,
    List<PageInfo> pages)
java

已创建一个新页面回调

传入参数

参数名	类型	说明
insertPageId	String	刚创建的白板页面 ID
pages	List	刚创建的白板页面信息，详见 PageInfo

注意
调用 createPage 后触发本回调。

onRemovePages

public void com.ss.video.byteboard.IWhiteBoardEventHandler.onRemovePages(
    List<String> pages)
java

已删除页面回调

传入参数

参数名	类型	说明
pages	List	被删除的页面 ID

注意
调用 removePage 后触发本回调。

onChangePageBackground

public void com.ss.video.byteboard.IWhiteBoardEventHandler.onChangePageBackground(
    String pageId,
    BackgroundInfo backgroundInfo)
java

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

传入参数

参数名	类型	说明
pageId	String	被修改的页面 ID
backgroundInfo	BackgroundInfo	背景信息。见 BackgroundInfo。

注意
调用 changePageBackground 后在本端和远端触发本回调。

onChangeBoardBackground

public void com.ss.video.byteboard.IWhiteBoardEventHandler.onChangeBoardBackground(
    BackgroundInfo backgroundInfo)
java

修改白板默认背景回调。

传入参数

参数名	类型	说明
backgroundInfo	BackgroundInfo	背景信息

注意

调用 changeBoardBackground 后在本端和远端触发本回调。+ 默认背景将应用在所有页面上。调用 changePageBackground 可以设置单个白板页面背景。

onPageIndexChanged

public void com.ss.video.byteboard.IWhiteBoardEventHandler.onPageIndexChanged(
    int currentIndex,
    PageInfo currentPageInfo)
java

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

传入参数

参数名	类型	说明
currentIndex	int	当前页索引
currentPageInfo	PageInfo	当前页信息，详见 PageInfo

注意
成功调用 flipPage 或 removePage 后，在本端和远端触发本回调。

onPagesCountChanged

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

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

传入参数

参数名	类型	说明
totalCount	int	总页数

注意
成功调用 createPage 或 removePage 后，在本端和远端触发本回调。

onViewModeChanged

public void com.ss.video.byteboard.IWhiteBoardEventHandler.onViewModeChanged(
    int viewMode)
java

本端的 ViewMode 被改变后触发本回调。

传入参数

参数名	类型	说明
viewMode	int	视图模式。枚举值含义详见 ViewMode。

注意
成功调用 setViewMode 改变 ViewMode 后触发本回调。

onZoomInfoChanged

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

当前白板的视图缩放改变通知回调。

传入参数

参数名	类型	说明
zoom	double	缩放系数。范围 [1, 20]。1 表示原始大小。
offsetX	int	X 坐标轴偏移量。页面中心为坐标原点。
offsetY	int	Y 坐标轴偏移量。页面中心为坐标原点。

注意

成功调用 zoomIn ， zoomOut , ZoomTozoomTo 或 ResetZoomresetZoom 后，在本端和远端触发本回调。
你可以使用本回调获取到的信息更新 UI 提示。

onExportSnapshot

public void com.ss.video.byteboard.IWhiteBoardEventHandler.onExportSnapshot(
    String pageId,
    String filePath)
java

白板快照回调。

传入参数

参数名	类型	说明
pageId	String	白板页 ID
filePath	String	本地保存路径

注意
成功调用 exportCurrentPageSnapshot 后，通过本回调返回快照地址。

IWhiteBoardRoomEventHandler

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

回调

成员函数

返回	名称
void	onWarning
void	onError
void	onJoinRoomResult
void	onLeaveRoomResult
void	onPlaybackWhiteBoardStateChanged
void	onPlaybackWhiteBoardProgressUpdate
void	onCreateWhiteBoard
void	onGetAllBoardInfo
void	onCloseWhiteBoard
void	onActiveWhiteBoardChanged
void	onLoadPlaybackData

函数说明

onWarning

public void com.ss.video.byteboard.IWhiteBoardRoomEventHandler.onWarning(
    int warningCode)
java

警告

传入参数

参数名	类型	说明
warningCode	int	告警码，详见 WarnCode

onError

public void com.ss.video.byteboard.IWhiteBoardRoomEventHandler.onError(
    int errCode)
java

错误码

传入参数

参数名	类型	说明
errCode	int	错误码，详见 ErrorCode。

onJoinRoomResult

public void com.ss.video.byteboard.IWhiteBoardRoomEventHandler.onJoinRoomResult(
    String roomID,
    String userID,
    int errCode,
    boolean isRejoin)
java

本端调用 joinRoom 进房的结果回调。

传入参数

参数名	类型	说明
roomID	String	房间 ID
userID	String	用户 ID
errCode	int	错误码。详见 ErrorCode。
isRejoin	boolean	进房结果

onLeaveRoomResult

public void com.ss.video.byteboard.IWhiteBoardRoomEventHandler.onLeaveRoomResult(
    String roomID,
    int reason)
java

本端调用 leaveRoom 的退房结果回调。

传入参数

参数名	类型	说明
roomID	String	房间 ID
reason	int	退房原因代码

onPlaybackWhiteBoardStateChanged

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

白板录像回放回调

传入参数

参数名	类型	说明
state	int	当前状态码，详见 PlaybackState
reason	int	状态切换原因代码，详见 PlaybackReason

onPlaybackWhiteBoardProgressUpdate

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

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

传入参数

参数名	类型	说明
progress	long	白板录像播放进度，单位 s
duration	long	总播放时长，单位 s

onCreateWhiteBoard

public void com.ss.video.byteboard.IWhiteBoardRoomEventHandler.onCreateWhiteBoard(
    WhiteBoard whiteBoard,
    int elapsed)
java

白板创建回调。进房后自动创建白板。

传入参数

参数名	类型	说明
whiteBoard	WhiteBoard	白板实例
elapsed	int	从进房成功到该回调的时长

onGetAllBoardInfo

public void com.ss.video.byteboard.IWhiteBoardRoomEventHandler.onGetAllBoardInfo(
    List<BoardInfo> boardInfos,
    int activeBoardId,
    boolean isRoomActive)
java

进入房间后，获取到所有白板信息

传入参数

参数名	类型	说明
boardInfos	List	所有白板的信息。详见 BoardInfo。
activeBoardId	int	当前活跃的白板
isRoomActive	boolean	房间是否活跃

onCloseWhiteBoard

public void com.ss.video.byteboard.IWhiteBoardRoomEventHandler.onCloseWhiteBoard(
    WhiteBoard whiteBoard,
    int boardId)
java

关闭白板回调

传入参数

参数名	类型	说明
whiteBoard	WhiteBoard	房间内的新白板对象
boardId	int	白板 ID

onActiveWhiteBoardChanged

public void com.ss.video.byteboard.IWhiteBoardRoomEventHandler.onActiveWhiteBoardChanged(
    int activeBoardId)
java

当前活跃的白板被改变

传入参数

参数名	类型	说明
activeBoardId	int	当前活跃的白板

onLoadPlaybackData

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

回放数据加载完毕回调

传入参数

参数名	类型	说明
startTimestamp	long	回放开始时间戳
endTimestamp	long	回放结束时间戳

IWhiteBoardRoomManagerEventHandler

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

回调

成员函数

返回	名称
void	onWarning
void	onError
void	onMediaSyncTimestamp
void	onConnectionStateChanged

函数说明

onWarning

public void com.ss.video.byteboard.IWhiteBoardRoomManagerEventHandler.onWarning(
    int warningCode)
java

告警回调

传入参数

参数名	类型	说明
warningCode	int	告警码，详见 WarnCode

onError

public void com.ss.video.byteboard.IWhiteBoardRoomManagerEventHandler.onError(
    int errCode)
java

错误回调

传入参数

参数名	类型	说明
errCode	int	错误码，详见 ErrorCode。

onMediaSyncTimestamp

public void com.ss.video.byteboard.IWhiteBoardRoomManagerEventHandler.onMediaSyncTimestamp(
    long timestamp)
java

媒体时间戳回调

传入参数

参数名	类型	说明
timestamp	long	时间戳

注意
调用 enableMediaTimeSync 开启后，将触发 2 秒一次周期性回调，返回时间戳，将时间戳作为 SEI 添加到视频帧中传递给其他用户实现 RTC 音视频互动和白板同步。

onConnectionStateChanged

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

回调 SDK 与信令服务器连接状态相关事件。当 SDK 与信令服务器的网络连接状态改变时回调该事件。

传入参数

参数名	类型	说明
state	WhiteBoardDefine.ConnectionState	当前 SDK 与信令服务器连接状态。详细定义参见 ConnectionState。

注意
更多信息参见连接状态提示。