白板操作

本文中的 API，都可以在 WhiteRoom.h 文件中查看。

本文示例代码中的 room 即为 WhiteRoom 的实例。

插入图片

@interface WhiteRoom : NSObject

/**
 1. 先使用 insertImage API，插入占位图
 */
- (void)insertImage:(WhiteImageInformation *)imageInfo;

/**
 2. 再通过 completeImageUploadWithUuid:src: 替换内容
 替换占位图中的内容

 @param uuid insertImage API 中，imageInfo 传入的图片 uuid
 @param src 图片的网络地址
 */
- (void)completeImageUploadWithUuid:(NSString *)uuid src:(NSString *)src;

/** 封装上述两个 API */
- (void)insertImage:(WhiteImageInformation *)imageInfo src:(NSString *)src;

@end

插入图片 API——需要异步获取图片地址

1. 首先创建 WhiteImageInformation 类，配置图片，宽高，以及中心点位置，设置 uuid，确保 uuid 唯一即可。
2. 调用 insertImage: 方法，传入 WhiteImageInformation 实例。白板此时就先生成一个占位框。
3. 图片通过其他方式上传或者直接获取图片地址后，调用 completeImageUploadWithUuid: src: 方法，uuid 参数为 insertImage: 方法传入的 uuid，src 为图片网络地址。

v2版本中，我们将插入图片 API 封装成了一个 API。如果开发者在插入图片时，已经知道图片信息，可以直接使用封装好的 API

WhiteImageInformation *info = [[WhiteImageInformation alloc] init];
info.width = 200;
info.height = 300;
info.uuid = @"WhiteImageInformation";
[self.room insertImage:info src:@"https://white-pan.oss-cn-shanghai.aliyuncs.com/101/image/alin-rusu-1239275-unsplash_opt.jpg"];

插入PPT 与插入图片 的区别

区别	插入PPT	插入图片
调用后结果	会自动新建多个白板页面，但是仍然保留在当前页（所以无明显区别），需要通过翻页API进行切换	产生一个占位界面，插入真是图片，需要调用 completeImageUploadWithUuid:src ,传入占位界面的 uuid，以及图片的网络地址
移动	无法移动，所以不需要位置信息	可以移动，所以插入时，需要提供图片大小以及位置信息
与白板页面关系	插入 ppt 的同时，白板就新建了一个页面，这个页面的背景就是 PPT 图片	是当前白板页面的一部分，同一个页面可以加入多张图片

图片网址替换

部分情况下，我们需要对某个图片进行签名，以保证图片只在内部使用。

替换API可以在图片实际插入白板前进行拦截，修改最后实际插入的图片地址。该方法对 ppt 图片和普通插入图片都有效。 在回放时，图片地址仍然为未替换的地址，也需要通过此 API 进行签名。

该方法为 WhiteCommonCallbackDelegate 协议中的一个申明方法，属于被动调用。

如需启用，请在初始化 SDK 时，将 WhiteSdkConfiguration 的 enableInterrupterAPI 属性，设置为 YES。 并在 WhiteSDK 初始化时，使用一下方法传入实现了该 protocol 的实例

- (instancetype)initWithWhiteBoardView:(WhiteBoardView *)boardView config:(WhiteSdkConfiguration *)config commonCallbackDelegate:(nullable id<WhiteCommonCallbackDelegate>)callback

或者在想要使用时，调用 whiteSDK 的 setCommonCallbackDelegate: 方法，设置。

只读

2.2.0 开始，该 API 拆分为：
禁止用户移动，缩放 API：disableCameraTransform (详情请参考 视角操作-禁止视角变化)；
禁止用户输入 API：disableDeviceInputs (详情请参考 教具使用-禁止教具操作 API。

/** 进入只读模式，不响应用户任何手势 */
- (void)disableOperations:(BOOL)readonly;

缩放

用户可以通过手势（iOS上使用双指swipe手势、模拟器中按住 option + 鼠标进行模拟）对白板进行缩放操作。 另一方面，开发者也可以通过 zoomChange 来进行缩放。

• 代码设置缩放

/**
 缩小放大白板
 @param scale 相对于原始大小的比例，而不是相对当前的缩放比例
 */
- (void)zoomChange:(CGFloat)scale;

• 代码获取缩放值

- (void)getZoomScaleWithResult:(void (^) (CGFloat scale))result;

移动

白板支持双指手势，双指进行平移，即可移动白板（模拟器中可以通过 shift + option + 鼠标，来模式该手势）。

目前不支持使用代码进行移动。

背景色

2.4.0 新增 API

白板新增backgroudColor属性，支持修改白板背景色，该颜色为本地修改，不会被同步给其他用户。

@interface WhiteDisplayer: NSObject
/**
 会被转换成十六进制色值，目前不支持透明度设置，只会传递透明度。该背景为用户本地修改值，不会被同步。
 */
@property (nonatomic, strong) UIColor *backgroundColor;
@end

用户信息透传

2.1.0 新增 API

从 2.1.0 开始，SDK 支持开发者在加入房间时，携带部分额外信息。
sdk，会将该信息透传给所有客户端。（注意，该属性需要满足一定约束条件，详情见下文）

WhiteRoomConfig 新增 userPayload 属性。允许开发者携带一部分相关信息。

在其他客户端，可以通过查询房间 roomMembers 来获取各个用户携带的信息。

只有当该属性内容，满足 [NSJSONSerialization isValidJSONObject:@{@"userPayload": userPayload}] 为 YES 时。sdk 才会将该数据，完整的传递所有客户端。

@interface WhiteRoomConfig : WhiteObject
- (instancetype)initWithUuid:(NSString *)uuid roomToken:(NSString *)roomToken userPayload:(id _Nullable)userPayload;
@end

用户头像显示

2.0.2新增 API。2.1.0 有所增强，可以完整传递

1. 初始化 WhiteSDK 时，将 WhiteSdkConfiguartion 的 userCursor 字段，设置为 YES。
2. 将 WhiteRoomConfig 的 userPayload 属性，设置为字典。并确保存在 avatar 字段，且值为用户头像地址。

2.0.2 ~ 2.1.0之前版本，请配置WhiteRoomConfig 的 memberInfo

用户头像地址，推荐使用 https 地址，否则请开启 iOS ATS 功能。

相关类 API：

@interface WhiteSdkConfiguartion ： WhiteObject
/** 显示操作用户头像(需要在加入房间时，配置用户信息) */
@property (nonatomic, assign) BOOL userCursor;

@end

@interface WhiteSDK : NSObject
//加入房间API
- (void)joinRoomWithConfig:(WhiteRoomConfig *)config callbacks:(nullable id<WhiteRoomCallbackDelegate>)callbacks completionHandler:(void (^) (BOOL success, WhiteRoom * _Nullable room, NSError * _Nullable error))completionHandler;
@end

@interface WhiteRoomConfig : WhiteObject
//初始化房间参数，传入用户信息
- (instancetype)initWithUuid:(NSString *)uuid roomToken:(NSString *)roomToken memberInfo:(WhiteMemberInformation * _Nullable)memberInfo;
// 2.1.0开始，建议使用该 API
- (instancetype)initWithUuid:(NSString *)uuid roomToken:(NSString *)roomToken userPayload:(id _Nullable)userPayload;

@end

主动延时

1.x 不提供该 API， 2.0.3 新增API。

@interface WhiteRoom : NSObject
## 设置白板延时秒数
- (void)setTimeDelay:(NSTimeInterval)delay;
## 获取白板当前主动延迟时间
@property (nonatomic, assign, readonly) NSTimeInterval delay;
@end

快速设置白板延时，人为给白板增加一部分延时，延迟播放，满足 HLS 情况下与音视频同步的需求。

注意点：

1. 该方法只对本地客户端有效。
2. 该方法会同时影响自定义时间，用户头像回调事件。
3. 用户本地绘制，仍然会实时出现。

清屏 API

• 2.0.1 新增 API

@interface WhiteRoom : NSObject
/**
 清除当前屏幕内容

 @param retainPPT 是否保留 ppt
 */
- (void)cleanScene:(BOOL)retainPPT;
@end

日志上传功能

2.4.1 新增API

2.4.1 开始，sdk 会收集 sdk 中的debug 日志，主要涉及 API 调用时的输出。

在使用WhiteSdkConfiguration初始化 SDK 时，设置WhiteSdkConfiguration的loggerOptions属性，传入一个有disableReportLog的字典，在其中定义打开关闭。YES 为关闭日志上传，NO 为打开日志上传（默认）。