ByteWhiteBoardDelegate

@protocol ByteWhiteBoardDelegate <NSObject>
objectivec

ByteWhiteBoardDelegate 协议包含了 ByteWhiteBoard 提供的回调方法，通过代理向应用程序上报一些运行时事件，主要反应相关 API 调用发生的结果以及状态。

成员函数

返回	名称
void	byteWhiteBoard:onError:message:
void	byteWhiteBoard:onBoardLock:reason:
void	byteWhiteBoard:onCanUndoStateChanged:
void	byteWhiteBoard:onCanRedoStateChanged:
void	byteWhiteBoard:onCreatePagesProgress:pages:insertPageId:progress:totalCount:
void	byteWhiteBoard:onRemovePages:boardId:pages:
void	byteWhiteBoard:onClearPage:
void	byteWhiteBoard:onPageIndexChanged:
void	byteWhiteBoard:onPageCountChanged:
void	byteWhiteBoard:onPageBackgroundChanged:boardId:pageId:backgroundInfo:
void	byteWhiteBoard:onBoardBackgroundChanged:boardId:boardBackgroundInfo:
void	byteWhiteBoard:onZoomInfoChanged:offstX:offstY:
void	byteWhiteBoard:onExportSnapshot:
void	byteWhiteBoard:onImageLoading:pageId:boardId:imageUrl:

函数说明

byteWhiteBoard:onError:message:

- (void)byteWhiteBoard:(ByteWhiteBoard *)board onError:(ByteWhiteBoardErrorCode)code message:(NSString *)message;
objectivec

当内部发生不可逆转测错误时回调。

传入参数

参数名	类型	说明
code	ByteWhiteBoardErrorCode	错误码，详见 ByteWhiteBoardErrorCode

byteWhiteBoard:onBoardLock:reason:

- (void)byteWhiteBoard:(ByteWhiteBoard *)board onBoardLock:(BOOL)isLock reason:(ByteWhiteBoardLockBoardReason)reason;
objectivec

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

传入参数

参数名	类型	说明
isLock	BOOL	锁定状态
reason	ByteWhiteBoardLockBoardReason	锁定原因，详见 ByteWhiteBoardLockBoardReason

byteWhiteBoard:onCanUndoStateChanged:

- (void)byteWhiteBoard:(ByteWhiteBoard *)board onCanUndoStateChanged:(BOOL)isCanUndo;
objectivec

可撤销状态改变的回调。

传入参数

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

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

byteWhiteBoard:onCanRedoStateChanged:

- (void)byteWhiteBoard:(ByteWhiteBoard *)board onCanRedoStateChanged:(BOOL)isCanRedo;
objectivec

可重做状态改变的回调。

传入参数

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

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

byteWhiteBoard:onCreatePagesProgress:pages:insertPageId:progress:totalCount:

- (void)byteWhiteBoard:(ByteWhiteBoard *)board onCreatePagesProgress:(NSString *)userId pages: (NSArray<ByteWhiteBoardPageInfo*>*)pageInfos insertPageId:(NSString *)insertPageId progress:(CGFloat)progress totalCount:(NSInteger)count;
objectivec

已创建一个新页面回调。

传入参数

参数名	类型	说明
userId	NSString*	创建页面的用户
pageInfos	NSArray<ByteWhiteBoardPageInfo>**	刚创建的白板页面信息
insertPageId	NSString*	指定页面的 pageId，新建页面将插入此页面之后
progress	CGFloat	创建进度
count	NSInteger	创建页后的白板总页数

注意
调用 createPages:index:isAutoFlip: 后，房间中所有用户将收到本回调。

byteWhiteBoard:onRemovePages:boardId:pages:

- (void)byteWhiteBoard:(ByteWhiteBoard *)board onRemovePages:(NSString *)userId boardId:(NSInteger)boardId pages:(NSArray<NSString*>*)pageIDs ;
objectivec

已删除页面回调。

传入参数

参数名	类型	说明
userId	NSString*	移除页面的用户
boardId	NSInteger	白板 ID
pageIDs	NSArray<NSString>**	被删除页面 ID

注意
调用 removePage:RemovePage: 后，房间中所有用户将收到本回调。

byteWhiteBoard:onClearPage:

- (void)byteWhiteBoard:(ByteWhiteBoard *)board onClearPage:(id)placeholder;
objectivec

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

传入参数

参数名	类型	说明
placeholder	id	形式参数，无需关注
	ByteWhiteBoard*

byteWhiteBoard:onPageIndexChanged:

- (void)byteWhiteBoard:(ByteWhiteBoard *)board onPageIndexChanged:(int)current_index;
objectivec

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

传入参数

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

注意
翻页，例如调用 flipPage: 或调用 removePage:RemovePage: 后，在本端和远端触发本回调。

byteWhiteBoard:onPageCountChanged:

- (void)byteWhiteBoard:(ByteWhiteBoard *)board onPageCountChanged:(NSInteger) totalCount;
objectivec

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

传入参数

参数名	类型	说明
totalCount	NSInteger	新的总页数

注意
成功调用 createPages:index:isAutoFlip: 或 removePage:RemovePage: 后，在本端和远端触发本回调。

byteWhiteBoard:onPageBackgroundChanged:boardId:pageId:backgroundInfo:

- (void)byteWhiteBoard:(ByteWhiteBoard *)board onPageBackgroundChanged:(NSString *)userId boardId:(NSInteger)boardId pageId:(NSString *)pageId backgroundInfo:(ByteWhiteBoardBackgroundInfo *)bk_info;
objectivec

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

传入参数

参数名	类型	说明
userId	NSString*	设置页面背景的用户
boardId	NSInteger	白板 ID
pageId	NSString*	被修改的页面 ID
bk_info	ByteWhiteBoardBackgroundInfo*	页面背景设置。详见 ByteWhiteBoardBackgroundInfo

注意
调用 setPageBackground: 后，房间中所有用户将收到本回调。

byteWhiteBoard:onBoardBackgroundChanged:boardId:boardBackgroundInfo:

- (void)byteWhiteBoard:(ByteWhiteBoard *)board onBoardBackgroundChanged:(NSString *)userId boardId:(NSInteger)boardId boardBackgroundInfo:(ByteWhiteBoardBackgroundInfo *)bk_info;
objectivec

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

传入参数

参数名	类型	说明
userId	NSString*	设置白板背景的用户
boardId	NSInteger	被修改的白板 ID
bk_info	ByteWhiteBoardBackgroundInfo*	白板背景设置

注意

调用 setBoardBackground: 后，房间中所有用户将收到本回调。
默认背景将应用在所有页面上。调用 setPageBackground: 可以设置单个白板页面背景。

byteWhiteBoard:onZoomInfoChanged:offstX:offstY:

- (void)byteWhiteBoard:(ByteWhiteBoard *)board onZoomInfoChanged:(CGFloat)zoom offstX:(NSInteger)centerX offstY:(NSInteger) centerY;
objectivec

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

传入参数

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

注意
成功调用 zoomTo:Y:X: 或 resetZoom 后，在本端和远端触发本回调。

byteWhiteBoard:onExportSnapshot:

- (void)byteWhiteBoard:(ByteWhiteBoard *)board onExportSnapshot:(NSString *)filePath;
objectivec

保存当前页的快照。

传入参数

参数名	类型	说明
filePath	NSString*	图片在本设备的存储绝对路径

注意
成功调用 exportSnapshot:withBackGround:后，在本端触发本回调。

byteWhiteBoard:onImageLoading:pageId:boardId:imageUrl:

- (void)byteWhiteBoard:(ByteWhiteBoard *)board onImageLoading:(ByteWhiteBoardImageLoadStatus)status pageId:(NSString *)pageId boardId:(NSInteger)boardId imageUrl:(NSString *)url;
objectivec

加载画面回调。

传入参数

参数名	类型	说明
status	ByteWhiteBoardImageLoadStatus	图片加载状态。详见 ByteWhiteBoardImageLoadStatus
pageId	NSString*	页面 ID
boardId	NSInteger	白板 ID
url	NSString*	图片 URL 地址

ByteWhiteBoardRoomDelegate

@protocol ByteWhiteBoardRoomDelegate <NSObject>
objectivec

回调

成员函数

返回	名称
void	byteWhiteBoardRoom:onError:message:
void	byteWhiteBoardRoom:onCreateWhiteBoard:boardId:whiteboard:
void	byteWhiteBoardRoom:onRemoveWhiteBoard:boardId:
void	byteWhiteBoardRoom:onCurrentWhiteBoardChanged:activeBoard:whiteboard:
void	byteWhiteBoardRoom:onPlaybackDataLoaded:finish:
void	byteWhiteBoardRoom:onPlaybackStateChanged:reason:
void	byteWhiteBoardRoom:onPlaybackProgressUpdate:duration:
void	byteWhiteBoardRoom:onConnectionStateChanged:

函数说明

byteWhiteBoardRoom:onError:message:

- (void)byteWhiteBoardRoom:(ByteWhiteBoardRoom *)boardRoom onError:(ByteWhiteBoardErrorCode)code message:(NSString *)message;
objectivec

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

传入参数

参数名	类型	说明
code	ByteWhiteBoardErrorCode	错误码，详见 ByteWhiteBoardErrorCode
message	NSString*	错误提示

byteWhiteBoardRoom:onCreateWhiteBoard:boardId:whiteboard:

- (void)byteWhiteBoardRoom:(ByteWhiteBoardRoom *)boardRoom onCreateWhiteBoard:(NSString *)userId boardId:(NSInteger)boardId whiteboard:(ByteWhiteBoard *)board;
objectivec

白板创建回调。

传入参数

参数名	类型	说明
userId	NSString*	创建白板的用户 ID
boardId	NSInteger	白板 ID
board	ByteWhiteBoardRoom*	刚创建的白板对象

注意
调用 createWhiteBoard:pageInfo:backgroundInfo:boardName: 成功创建白板后，房间内所有用户收到本回调。

byteWhiteBoardRoom:onRemoveWhiteBoard:boardId:

- (void)byteWhiteBoardRoom:(ByteWhiteBoardRoom *)boardRoom onRemoveWhiteBoard:(NSString *)userId boardId:(NSInteger)boardId;
objectivec

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

传入参数

参数名	类型	说明
userId	NSString*	删除白板的用户 ID
boardId	NSInteger	被删除的白板 ID

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

byteWhiteBoardRoom:onCurrentWhiteBoardChanged:activeBoard:whiteboard:

- (void)byteWhiteBoardRoom:(ByteWhiteBoardRoom *)boardRoom onCurrentWhiteBoardChanged:(NSString *)userId activeBoard:(NSInteger)activeBoardId whiteboard:(ByteWhiteBoard *)board;
objectivec

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

传入参数

参数名	类型	说明
userId	NSString*	更换白板的用户 ID
activeBoardId	NSInteger	当前白板 ID

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

byteWhiteBoardRoom:onPlaybackDataLoaded:finish:

- (void)byteWhiteBoardRoom:(ByteWhiteBoardRoom *)boardRoom onPlaybackDataLoaded:(int64_t)startTimestamp finish:(int64_t)endTimestamp;
objectivec

回放录像加载成功回调。

传入参数

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

byteWhiteBoardRoom:onPlaybackStateChanged:reason:

- (void)byteWhiteBoardRoom:(ByteWhiteBoardRoom *)boardRoom onPlaybackStateChanged:(NSInteger)state reason:(NSInteger)code;
objectivec

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

传入参数

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

byteWhiteBoardRoom:onPlaybackProgressUpdate:duration:

- (void)byteWhiteBoardRoom:(ByteWhiteBoardRoom *)boardRoom onPlaybackProgressUpdate:(CGFloat)progress duration:(CGFloat)duration;
objectivec

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

传入参数

参数名	类型	说明
duration	CGFloat	总播放时长，单位 s
progress	CGFloat	播放进度，单位 s

byteWhiteBoardRoom:onConnectionStateChanged:

- (void)byteWhiteBoardRoom:(ByteWhiteBoardRoom *)boardRoom onConnectionStateChanged:(ByteWhiteBoardConnectionState)state;
objectivec

SDK 与信令服务器连接状态回调。当 SDK 与信令服务器的网络连接状态改变时触发。

传入参数

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

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