回调

@protocol ByteWhiteBoardDelegate <NSObject>

核心事件回调, ByteWhiteBoardDelegate 协议包含了 ByteWhiteBoard 提供的回调方法，通过代理向应用程序上报一些运行时事件，主要反应相关 API 调用发生的结果以及状态。 Callback functions are thrown synchronously in a non-UI thread within the SDK. Therefore, you must not perform any time-consuming operations or direct UI operations within the callback function, as this may cause the app to crash.

成员函数

函数说明

byteWhiteBoard:onError:message:

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

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

传入参数

byteWhiteBoard:onBoardLock:reason:

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

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

传入参数

byteWhiteBoard:onCanUndoStateChanged:

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

可撤销状态改变的回调。

传入参数

注意

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

byteWhiteBoard:onCanRedoStateChanged:

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

可重做状态改变的回调。

传入参数

注意

用户对白板进行编辑，也包括调用 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;

已创建一个新页面回调。

传入参数

注意

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

byteWhiteBoard:onRemovePages:boardId:pages:

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

已删除页面回调。

传入参数

注意

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

byteWhiteBoard:onClearPage:

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

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

传入参数

byteWhiteBoard:onPageIndexChanged:

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

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

传入参数

注意

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

byteWhiteBoard:onPageCountChanged:

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

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

传入参数

注意

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

byteWhiteBoard:onPageBackgroundChanged:boardId:pageId:backgroundInfo:

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

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

传入参数

注意

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

byteWhiteBoard:onBoardBackgroundChanged:boardId:boardBackgroundInfo:

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

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

传入参数

注意

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

byteWhiteBoard:onZoomInfoChanged:offstX:offstY:

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

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

传入参数

注意

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

byteWhiteBoard:onExportSnapshot:

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

保存当前页的快照。

传入参数

注意

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

byteWhiteBoard:onImageLoading:pageId:boardId:imageUrl:

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

加载画面回调。

传入参数

byteWhiteBoard:onPptStepChanged:currentStep:totalStep:currentPageIndex:

- (void)byteWhiteBoard:(ByteWhiteBoard *)board onPptStepChanged:(NSString *)userId currentStep:(NSInteger)step totalStep:(NSInteger)total currentPageIndex:(NSInteger)index;

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

传入参数

@protocol ByteWhiteBoardRoomDelegate <NSObject>

回调

成员函数

函数说明

byteWhiteBoardRoom:onError:message:

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

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

传入参数

byteWhiteBoardRoom:onCreateWhiteBoard:boardId:whiteboard:pptInfo:

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

白板创建回调。

传入参数

注意

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

byteWhiteBoardRoom:onRemoveWhiteBoard:boardId:pptInfo:

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

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

传入参数

注意

删除白板的接口是 removeWhiteBoard:。

byteWhiteBoardRoom:onCurrentWhiteBoardChanged:activeBoard:whiteboard:

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

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

传入参数

注意

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

byteWhiteBoardRoom:onPlaybackDataLoaded:finish:

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

回放录像加载成功回调。

传入参数

byteWhiteBoardRoom:onPlaybackStateChanged:reason:

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

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

传入参数