@interface ByteWhiteBoard : NSObject
objectivec

ByteWhiteBoard 类包含应用程序调用的主要方法。

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

设置事件回调

传入参数

返回值
调用结果
0: 成功

- (NSInteger)getWhiteBoardID;
objectivec

获取当前白板的ID

返回值
白板ID

- (NSString*)getCurrentPageID;
objectivec

获取当前白板的PageID

返回值
PageID

- (NSString*)getWhiteBoardRoomID;
objectivec

获取当前白板的房间号

返回值
房间号

- (int)hideDrawing:(BOOL)ishide;
objectivec

设置是否隐藏白板

传入参数

返回值
调用结果
0: 成功

- (int)setEditMode:(ByteWhiteBoardEditMode)mode;
objectivec

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

传入参数

返回值
调用结果
0: 成功

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

设置编辑动作类型

传入参数

返回值
调用结果

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

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

设置画笔笔迹宽度

传入参数

返回值
调用结果
0: 成功

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

设置画笔颜色

传入参数

返回值
调用结果
0: 成功

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

设置形状线条宽度

传入参数

返回值
调用结果
0: 成功

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

设置图形边框颜色

传入参数

返回值
调用结果
0: 成功

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

设置文本字号大小

传入参数

返回值
调用结果
0: 成功

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

设置文本颜色

传入参数

返回值
调用结果
0: 成功

- (int)setShapeStyle:(ByteWhiteBoardAnchor *)anchor;
objectivec

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

传入参数

返回值
调用结果
0: 成功

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

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

传入参数

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

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

传入参数

返回值
调用结果

- (int)addImage:(NSString *)url X:(NSString *)positionX Y:(NSString *)positionY width:(NSString *)positionWidth height:(NSString *)positionHeight;
objectivec

在当前页面中添加图片

传入参数

返回值
调用结果
0: 成功

- (int)undo;
objectivec

撤销

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

返回值
调用结果
0: 成功

- (int)redo;
objectivec

重做

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

返回值
调用结果
0: 成功

- (int)clearPage;
objectivec

清空白板

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

返回值
调用结果
0: 成功

- (int)flipPage:(NSString*)pageID;
objectivec

白板翻页

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

传入参数

返回值
调用结果
0: 成功

- (int)createPage:(NSString* _Nullable)prePageID config:(ByteWhiteBoardPageInfo*)info isAutoFlip:(BOOL)autoFlip;
objectivec

新建白板页

传入参数

返回值
调用结果
0: 成功

- (int)createMultiPages:(NSString *)prePageID configs:(NSArray<ByteWhiteBoardPageInfo*> *)infos isAutoFlip:(BOOL)autoFlip;
objectivec

新建多个白板页

传入参数

返回值
调用结果
0: 成功

- (int)changePageBackgroundWhitPageID:(NSString*)pageID bkInfo:(ByteWhiteBoardBackgroundInfo*)info;
objectivec

修改白板页背景

传入参数

返回值
调用结果
0: 成功

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

修改整个board的所有页的背景

传入参数

返回值
调用结果
0: 成功

- (ByteWhiteBoardPageInfo*)getCurrentPageInfo;
objectivec

获取当前页面信息

返回值
白板页信息，详见 ByteWhiteBoardPageInfo

- (NSArray<ByteWhiteBoardPageInfo*>*)getAllPageInfo;
objectivec

获取所有页面信息

返回值
白板页信息，详见 ByteWhiteBoardPageInfo

- (NSInteger)getCurrentPageIndex;
objectivec

获取当前页面索引

返回值
索引

- (NSInteger)getAllPagesCount;
objectivec

获取白板总页数

返回值
总数

- (NSInteger)getPageIndexWhitPageId:(NSString*)pageID;
objectivec

获取白板页所在索引号

返回值
索引

- (ByteWhiteBoardPageInfo*)getPageInfoWhitIndex:(NSInteger)index;
objectivec

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

返回值
白板信息

- (void)exportCurrentPageSnapshot;
objectivec

获取当前白板页瞬照

返回值
白板信息

- (int)removePage:(NSArray<NSString*>*)pageIDs;
objectivec

删除白板页

传入参数

返回值
调用结果
0: 成功

- (int)bindToWindow:(UIView *)view;
objectivec

把画板UI绑定到某个view上

传入参数

返回值
调用结果
0: 成功

- (int)bindToWindowWithConfig:(ByteWhiteBoardWindowConfig*)config;
objectivec

把画板UI绑定到某个view上

传入参数

返回值
调用结果
0: 成功

- (int)unbindFromWindow;
objectivec

取消画板UI绑定

返回值
调用结果
0: 成功

- (int)setMediaSyncTimestamp:(int64_t)timestamp;
objectivec

设置同步时间戳

返回值
调用结果
0: 成功

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

设置白板视图跟随模式。

传入参数

注意

• 成功调用后将触发 byteWhiteBoard:onViewModeChanged: 回调。
• 设置为跟随模式时，无需手动调用 zoomIn: ， zoomOut: 或 zoomTo:Y:X:，SDK 将自动同步为控制方的视图设置。

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

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

传入参数

注意
设置成功后，将改变调用以下 API 的参数上限： zoomIn: ， zoomOut: 或 zoomTo:Y:X:。

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

按指定系数放大当前白板视图。

传入参数

返回值
调用结果

• true: 成功
• false: 失败。例如缩放系数错误超过合法范围。缩放系数，范围 [1, 20]。1 表示原始大小。放大系数上限默认为 20，以调用 setMaxZoom: 设置的为准。

注意

• 缩放中心点为当前视图中心。
• 当多个用户同时进行缩放设置时，将按服务端收到指令的时间顺序应用设置。
• 如果需要用户通过手势进行缩放可以将 ByteWhiteBoardShapeType 设置为 ByteWhiteBoardShapeTypeDrag。

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

按指定倍数缩小当前白板视图。

传入参数

返回值
调用结果

• true: 成功
• false: 失败。例如缩放系数错误超过合法范围。缩放系数，范围 [1, 20]。1 表示原始大小。

注意

• 缩放中心点为当前视图中心。
• 当多个用户同时进行缩放设置时，将按服务端收到指令的时间顺序应用设置。
• 如果需要用户通过手势进行缩放可以将 ByteWhiteBoardShapeType 设置为 ByteWhiteBoardShapeTypeDrag。

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

白板缩放&视角同步

传入参数

- (BOOL)resetZoom;
objectivec

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

返回值
调用结果

• true: 成功
• false: 失败。

- (double)getZoomFactor;
objectivec

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

返回值
当前白板视图缩放系数。范围 [1, 20]。1 表示原始大小。放大系数上限默认为 20，以调用 setMaxZoom: 设置的为准。

@interface ByteWhiteBoardRoom : NSObject
objectivec

ByteWhiteBoardRoom 接口

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

更新回调手柄

传入参数

- (NSString *)getRoomID;
objectivec

获得当前WhiteBoardRoom的房间ID

返回值
房间ID

- (void)joinRoom;
objectivec

进房

注意

• 调用后，本端触发 byteWhiteBoardRoom:onJoinRoomResult:userID:errCode:isRejoin: 回调调用结果。
• 房间内首个用户进房成功后自动创建白板。
• 进房成功后触发 byteWhiteBoardRoom:onCreateWhiteBoard:elapsed: 回调。

- (void)leaveRoom;
objectivec

退房

注意
调用后，本端触发 byteWhiteBoardRoom:onLeaveRoomResult:reason: 回调调用结果。

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

创建白板。

传入参数

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

关闭白板。

传入参数

注意
调用成功后，房间内所有用户都将收到 byteWhiteBoardRoom:onCloseWhiteBoard:boardId: 回调。

- (int)destroyWhiteBoard:(ByteWhiteBoard *)board;
objectivec

销毁本地白板实例。

传入参数

注意

• 调用本 API 后，房间内的白板仍保存在服务器。你可以在下次进房时继续使用这些白板。
• 如果你需要关闭白板，请调用 closeWhiteBoard:。

- (ByteWhiteBoard *)getWhiteBoardByID:(NSInteger)boardID;
objectivec

通过白板 ID 获取白板对象

传入参数

返回值
白板对象。获取失败时，返回 nil。例如，传入的 boardID 有误。

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

根据白板 ID 将其指定为当前白板。

传入参数

返回值

• True: 成功。调用成功后，房间内所有用户都将收到 byteWhiteBoardRoom:onActiveWhiteBoardChanged:。
• False: 失败。

注意
如无特殊说明，对白板进行编辑操作的 API 都只作用在当前白板上。

-(int)getActiveWhiteBoard;
objectivec

获取当前白板 ID。

返回值
当前白板 ID。-1 表示获取失败。

注意
获取到当前白板 ID 后，可以调用 getWhiteBoardByID: 获取相应的白板对象。

-(NSArray<ByteWhiteBoardInfo *> *) getAllWhiteBoardInfos;
objectivec

获取房间内所有白板。

返回值
白板列表。详见 ByteWhiteBoardInfo。

- (void)closeRoom;
objectivec

关闭白板房间。关闭房间后，无法在白板上进行编辑操作。

注意

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

- (void)startPlaybackWhiteBoard;
objectivec

开始播放白板录像

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

注意

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

- (void)pausePlaybackWhiteBoard;
objectivec

暂停播放白板录像

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

- (void)stopPlaybackWhiteBoard;
objectivec

停止播放白板录像

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

- (int)setPlaybackWhiteBoardProgress:(NSInteger)progress;
objectivec

设置白板回放进度

传入参数

返回值
调用结果
0: 成功

@interface ByteWhiteBoardRoomManager : NSObject
objectivec

白板房间管理接口

+ (instancetype)sharedEngineWithAppId:(NSString *)appId delegate:(id<ByteWhiteBoardRoomManagerDelegate>)delegate;
objectivec

创建白板 ByteWhiteBoardRoomManager 实例

传入参数

+ (void)destroy;
objectivec

销毁白板 ByteWhiteBoardRoomManager 单例对象

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

设置设备 ID

传入参数

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

设置本地日志缓存路径

传入参数

注意
不主动设置，默认为APP目录 Library/Caches

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

设置数据缓存路径

传入参数

注意
默认为 APP目录 Library/Caches

+ (void)setAid:(NSString*)aid;
objectivec

设置 App ID

传入参数

注意
用于标识APP

- (void)updateByteWhiteBoardRoomManagerDelegate:(id<ByteWhiteBoardRoomManagerDelegate>)delegate;
objectivec

更新 ByteWhiteBoardRoomManager 的delegate

传入参数

- (ByteWhiteBoardRoom *)createWhiteBoardRoom:(NSString *)roomID userID:(NSString*)userID token:(NSString*)token delegate:(id<ByteWhiteBoardRoomDelegate>)delegate;
objectivec

创建白板 WhiteBoardRoom

传入参数

返回值
白板房间对象。参数校验失败时返回空的实例

注意
白板房间创建成功后自动创建白板，成功后将触发 byteWhiteBoardRoom:onCreateWhiteBoard:elapsed: 回调。

- (void)destroyWhiteBoardRoom:(ByteWhiteBoardRoom *)boardRoom;
objectivec

销毁白板房间 WhiteBoardRoom

传入参数

- (ByteWhiteBoardRoom *)getWhiteBoardRoom:(NSString *)roomID;
objectivec

通过房间 ID 获取白板房间对象

传入参数

返回值
白板房间对象 (可能为nil)

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

开启/关闭时间戳回调

传入参数

注意
在参与白板互动的用户中，选择一个端作为参考对象。在这个端调用本接口，成功开启后将触发 2 秒一次的 byteWhiteBoardRoomManager:onMediaSyncTimestamp: 时间戳回调。将时间戳传给房间中的其他客户端，实现时间同步。