WhiteDisplayer Class Reference

成员

postIframeMessage:

- (void)postIframeMessage:(id)payload;

向 iframe 插件发送的关键信息。 @param payload 关键信息。

getSceneFromScenePath:result:

- (void)getSceneFromScenePath:(NSString )scenePath result:(void (^) (WhiteScene _Nullable scene))result;

根据scenePath查询指定场景 @param scenePath 场景路径 @param result 返回指定场景的查询结果，详见 WhiteScene

getScenePathType:result:

- (void)getScenePathType:(NSString *)pathOrDir result:(void (^) (WhiteScenePathType pathType))result;

查询场景路径类型。你可以在该方法中指定想要查询的场景路径，SDK 会返回该路径对应的场景类型。 @param pathOrDir 场景路径类型。 @param result 回调。返回指定场景的路径类型，详见 WhiteScenePathType。

getEntireScenes:

- (void)getEntireScenes:(void (^) (NSDictionary<NSString *, NSArray<WhiteScene >> *dict))result;

获取房间内所有场景的信息，返回格式：场景目录路径: 对应场景目录下，所有的页面数组 key 为 scenePath，value 为 WhiteScene 数组。只存在 /init 的房间，返回结构为： {"/": @[init WhiteScene]} @param result 回调。返回当前房间内所有场景的信息。

obtainSyncedStore

- (SyncedStore *)obtainSyncedStore;

获取 SyncedStore 对象注意 SyncedStore 只有在 `WhiteSdkConfiguration` 的 `enableSyncedStore` 为 YES 的情况下才能正常使用

addMagixEventListener:

- (void)addMagixEventListener:(NSString *)eventName;

注册自定义事件监听。成功注册后，你可以接收到对应的自定义事件通知。 *Note:** 对于同名的自定义事件，SDK 仅支持触发一个回调。 @param eventName 想要监听的自定义事件名称。

addHighFrequencyEventListener:fireInterval:

- (void)addHighFrequencyEventListener:(NSString *)eventName fireInterval:(NSUInteger)millseconds;

注册高频自定义事件监听。成功注册后，你可以接收到对应的自定义事件通知。 *Note:** 对于同名的自定义事件，SDK 仅支持触发一个回调。 @param eventName 想要监听的自定义事件名称。 @param millseconds SDK 触发回调的频率，单位为毫秒。该参数最小值为 500 ms，如果设置为低于该值会被重置为 500 ms。

removeMagixEventListener:

- (void)removeMagixEventListener:(NSString *)eventName;

移除自定义事件监听。 @param eventName 想要移除监听的自定义事件名称。

refreshViewSize

- (void)refreshViewSize;

刷新白板的界面。当 `WhiteboardView` 出现改变时，需要调用该方法刷新白板的界面。目前该方法 SDK 会主动调用，不再需要手动调用

convertToPointInWorld:result:

- (void)convertToPointInWorld:(WhitePanEvent *)point result:(void (^) (WhitePanEvent *convertPoint))result;

转换白板上点的坐标。该方法可以将 iOS 内部坐标系中的坐标转换为世界坐标系（以白板初始化时的中点为原点，横轴为 X 轴，正方向向右，纵轴为 Y 轴，正方向向下）坐标。 @param point 点在 iOS 坐标系中的坐标。 @param result 回调。返回点在世界坐标系上的坐标，详见 WhitePanEvent。

setCameraBound:

- (void)setCameraBound:(WhiteCameraBound *)cameraBound;

设置视角边界。 @param cameraBound 视角边界，详见 WhiteCameraBound。

moveCamera:

- (void)moveCamera:(WhiteCameraConfig *)camera;

调整视角。调用该方法后，SDK 会根据传入的参数调整视角。 @param camera 视角的参数配置，详见 WhiteCameraConfig。

moveCameraToContainer:

- (void)moveCameraToContainer:(WhiteRectangleConfig *)rectangle;

调整视角，以保证完整显示视觉矩形。 @param rectangle 视觉矩形的参数设置，详见 WhiteRectangleConfig。

scalePptToFit:

- (void)scalePptToFit:(WhiteAnimationMode)mode;

调整视角以保证完整显示 PPT 的内容。该操作为一次性操作。 @since 2.5.1 *Note:**

如果当前用户已经调用 setViewMode 方法并设置为 `follower`，调用该方法可能造成当前用户与主播内容不完全一致。
该方法为一次性操作。如果没有插入 PPT，调用该方法不生效。 @param mode 视角调整时的动画模式，详见 WhiteAnimationMode。

scaleIframeToFit

- (void)scaleIframeToFit;

调整视角以保证完整显示 H5 课件。该方法为一次性操作。如果没有插入 H5 课件，调用该方法不生效。 @since 2.12.5 *Note:** 如果当前用户已经调用 setViewMode 方法并设置为 `follower`，调用该方法可能造成当前用户与主播内容不完全一致。

disableCameraTransform:

- (void)disableCameraTransform:(BOOL)disable;

禁止/允许用户调整视角。 @since 2.11.0 @param disable 是否禁止用户调整视角：

`YES`: 禁止用户调整视角。
`NO`: (默认) 允许用户调整视角。

getScenePreviewImage:completion:

- (void)getScenePreviewImage:(NSString *)scenePath completion:(void (^)(UIImage * _Nullable image))completionHandler;

获取特定场景的预览图。 *Note:**

截取用户切换时，看到的场景内容，不是场景内全部内容。
图片支持：只有当图片服务器支持跨域，才可以显示在截图中。（请真机中运行） @param scenePath 场景路径。 @param completionHandler 返回指定场景的预览图。

getSceneSnapshotImage:completion:

- (void)getSceneSnapshotImage:(NSString *)scenePath completion:(void (^)(UIImage * _Nullable image))completionHandler;

获取特定场景的截图。 *Note:** 只有当前图片服务器支持跨区域，才能显示截图。 @param scenePath 场景路径。 @param completionHandler 你可以通过该接口获取 `getSceneSnapshotImage` 方法的调用结果：

getLocalSnapShotWithCompletion:

- (void)getLocalSnapShotWithCompletion:(void(^)(UIImage * _Nullable image, NSError * _Nullable error))completionHandler;

获取当前的白板截图 *NOTE:** 该方法得到的截图尺寸为当前的白板视图大小。

getWindowManagerAttributesWithResult:

- (void)getWindowManagerAttributesWithResult:(void(^)(NSDictionary * attributes))result;

获取当前的 WindowManager @param result 获取的attributes回调

成员​