@protocol ByteWhiteBoardDelegate <NSObject>
objectivec

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

- (void)byteWhiteBoard:(ByteWhiteBoard *)board onOccurWarning:(ByteWhiteBoardWarningCode)Code;
objectivec

当内部发生警告信息时回调该事件

传入参数

- (void)byteWhiteBoard:(ByteWhiteBoard *)board onOccurError:(ByteWhiteBoardErrorCode)code;
objectivec

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

传入参数

- (void)byteWhiteBoard:(ByteWhiteBoard *)board onInitBoard:(NSArray<ByteWhiteBoardPageInfo*>*)pages currentPageID:(NSString*)pageID boardStatus:(ByteWhiteBoardBoardStatus)status;
objectivec

白板初始化

传入参数

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

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

传入参数

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

Undo 的状态回调，通知是否可以 Undo

传入参数

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

Redo 的状态回调，通知是否可以 Redo

传入参数

- (void)byteWhiteBoardAttachedToWindow:(ByteWhiteBoard *)board;
objectivec

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

传入参数

- (void)byteWhiteBoardDetachedToWindow:(ByteWhiteBoard *)board;
objectivec

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

传入参数

- (void)byteWhiteBoardClearPage:(ByteWhiteBoard *)board;
objectivec

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

传入参数

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

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

传入参数

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

- (void)byteWhiteBoard:(ByteWhiteBoard *)board onCreatePages:(NSString*)prePageID pageInfos:(NSArray<ByteWhiteBoardPageInfo*>*)pageInfos;
objectivec

已创建一个新页面回调

传入参数

注意
调用 createPage:config:isAutoFlip: 后在本端和远端触发本回调。

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

删除页

传入参数

注意
调用 removePage:RemovePage: 后在本端和远端触发本回调。

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

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

传入参数

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

- (void)byteWhiteBoard:(ByteWhiteBoard *)board onChangePageBackground:(NSString* )pageID backgroundInfo:(ByteWhiteBoardBackgroundInfo *)bk_info;
objectivec

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

传入参数

注意
调用 changePageBackgroundWhitPageID:bkInfo: 后在本端和远端触发本回调。

- (void)byteWhiteBoard:(ByteWhiteBoard *)board onChangeBoardBackground:(ByteWhiteBoardBackgroundInfo *)bk_info;
objectivec

修改白板默认背景回调。

传入参数

注意

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

- (void)byteWhiteBoard:(ByteWhiteBoard *)board onViewModeChanged:(ByteWhiteBoardViewMode)viewMode;
objectivec

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

传入参数

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

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

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

传入参数

注意

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

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

白板快照回调。

传入参数

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

@protocol ByteWhiteBoardRoomDelegate <NSObject>
objectivec

回调

- (void)byteWhiteBoardRoom:(ByteWhiteBoardRoom *)boardRoom onOccurWarning:(ByteWhiteBoardWarningCode)code;
objectivec

当内部发生警告信息时回调该事件

传入参数

- (void)byteWhiteBoardRoom:(ByteWhiteBoardRoom *)boardRoom onOccurError:(ByteWhiteBoardErrorCode)code;
objectivec

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

传入参数

- (void)byteWhiteBoardRoom:(ByteWhiteBoardRoom *)boardRoom onJoinRoomResult:(NSString *)roomID userID:(NSString *)userID errCode:(NSInteger)code isRejoin:(BOOL)rej;
objectivec

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

传入参数

- (void)byteWhiteBoardRoom:(ByteWhiteBoardRoom *)boardRoom onLeaveRoomResult:(NSString *)roomID reason:(NSInteger)reason;
objectivec

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

传入参数

- (void)byteWhiteBoardRoom:(ByteWhiteBoardRoom *)boardRoom onGetAllBoardInfo:(NSArray<ByteWhiteBoardInfo *> * )boardArray currentBoard:(NSInteger) activeBoardId roomActive:(BOOL)isRoomActive;
objectivec

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

传入参数

- (void)byteWhiteBoardRoom:(ByteWhiteBoardRoom *)boardRoom onActiveWhiteBoardChanged:(NSInteger)activeBoardId;
objectivec

当前活跃的白板被改变

传入参数

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

回放数据加载完毕回调

传入参数

- (void)byteWhiteBoardRoom:(ByteWhiteBoardRoom *)boardRoom onPlaybackWhiteBoardStateChanged:(NSInteger)state errCode:(NSInteger)code;
objectivec

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

传入参数

- (void)byteWhiteBoardRoom:(ByteWhiteBoardRoom *)boardRoom onPlaybackWhiteBoardProgressUpdate:(NSInteger)progress duration:(NSInteger)duration;
objectivec

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

传入参数

- (void)byteWhiteBoardRoom:(ByteWhiteBoardRoom *)boardRoom onCreateWhiteBoard:(ByteWhiteBoard *)board elapsed:(NSInteger)elapsed;
objectivec

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

传入参数

- (void)byteWhiteBoardRoom:(ByteWhiteBoardRoom *)boardRoom onCloseWhiteBoard:(ByteWhiteBoard *)board boardId:(NSInteger)boardId;
objectivec

关闭白板回调(WhiteBoard)

传入参数

@protocol ByteWhiteBoardRoomManagerDelegate <NSObject>
objectivec

ByteWhiteBoardRoomDelegate 回调

- (void)byteWhiteBoardRoomManager:(ByteWhiteBoardRoomManager *)boardRoomManager onOccurWarning:(ByteWhiteBoardWarningCode)code;
objectivec

当内部发生警告信息时回调该事件

传入参数

- (void)byteWhiteBoardRoomManager:(ByteWhiteBoardRoomManager *)boardRoomManager onOccurError:(ByteWhiteBoardErrorCode)code;
objectivec

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

传入参数

- (void)byteWhiteBoardRoomManager:(ByteWhiteBoardRoomManager *)boardRoomManager onConnectionStateChanged:(ByteWhiteBoardConnectionState)state;
objectivec

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

传入参数

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

- (void)byteWhiteBoardRoomManager:(ByteWhiteBoardRoomManager *)boardRoomManager onMediaSyncTimestamp:(int64_t)timestamp;
objectivec

媒体时间戳回调

传入参数

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