WhiteDisplayer Class Reference

Inherits from NSObject
Declared in WhiteDisplayer.h

Overview

该类为白板房间的基类。

  )

该属性已废弃。WhiteboardView 类继承自 UIView 类,你可以直接在 WhiteboardView 对象中调用 UIView 类的 backgroundcolor 属性修改白板背景色。详见 backgroundcolor

@property (nonatomic, strong) UIColor *__deprecated_msg ( "use WhiteboardView's backgroundColor property" )

Declared In

WhiteDisplayer.h

– postIframeMessage:

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

- (void)postIframeMessage:(id)payload

Parameters

payload

关键信息。

Declared In

WhiteDisplayer.h

– getSceneFromScenePath:result:

获取指定场景的信息。

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

Parameters

scenePath

场景的路径。请确保场景路径以 / 开头,并且由场景目录和场景名构成,例如,/math/classA

result

方法调用结果回调。方法调用成功时,返回场景信息。详见 WhiteScene

Declared In

WhiteDisplayer.h

– getScenePathType:result:

查询场景路径类型。

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

Parameters

pathOrDir

场景路径类型。

result

回调。返回指定场景的路径类型,详见 WhiteScenePathType

Discussion

你可以在该方法中指定想要查询的场景路径,SDK 会返回该路径对应的场景类型。

Declared In

WhiteDisplayer.h

– getEntireScenes:

获取当前房间内所有场景的信息。

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

Parameters

result

回调。返回当前房间内所有场景的信息。

Declared In

WhiteDisplayer.h

– addMagixEventListener:

注册自定义事件监听。

- (void)addMagixEventListener:(NSString *)eventName

Parameters

eventName

想要监听的自定义事件名称。

Discussion

成功注册后,你可以接收到对应的自定义事件通知。

Note:

对于同名的自定义事件,SDK 仅支持触发一个回调。

Declared In

WhiteDisplayer.h

– addHighFrequencyEventListener:fireInterval:

注册高频自定义事件监听。

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

Parameters

eventName

想要监听的自定义事件名称。

millseconds

SDK 触发回调的频率,单位为毫秒。该参数最小值为 500 ms,如果设置为低于该值会被重置为 500 ms。

Discussion

成功注册后,你可以接收到对应的自定义事件通知。

Note:

对于同名的自定义事件,SDK 仅支持触发一个回调。

Declared In

WhiteDisplayer.h

– removeMagixEventListener:

移除自定义事件监听。

- (void)removeMagixEventListener:(NSString *)eventName

Parameters

eventName

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

Declared In

WhiteDisplayer.h

– refreshViewSize

刷新白板的界面。

- (void)refreshViewSize

Discussion

WhiteboardView 出现改变时,需要手动调用该方法刷新白板的界面。

Declared In

WhiteDisplayer.h

– convertToPointInWorld:result:

转换白板上点的坐标。

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

Parameters

point

点在 iOS 坐标系中的坐标。详见 WhitePanEvent

result

回调。返回点在世界坐标系上的坐标,详见 WhitePanEvent

Discussion

该方法可以将 iOS 内部坐标系中的坐标转换为世界坐标系(以白板初始化时的中点为原点,横轴为 X 轴,正方向向右,纵轴为 Y 轴,正方向向下)坐标。

Declared In

WhiteDisplayer.h

– setCameraBound:

设置视角边界。

- (void)setCameraBound:(WhiteCameraBound *)cameraBound

Parameters

cameraBound

视角边界,详见 WhiteCameraBound

Declared In

WhiteDisplayer.h

– moveCamera:

调整视角。

- (void)moveCamera:(WhiteCameraConfig *)camera

Parameters

camera

视角的参数配置,详见 WhiteCameraConfig

Discussion

调用该方法后,SDK 会根据传入的参数调整视角。

Declared In

WhiteDisplayer.h

– moveCameraToContainer:

调整视角,以保证完整显示视觉矩形。

- (void)moveCameraToContainer:(WhiteRectangleConfig *)rectangle

Parameters

rectangle

视觉矩形的参数设置,详见 WhiteRectangleConfig

Declared In

WhiteDisplayer.h

– scalePptToFit:

调整视角以保证完整显示 PPT 的内容。

- (void)scalePptToFit:(WhiteAnimationMode)mode

Parameters

mode

视角调整时的动画模式,详见 WhiteAnimationMode

Availability

2.5.1

Note:

  • 如果当前用户已经调用 setViewMode 方法并设置为 follower,调用该方法可能造成当前用户与主播内容不完全一致。
  • 如果没有插入 PPT,调用该方法不生效。

Discussion

该操作为一次性操作。

Declared In

WhiteDisplayer.h

– scaleIframeToFit

调整视角以保证完整显示 HTML5 课件。

- (void)scaleIframeToFit

Availability

2.12.5

Note:

如果当前用户已经调用 setViewMode 方法并设置为 follower,调用该方法可能造成当前用户与主播内容不完全一致。

Discussion

该方法为一次性操作。如果没有插入 HTML5 课件,调用该方法不生效。

Declared In

WhiteDisplayer.h

– disableCameraTransform:

禁止/允许用户调整视角。

- (void)disableCameraTransform:(BOOL)disable

Parameters

disable

是否禁止用户调整视角:

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

Availability

2.11.0

Declared In

WhiteDisplayer.h

– getScenePreviewImage:completion:

获取特定场景的预览图。

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

Parameters

scenePath

场景路径。

completionHandler

返回指定场景的预览图。

Declared In

WhiteDisplayer.h

– getSceneSnapshotImage:completion:

获取特定场景的截图。

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

Parameters

scenePath

场景路径。

completionHandler

方法调用结果:

  • 如果方法调用成功,将返回指定场景的截图。
  • 如果方法调用失败,将返回错误信息。

Discussion

Note:

  • 如果场景中展示了图片或动态 PPT 幻灯片,请确保该图片或PPT幻灯片的存储服务器支持跨域资源共享; 否则,生成的截图中可能不会显示图片或 PPT 幻灯片。
  • 为确保截图正常显示,Agora 推荐使用互动白板服务端截图功能

Declared In

WhiteDisplayer.h

– getLocalSnapShotWithCompletion:

获取当前的白板截图。

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

Parameters

completionHandler

方法调用结果:

  • 如果方法调用成功,将返回指定场景的截图。
  • 如果方法调用失败,将返回错误信息。

Discussion

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

Declared In

WhiteDisplayer.h