You need to enable JavaScript to run this app.
导航

回调

最近更新时间2023.10.20 17:59:47

首次发布时间2022.12.05 21:56:56

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

白板回调

成员函数

返回名称
voidonError
voidonBoardLock
voidonCanUndoStateChanged
voidonCanRedoStateChanged
voidonCreatePagesProgress
voidonRemovePages
voidonClearPage
voidonPageIndexChanged
voidonPageCountChanged
voidonPageBackgroundChanged
voidonBoardBackgroundChanged
voidonZoomInfoChanged
voidonExportSnapshot
voidonImageLoading
voidonPptStepChanged

函数说明

onError

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

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

传入参数

参数名类型说明
errCodeString错误码,详见 ErrorCode

onBoardLock

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

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

传入参数

参数名类型说明
lockboolean是否锁定
reasonString锁定原因提示

onCanUndoStateChanged

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

可撤销状态改变的回调。

传入参数

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

注意
用户对白板进行编辑,也包括调用 redoundo 接口,本端会收到本回调。

onCanRedoStateChanged

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

可重做状态改变的回调。

传入参数

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

注意
用户对白板进行编辑,也包括调用 redoundo 接口,本端会收到本回调。

onCreatePagesProgress

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

已创建一个新页面回调。

传入参数

参数名类型说明
boardIdint白板ID
pagesList刚创建的白板页面信息
insertPageIdString插入的前一页pageId, @deprecated since 1.6.1
progressint创建进度
totalCountint创建页后的白板总页数

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

onRemovePages

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

已删除页面回调。

传入参数

参数名类型说明
userIdString移除页面的用户
boardIdint当前白板 ID
pagesList被删除的页面 ID

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

onClearPage

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

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

onPageIndexChanged

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

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

传入参数

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

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

onPageCountChanged

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

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

传入参数

参数名类型说明
totalCountint总页数

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

onPageBackgroundChanged

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

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

传入参数

参数名类型说明
userIdString设置页面背景的用户
pageIdString被修改的页面 ID
bkInfoBackgroundInfo背景设置。详见 BackgroundInfo

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

onBoardBackgroundChanged

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

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

传入参数

参数名类型说明
userIdString设置白板背景的用户
boardIdint被修改的白板 ID
backgroundInfoBackgroundInfo背景设置。详见 BackgroundInfo

注意

onZoomInfoChanged

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

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

传入参数

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

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

onExportSnapshot

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

保存当前页的快照。

传入参数

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

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

onImageLoading

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

加载画面回调。

传入参数

参数名类型说明
statusWhiteBoardDefine.ImageLoadStatus图片加载状态 ImageLoadStatus
pageIdString页面 ID
boardIdint白板 ID
imageUrlString图片 URL

onPptStepChanged

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

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

传入参数

参数名类型说明
userIdString操作 PPT 并触发动画步数变化的用户
currentStepintPPT 当前动画步数
totalStepint当前 PPT 页面的所有动画数
currentPageIndexint当前页索引

注意
成功调用 pptNextSteppptPrevStep 后,在本端和远端触发一次本回调。

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

回调

成员函数

返回名称
voidonError
voidonCreateWhiteBoard
voidonRemoveWhiteBoard
voidonCurrentWhiteBoardChanged
voidonPlaybackDataLoaded
voidonPlaybackStateChanged
voidonPlaybackProgressUpdate
voidonConnectionStateChanged

函数说明

onError

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

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

传入参数

参数名类型说明
errCodeString错误码,含义详见 Error Code
messageString错误提示

onCreateWhiteBoard

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

白板创建回调。

传入参数

参数名类型说明
userIdString创建白板的用户 ID
boardIdint白板 ID
whiteBoardWhiteBoard刚创建的白板对象
pptInfoPPTInfo刚创建白板对应的PPT信息,可能为null

注意
调用 createWhiteBoardcreateFileWhiteBoard 成功创建白板后,房间内所有用户收到本回调。

onRemoveWhiteBoard

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

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

传入参数

参数名类型说明
userIdString删除白板的用户 ID
boardIdint被删除的白板 ID
pptInfoPPTInfo被删除白板对应的 PPT 信息,为 null 表示普通白板

注意
删除白板的的接口是 removeWhiteBoard

onCurrentWhiteBoardChanged

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

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

传入参数

参数名类型说明
userIdString用户 ID
activeBoardIdint当前白板 ID
whiteBoardWhiteBoard当前白板对象

注意
切换当前白板的的接口是 switchWhiteBoard

onPlaybackDataLoaded

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

回放录像加载成功回调。

传入参数

参数名类型说明
startTimestamplong回放开始时间,为精确到毫秒的 UNIX 时间戳
endTimestamplong回放结束时间,为精确到毫秒的 UNIX 时间戳

onPlaybackStateChanged

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

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

传入参数

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

onPlaybackProgressUpdate

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

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

传入参数

参数名类型说明
durationlong播放进度,单位 s
progresslong白板录像播放进度,单位 s

onConnectionStateChanged

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

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

传入参数

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

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

OnResult
public interface com.ss.video.byteboard.OnResult

接口调用结果回调

成员函数

返回名称
voidonSuccess
voidonError

函数说明

onSuccess

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

方法调用成功

传入参数

参数名类型说明
tT

onError

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

方法调用失败

传入参数

参数名类型说明
messageString错误信息