@interface ByteWhiteBoard : NSObject
objectivec

白板接口类。调用 getCurrentWhiteBoard: 将返回当前的白板实例，你可以通过这个类来操作当前白板。

- (int)updateByteWhiteBoardDelegate:(id<ByteWhiteBoardDelegate>)delegate;
objectivec

设置事件回调。

传入参数

返回值
调用结果
0: 成功

- (void)getWhiteBoardId:(void (^)(NSInteger))block;
objectivec

获取当前的白板 ID。

传入参数

- (void)getWhiteBoardRoomId:(void (^)(NSString *_Nonnull))block;
objectivec

获取当前白板所在的房间 ID。

传入参数

- (void)getCurrentPageId:(void (^)(NSString *))block;
objectivec

获取当前页面的 PageId。

传入参数

- (int)setWritable:(BOOL)writable;
objectivec

设置当前白板是否可以编辑。

传入参数

返回值
调用结果
0: 成功

- (void)setEditType:(ByteWhiteBoardShapeType)shapeType;
objectivec

设置编辑动作类型。

传入参数

注意
如果默认的光标图形无法满足你的需求，调用 setCursorStylesetCursorStyle:，为不同工具过指定光标图形和样式。

- (void)setPenSize:(NSInteger)size;
objectivec

设置画笔笔迹宽度。

传入参数

- (int)setPenColor:(UIColor *)color;
objectivec

设置画笔颜色。

传入参数

- (int)setShapeSize:(NSInteger)width;
objectivec

设置形状线条宽度。

传入参数

- (int)setShapeColor:(UIColor *)color;
objectivec

设置图形边框颜色。

传入参数

- (int)setTextFontSize:(NSInteger)size;
objectivec

设置文本字号大小。

传入参数

- (int)setTextColor:(UIColor *)color;
objectivec

设置文本颜色。

传入参数

- (void)setSelectionBoxStyle:(ByteWhiteBoardAnchor *)anchor;
objectivec

设置选择框样式。如果默认的选择框样式无法满足你的需求，调用本接口，并传入需要修改的属性。默认样式详见 ByteWhiteBoardAnchor。

传入参数

- (void)enableCursorSync:(BOOL)enable;
objectivec

开启光标同步功能。开启后，房间中其他用户可以看到当前用户光标的实时移动轨迹。默认关闭。

传入参数

- (void)setCursorStyle:(NSDictionary<NSString *, ByteWhiteBoardCursorInfo *> *)styleConfig;
objectivec

自定义不同的工具光标样式。如果默认的光标图形无法满足你的需求，调用本接口，为不同工具过指定光标图形和样式。

传入参数

- (void)addImage:(NSString *)url rect:(ByteWhiteBoardImageRect *)imageRect completionHandler:(void (^)(ByteWhiteBoardAddImage))block;
objectivec

在当前页面中添加图片。

传入参数

- (void)addVideo:(NSString *)url title:(NSString *)videoTitle completionHandler:(void (^)(ByteWhiteBoardAddMedia, NSString*))block;
objectivec

在当前页面中添加视频，只支持 mp4 格式。

传入参数

注意

• 你可以在普通白板页和 PPT 白板页添加视频。
• 每个页面最多只能插入 1 个视频文件和 1 个音频文件。
• 播放器默认居中放置。
• 当 EditType 为 Pointer 时，用户可以对视频文件进行控制，包括播放、暂停和进度跳转等。也可以移动、缩放、全屏和删除播放器。这些操作都将实时同步到远端。音量控制只在本端生效。
• 画笔等笔迹工具不支持在播放器上进行绘制。

- (void)addAudio:(NSString *)url title:(NSString *)audioTitle completionHandler:(void (^)(ByteWhiteBoardAddMedia, NSString*))block;
objectivec

在当前页面中添加音频，只支持 mp3 格式。

传入参数

注意

• 你可以在普通白板页和 PPT 白板页添加音频。
• 每个页面最多只能插入 1 个视频文件和 1 个音频文件。
• 播放器默认居中放置。
• 当 EditType 为 Pointer 时，用户可以对音频文件进行控制，包括播放、暂停和进度跳转等。也可以移动、缩放和删除播放器。这些操作都将实时同步到远端。音量控制只在本端生效。
• 画笔等笔迹工具不支持在播放器上进行绘制。

- (void)undo;
objectivec

撤销本端对白板的编辑操作。

当 byteWhiteBoard:onCanUndoStateChanged: 返回的状态为 false 时，调用本接口无效。

- (void)redo;
objectivec

重做本端对白板的编辑操作。

当 byteWhiteBoard:onCanRedoStateChanged: 返回的状态为 false 时，调用本接口无效。

- (int)clearPage;
objectivec

清除页面。

调用成功后在房间内所有客户端触发 byteWhiteBoard:onClearPage:

返回值
调用结果
0: 成功

- (int)createPages:(NSArray<ByteWhiteBoardPageInfo *> *)infos index:(NSInteger)insertPageIndex isAutoFlip:(BOOL)autoFlip;
objectivec

新建多个白板页。

传入参数

返回值
调用结果
0: 成功

- (int)removePages:(NSArray<NSString *> *)pageIdList flip:(NSInteger)flipPageIndex;
objectivec

按照指定的索引号，删除白板页。

传入参数

返回值
调用结果
0: 成功

注意
成功调用后将触发 byteWhiteBoard:onRemovePages:boardId:pages: 回调。

- (int)flipPage:(NSInteger)pageIndex;
objectivec

白板翻页。

传入参数

返回值
调用结果
0: 成功。调用成功后在房间内所有客户端触发 byteWhiteBoard:onPageIndexChanged:

- (void)flipNextPage;
objectivec

白板翻到下一页。
调用成功后在房间内所有客户端触发 byteWhiteBoard:onPageIndexChanged:

- (void)flipPrevPage;
objectivec

白板翻到上一页。

调用成功后在房间内所有客户端触发 byteWhiteBoard:onPageIndexChanged:

- (int)setPageBackground:(ByteWhiteBoardBackgroundInfo *)info;
objectivec

修改当前白板页面的背景设置，例如背景图片颜色等。

传入参数

返回值
调用结果
0: 成功

注意

• 调用 setBoardBackground: 可以设置白板背景。页面背景显示优先级高于白板背景，与调用顺序无关。
• 成功调用本接口后在本端和远端触发 byteWhiteBoard:onPageBackgroundChanged:boardId:pageId:backgroundInfo: 回调。

- (int)setBoardBackground:(ByteWhiteBoardBackgroundInfo *)info;
objectivec

修改当前白板的背景设置，例如背景图片颜色等。

传入参数

返回值
调用结果
0: 成功

注意

• 调用本回调后会在本端和远端触发 byteWhiteBoard:onBoardBackgroundChanged:boardId:boardBackgroundInfo:。
• 调用 setPageBackground: 可以设置页面背景。页面背景显示优先级高于白板背景，与调用顺序无关。

- (void)getCurrentPageInfo:(void (^)(ByteWhiteBoardPageInfo *_Nonnull))block;
objectivec

获取当前页面信息。详见 ByteWhiteBoardPageInfo

- (void)getCurrentPageIndex:(void (^)(NSInteger))block;
objectivec

获取当前页面索引。

传入参数

- (void)getAllPageInfo:(void (^)(NSArray<ByteWhiteBoardPageInfo *> *_Nonnull))block;
objectivec

获取所有页面信息。

传入参数

- (void)getPageInfoByIndex:(NSInteger)index completionHandler:(void (^)(ByteWhiteBoardPageInfo *_Nonnull))block;
objectivec

通过索引号获取白板页信息。

传入参数

- (void)getPagesCount:(void (^)(NSInteger))block;
objectivec

获取白板总页数。

传入参数

- (void)exportSnapshot:(NSInteger)pageIndex withElements:(BOOL)isElements withBackGround:(BOOL)isBackGround;
objectivec

将当前白板中指定页面保存为一张本地图片。

传入参数

注意

• 调用成功后，将通过 byteWhiteBoard:onExportSnapshot: 回调图片在本设备的绝对路径。
• 短时间内多次调用本 API 时，等待获取结果回调时间可能增加。
• PPT 白板页导出的快照仅包含预加载状态的图片。

- (void)setViewMode:(ByteWhiteBoardViewMode) viewMode;
objectivec

设置白板视角同步方式。

传入参数

- (void)getViewMode:(void (^)(ByteWhiteBoardViewMode))block;
objectivec

获取视图模式。

传入参数

- (void)setMaxZoom:(CGFloat)maxScale;
objectivec

设置白板视图最大放大系数。

传入参数

注意

• 设置成功后，将改变调用以下 API 的参数上限： zoomIn ， zoomOut 或 zoomTo。
• PPT 白板的最大放大倍数设置为 2。超过时，可能在 Android 端引起卡顿问题。

- (int)zoomIn:(double)scale;
objectivec

按照当前中心点和缩放系数放大白板视图。

传入参数

返回值
调用结果
0: 成功

注意

• 缩放中心点为当前视图中心。
• 当多个用户同时进行缩放设置时，发起较晚的用户设置失败。

- (int)zoomOut:(double)scale;
objectivec

按照当前中心点和缩放系数缩小白板视图。

传入参数

返回值
调用结果
0: 成功

注意

• 缩放中心点为当前视图中心。
• 当多个用户同时进行缩放设置时，发起较晚的用户设置失败。

- (int)zoomTo:(double)scale Y:(int)centerX X:(int)centerY;
objectivec

按照指定中心点和缩放系数缩放白板视图。

传入参数

返回值
调用结果
0: 成功

注意

• 缩放中心点为当前视图中心。
• 当多个用户同时进行缩放设置时，将按服务端收到指令的时间顺序应用设置。

- (BOOL)resetZoom;
objectivec

恢复默认缩放视图。还原到原始大小，视图中心点恢复为白板中心点。

返回值
调用结果

• true: 成功
• false: 失败。

- (void)getZoomFactor:(void (^)(double))block;
objectivec

获取当前白板视图缩放系数。

传入参数

- (void)getPptInfo:(void (^)(ByteWhiteBoardPptInfo *))block;
objectivec

获取当前 PPT 信息，非 PPT 白板返回空

传入参数

注意
调用 createFileWhiteBoard:boardName:pptInfo: 可以创建一个 PPT 白板。

- (void)pptNextStep;
objectivec

下一个 PPT 动画，如果是最后一个动画，翻到下一页

注意

• 非 PPT 白板调用无效调用
• createFileWhiteBoard:boardName:pptInfo: 可以创建一个 PPT 白板。
• 成功调用后在在房间内所有客户端触发 byteWhiteBoard:onPptStepChanged:currentStep:totalStep:currentPageIndex: 回调。

- (void)pptPrevStep;
objectivec

上一个 PPT 动画，如果是第一个动画，翻到上一页

注意

• 非 PPT 白板调用无效调用
• createFileWhiteBoard:boardName:pptInfo: 可以创建一个 PPT 白板。
• 成功调用后在在房间内所有客户端触发 byteWhiteBoard:onPptStepChanged:currentStep:totalStep:currentPageIndex: 回调。

@interface ByteWhiteBoardRoom : NSObject
objectivec

白板房间接口类。
调用 joinRoom:userID:token:defalutBoard:completionHandler:delegate: 之后，自动返回一个可以操作的 WhiteBoardRoom 实例。你可以通过这个类来进行白板房间相关操作。

- (void)updateByteWhiteBoardRoomDelegate:(id<ByteWhiteBoardRoomDelegate>)delegate;
objectivec

更新 ByteWhiteBoardRoomDelegate 回调手柄。

传入参数

- (void)getRoomId:(void (^)(NSString *))block;
objectivec

获得当前白板房间 ID。

传入参数

注意
当本端用户已经进入白板房间后，你可以调用本接口查询当前房间 ID。

- (void)getRoomStatus:(void (^)(ByteWhiteBoardRoomStatus))block;
objectivec

获取房间状态。

传入参数

- (void)leaveRoom;
objectivec

退房。

注意

• 互动白板按照用户在房间内的时长进行计费，你应在当前用户结束白板使用时调用本接口退出房间。
• 用户退出房间后，可以调用 joinRoom:userID:token:defalutBoard:completionHandler:delegate: 再次加入该房间。
• 如果房间内所有用户都已结束互动，你可以调用 destroyRoom 关闭房间。

- (void)destroyRoom;
objectivec

关闭所有白板，重进房间后无法进行写画。

注意

• 如果你希望在下次进房时仍可以继续进行白板互动，应调用 leaveRoom 退房，此后调用 joinRoom:userID:token:defalutBoard:completionHandler:delegate: 进房，可以继续此前的白板操作。
• 如果已经在控制台开通和配置了白板录制，白板创建后自动录制。只有当调用本接口关闭白板之后，才可以开始播放录像。

- (void)createWhiteBoard:(NSInteger)boardID pageInfo:(NSArray<ByteWhiteBoardPageInfo *>*)pages backgroundInfo:(ByteWhiteBoardBackgroundInfo *)bkInfo boardName:(NSString *)boardName;
objectivec

在房间内创建一个白板。

传入参数

注意
成功调用后将触发 byteWhiteBoardRoom:onCreateWhiteBoard:boardId:whiteboard:pptInfo:

- (void)createFileWhiteBoard:(NSInteger)boardId boardName:(NSString *)name pptInfo:(ByteWhiteBoardPptInfo *)createBoardInfo;
objectivec

在房间内创建一个 PPT 白板

传入参数

注意

• 进行 PPT 共享时，只需要发起端调用本接口，房间中的其他用户端将自动创建 PPT 白板，无需手动调用本接口。
• 成功调用后将触发 byteWhiteBoardRoom:onCreateWhiteBoard:boardId:whiteboard:pptInfo:

-(void)removeWhiteBoard:(NSInteger)boardID;
objectivec

关闭指定白板。

传入参数

注意
成功调用后将触发 byteWhiteBoardRoom:onRemoveWhiteBoard:boardId:pptInfo:

-(void)switchWhiteBoard:(NSInteger)boardID;
objectivec

指定当前白板。

传入参数

注意
调用后将触发 byteWhiteBoardRoom:onCurrentWhiteBoardChanged:activeBoard:whiteboard:

- (void)getCurrentWhiteBoardId:(void (^)(NSInteger))block;
objectivec

获取当前的白板 ID。

传入参数

- (void)getWhiteBoardInfo:(NSInteger)boardID completionHandler:(void (^)(ByteWhiteBoardInfo *))block;
objectivec

通过白板 ID 获取白板信息。

传入参数

- (void)getCurrentWhiteBoard:(void (^)(ByteWhiteBoard *))block;
objectivec

获取当前白板对象。

传入参数

-(void)getAllWhiteBoardInfo:(void (^)(NSArray *))block;
objectivec

获取所有白板信息。

传入参数

- (void)startPlayback;
objectivec

开始播放白板录像。

成功调用后，触发 byteWhiteBoardRoom:onPlaybackStateChanged:reason: 播放状态回调。

注意

• 使用录像和回放时，需要在控制台开通和配置白板录制功能。
• 调用时机：房间中至少有一个用户 destroyRoom 关闭白板，之后，所有用户在重新进房后，即调用 leaveRoom 退房，再调用 joinRoom:userID:token:defalutBoard:completionHandler:delegate: 重新进房后，才可以调用本接口开始播放录像。
• 录像存储路径 ./AppData/Library/Caches

- (void)pausePlayback;
objectivec

暂停播放白板录像。

成功调用后，触发 byteWhiteBoardRoom:onPlaybackStateChanged:reason: 播放状态回调。

- (void)stopPlayback;
objectivec

停止播放白板录像。

成功调用后，触发 byteWhiteBoardRoom:onPlaybackStateChanged:reason: 播放状态回调。

- (void)setPlaybackProgress:(NSInteger)progress block:(void (^)(void))block;
objectivec

设置白板回放进度。

传入参数

注意
调用后将触发 onPlaybackProgressUpdate

@interface ByteWhiteBoardRoomManager : NSObject
objectivec

白板房间管理接口类，你可以通过这个类来操作白板 SDK 接口。

+ (instancetype)sharedEngineWithAppId:(NSString *)appId bindToWindow:(UIView *)view completionHandler:(void (^)(void))block;
objectivec

创建和初始化白板 ByteWhiteBoardRoomManager 实例。

传入参数

返回值
ByteWhiteBoardRoomManager 实例

+ (void)destroy;
objectivec

销毁 ByteWhiteBoardRoomManager 实例，释放资源。

+ (void)setDeviceID:(NSString *)deviceID;
objectivec

设置设备 ID。

传入参数

+ (void)setLogLocation:(NSString *)path;
objectivec

设置本地日志缓存路径。

传入参数

- (void)joinRoom:(NSString *)roomID userID:(NSString *)userID token:(NSString *)token defalutBoard:(ByteWhiteBoardInfo *)boardInfo completionHandler:(void (^)(ByteWhiteBoardRoom *))block delegate:(id)delegate;
objectivec

加入白板房间。

传入参数

注意
如果当前房间没有白板，将按照传入的参数创建一个白板，成功后将触发 byteWhiteBoardRoom:onCreateWhiteBoard:boardId:whiteboard:pptInfo: 回调。

- (NSString *)getSdkVersion;
objectivec

获取白板 SDK 版本号。

返回值
SDK 版本号

- (UIView *)getView;
objectivec

获取当前白板视图。

返回值
白板视图