IWhiteBoardEventHandler

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

白板 SDK 的事件回调类

成员函数

返回	名称
void	onError
void	onBoardLock
void	onCanUndoStateChanged
void	onCanRedoStateChanged
void	onCreatePagesProgress
void	onRemovePages
void	onClearPage
void	onPageIndexChanged
void	onPageCountChanged
void	onPageBackgroundChanged
void	onBoardBackgroundChanged
void	onZoomInfoChanged
void	onExportSnapshot
void	onImageLoading
void	onPptStepChanged

函数说明

onError

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

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

传入参数

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

onBoardLock

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

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

传入参数

参数名	类型	说明
lock	boolean	是否锁定
reason	String	锁定原因提示

onCanUndoStateChanged

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

可撤销状态改变的回调。

传入参数

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

注意

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

onCanRedoStateChanged

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

可重做状态改变的回调。

传入参数

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

注意

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

onCreatePagesProgress

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

已创建一个新页面回调。

传入参数

参数名	类型	说明
boardId	int	白板ID
pages	List<PageInfo>	刚创建的白板页面信息
insertPageId	String	插入的前一页pageId, @deprecated since 1.6.1
progress	int	创建进度
totalCount	int	创建页后的白板总页数

注意

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

onRemovePages

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

已删除页面回调。

传入参数

参数名	类型	说明
userId	String	移除页面的用户
boardId	int	当前白板 ID
pages	List<String>	被删除的页面 ID

注意

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

onClearPage

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

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

onPageIndexChanged

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

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

传入参数

参数名	类型	说明
currentIndex	int	当前页索引

注意

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

onPageCountChanged

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

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

传入参数

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

注意

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

onPageBackgroundChanged

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

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

传入参数

参数名	类型	说明
userId	String	设置页面背景的用户
boardId	String	-
pageId	String	被修改的页面 ID
bkInfo	BackgroundInfo	背景设置。详见 BackgroundInfo

注意

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

onBoardBackgroundChanged

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

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

传入参数

参数名	类型	说明
userId	String	设置白板背景的用户
boardId	int	被修改的白板 ID
backgroundInfo	BackgroundInfo	背景设置。详见 BackgroundInfo

注意

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

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

onZoomInfoChanged

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

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

传入参数

参数名	类型	说明
zoom	double	缩放比例 [1-20], 1 表示 100%
offsetX	double	视角中心点 x 坐标，默认为 0
offsetY	double	视角中心点 y 坐标，默认为 0

注意

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

onExportSnapshot

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

保存当前页的快照。

传入参数

参数名	类型	说明
pageIndex	int	白板页索引
filePath	String	图片在本设备的存储绝对路径

注意

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

onImageLoading

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

加载画面回调。

传入参数

参数名	类型	说明
status	WhiteBoardDefine.ImageLoadStatus	图片加载状态 ImageLoadStatus
pageId	String	页面 ID
boardId	int	白板 ID
imageUrl	String	图片 URL

onPptStepChanged

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

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

传入参数

参数名	类型	说明
userId	String	操作 PPT 并触发动画步数变化的用户
currentStep	int	PPT 当前动画步数
totalStep	int	当前 PPT 页面的所有动画数
currentPageIndex	int	当前页索引

注意

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

IWhiteBoardRoomEventHandler

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

回调

成员函数

返回	名称
void	onError
void	onCreateWhiteBoard
void	onRemoveWhiteBoard
void	onCurrentWhiteBoardChanged
void	onPlaybackDataLoaded
void	onPlaybackStateChanged
void	onPlaybackProgressUpdate
void	onConnectionStateChanged

函数说明

onError

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

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

传入参数

参数名	类型	说明
errCode	String	错误码，含义详见 Error Code
message	String	错误提示

onCreateWhiteBoard

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

白板创建回调。

传入参数

参数名	类型	说明
userId	String	创建白板的用户 ID
boardId	int	白板 ID
whiteBoard	WhiteBoard	刚创建的白板对象
pptInfo	PPTInfo	刚创建白板对应的PPT信息，可能为null

注意

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

onRemoveWhiteBoard

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

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

传入参数

参数名	类型	说明
userId	String	删除白板的用户 ID
boardId	int	被删除的白板 ID
pptInfo	PPTInfo	被删除白板对应的 PPT 信息，为 null 表示普通白板

注意

删除白板的的接口是 removeWhiteBoard。

onCurrentWhiteBoardChanged

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

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

传入参数

参数名	类型	说明
userId	String	用户 ID
activeBoardId	int	当前白板 ID
whiteBoard	WhiteBoard	当前白板对象

注意

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

onPlaybackDataLoaded

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

回放录像加载成功回调。

传入参数

参数名	类型	说明
startTimestamp	long	回放开始时间，为精确到毫秒的 UNIX 时间戳
endTimestamp	long	回放结束时间，为精确到毫秒的 UNIX 时间戳

onPlaybackStateChanged

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

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

传入参数

参数名	类型	说明
state	int	当前状态码 0：初始化 1：暂停播放 2：开始播放 3：停止状态
reason	int	状态切换原因代码 0：用户或系统主动行为 101：开始播放时资源加载 102：seek 行为做数据准备 601：播放结束 602：数据为空 603：数据错误 604：数据下载失败

onPlaybackProgressUpdate

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

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

传入参数

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

onConnectionStateChanged

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

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

传入参数

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

注意

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

OnResult

public interface com.ss.video.byteboard.OnResult

接口调用结果回调

成员函数

返回	名称
void	onSuccess
void	onError

函数说明

onSuccess

void com.ss.video.byteboard.OnResult<T>.onSuccess(T t)

方法调用成功

传入参数

参数名	类型	说明
t	T	-

onError

void com.ss.video.byteboard.OnResult<T>.onError(String message)

方法调用失败

传入参数

参数名	类型	说明
message	String	错误信息

实时音视频