WhiteDisplayer Class Reference
)
@property (nonatomic, strong) UIColor *__deprecated_msg ( "use WhiteboardView's backgroundColor property" )该属性已废弃。WhiteboardView 类继承自 UIView 类，你可以直接在 WhiteboardView 对象中调用 UIView 类的 backgroundcolor 属性修改白板背景色。详见 backgroundcolor。
postIframeMessage:
getSceneFromScenePath:result:
- (void)getSceneFromScenePath:(NSString *)scenePath result:(void ( ^ ) ( WhiteScene *_Nullable scene ))result获取指定场景的信息。
参数
| 参数名 | 描述 |
|---|---|
scenePath | 场景的路径。请确保场景路径以 / 开头，并且由场景目录和场景名构成，例如，/math/classA。 |
result | 方法调用结果回调。方法调用成功时，返回场景信息。详见 WhiteScene。 |
getScenePathType:result:
- (void)getScenePathType:(NSString *)pathOrDir result:(void ( ^ ) ( WhiteScenePathType pathType ))result查询场景路径类型。
参数
| 参数名 | 描述 |
|---|---|
pathOrDir | 场景路径类型。 |
result | 回调。返回指定场景的路径类型，详见 WhiteScenePathType。 |
讨论
你可以在该方法中指定想要查询的场景路径，SDK 会返回该路径对应的场景类型。
getEntireScenes:
- (void)getEntireScenes:(void ( ^ ) ( NSDictionary<NSString*,NSArray<WhiteScene*> *> *dict ))result获取当前房间内所有场景的信息。
参数
| 参数名 | 描述 |
|---|---|
result | 回调。返回当前房间内所有场景的信息。 |
addMagixEventListener:
addHighFrequencyEventListener:fireInterval:
removeMagixEventListener:
refreshViewSize
convertToPointInWorld:result:
- (void)convertToPointInWorld:(WhitePanEvent *)point result:(void ( ^ ) ( WhitePanEvent *convertPoint ))result转换白板上点的坐标。
参数
| 参数名 | 描述 |
|---|---|
point | 点在 iOS 坐标系中的坐标。详见 WhitePanEvent。 |
result | 回调。返回点在世界坐标系上的坐标，详见 WhitePanEvent。 |
讨论
该方法可以将 iOS 内部坐标系中的坐标转换为世界坐标系（以白板初始化时的中点为原点，横轴为 X 轴，正方向向右，纵轴为 Y 轴，正方向向下）坐标。
setCameraBound:
- (void)setCameraBound:(WhiteCameraBound *)cameraBound设置视角边界。
参数
| 参数名 | 描述 |
|---|---|
cameraBound | 视角边界，详见 WhiteCameraBound。 |
moveCamera:
- (void)moveCamera:(WhiteCameraConfig *)camera调整视角。
参数
| 参数名 | 描述 |
|---|---|
camera | 视角的参数配置，详见 WhiteCameraConfig。 |
讨论
调用该方法后，SDK 会根据传入的参数调整视角。
moveCameraToContainer:
- (void)moveCameraToContainer:(WhiteRectangleConfig *)rectangle调整视角，以保证完整显示视觉矩形。
参数
| 参数名 | 描述 |
|---|---|
rectangle | 视觉矩形的参数设置，详见 WhiteRectangleConfig。 |
scalePptToFit:
- (void)scalePptToFit:(WhiteAnimationMode)mode调整视角以保证完整显示 PPT 的内容。
参数
| 参数名 | 描述 |
|---|---|
mode | 视角调整时的动画模式，详见 WhiteAnimationMode。 |
可用性
2.5.1
Note:
-
如果当前用户已经调用 setViewMode 方法并设置为 follower，调用该方法可能造成当前用户与主播内容不完全一致。
-
如果没有插入 PPT，调用该方法不生效。
讨论
该操作为一次性操作。
scaleIframeToFit
- (void)scaleIframeToFit调整视角以保证完整显示 HTML5 课件。
可用性
2.12.5
Note:
如果当前用户已经调用 setViewMode 方法并设置为 follower，调用该方法可能造成当前用户与主播内容不完全一致。
讨论
该方法为一次性操作。如果没有插入 HTML5 课件，调用该方法不生效。
disableCameraTransform:
getScenePreviewImage:completion:
- (void)getScenePreviewImage:(NSString *)scenePath completion:(void ( ^ ) ( UIImage *_Nullable image ))completionHandler获取特定场景的预览图。
参数
| 参数名 | 描述 |
|---|---|
scenePath | 场景路径。 |
completionHandler | 返回指定场景的预览图。 |
getSceneSnapshotImage:completion:
- (void)getSceneSnapshotImage:(NSString *)scenePath completion:(void ( ^ ) ( UIImage *_Nullable image ))completionHandler获取特定场景的截图。
参数
| 参数名 | 描述 |
|---|---|
scenePath | 场景路径。 |
completionHandler | 方法调用结果：
|
讨论
Note:-
如果场景中展示了图片或动态 PPT 幻灯片，请确保该图片或PPT幻灯片的存储服务器支持跨域资源共享； 否则，生成的截图中可能不会显示图片或 PPT 幻灯片。
-
为确保截图正常显示，声网推荐使用互动白板服务端截图功能。