IWhiteBoardEventHandler

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

白板回调

成员函数

返回	名称
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

函数说明

onWarning

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

告警回调

传入参数

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

onError

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

错误回调

传入参数

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

onInitBoard

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

画板初始化

传入参数

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

onLockBoard

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

所以画板UI

传入参数

参数名	类型	说明
lock	boolean	是否锁住
reason	int	锁住原因

onCanUndoStateChanged

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

可撤销状态改变的回调

传入参数

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

onCanRedoStateChanged

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

可重做状态改变的回调

传入参数

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

onWhiteBoardPrepared

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

白板可用回调

onWhiteBoardAttachedToWindow

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

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

onWhiteBoardDetachedToWindow

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

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

onClearPage

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

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

onCreatePages

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

已创建一个新页面回调

传入参数

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

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

onRemovePages

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

已删除页面回调

传入参数

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

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

onChangePageBackground

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

页面背景信息被修改回调

传入参数

参数名	类型	说明
pageId	String	要修改页的pageId
backgroundInfo	BackgroundInfo	背景信息

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

onChangeBoardBackground

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

修改白板默认背景回调。

传入参数

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

注意

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

onPageIndexChanged

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

当前页发生改变时通知（跳转或删除），以便更新 UI

传入参数

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

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

onPagesCountChanged

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

总页数发生改变时通知（添加或删除），以便更新 UI

传入参数

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

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

IWhiteBoardRoomEventHandler

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

回调

成员函数

返回	名称
void	onWarning
void	onError
void	onJoinRoomResult
void	onLeaveRoomResult
void	onPlaybackWhiteBoardStateChanged
void	onPlaybackWhiteBoardProgressUpdate
void	onCreateWhiteBoard
void	onUserCountChanged

函数说明

onWarning

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

警告

传入参数

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

onError

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

错误码

传入参数

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

onJoinRoomResult

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

进房结果回调

传入参数

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

onLeaveRoomResult

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

退房结果回调

传入参数

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

onPlaybackWhiteBoardStateChanged

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

白板录像回放回调

传入参数

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

onPlaybackWhiteBoardProgressUpdate

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

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

传入参数

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

onCreateWhiteBoard

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

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

传入参数

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

onUserCountChanged

public void com.ss.video.byteboard.IWhiteBoardRoomEventHandler.onUserCountChanged(
    int count)

房间内用户人数回调远端调用 joinRoom 进房或 leaveRoom 退房后，触发本回调。

传入参数

参数名	类型	说明
count	int	房间内用户人数

IWhiteBoardRoomManagerEventHandler

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

回调

成员函数

返回	名称
void	onWarning
void	onError
void	onMediaSyncTimestamp

函数说明

onWarning

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

告警回调

传入参数

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

onError

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

错误回调

传入参数

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

onMediaSyncTimestamp

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

媒体时间戳回调

传入参数

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