WhiteSDK Class Reference
Other Methods
audioMixer
@property (nonatomic, strong, readonly, nullable) WhiteAudioMixerBridge *audioMixer混音设置。
Other Methods
version
+ (NSString *)version白板 SDK 版本号。
initWithWhiteBoardView:config:commonCallbackDelegate:audioMixerBridgeDelegate:
- (instancetype)initWithWhiteBoardView:(WhiteBoardView *)boardView config:(WhiteSdkConfiguration *)config commonCallbackDelegate:(nullable id<WhiteCommonCallbackDelegate>)callback audioMixerBridgeDelegate:(nullable id<WhiteAudioMixerBridgeDelegate>)mixer设置 RTC 混音并初始化 WhiteSDK 对象。 请确保在调用其他 API 前先调用该方法创建并初始化白板 SDK 对象。
参数
| 参数名 | 描述 |
|---|---|
boardView | 白板界面，详见 WhiteBoardView。 |
config | 白板 SDK 对象配置，详见 WhiteSdkConfiguration。 |
callback | 通用回调事件，详见 WhiteCommonCallbackDelegate。 |
mixer | RTC 混音设置，详见 WhiteAudioMixerBridge。当你同时使用声网 RTC SDK 和互动白板 SDK, 且互动白板中展示的动态 PPT 中包含音频文件时，你可以调用 WhiteAudioMixerBridge 接口，将动态 PPT 中的所有音频交给声网 RTC SDK 进行混音播放。 |
返回值
初始化的 WhiteSDK 对象。
initWithWhiteBoardView:config:commonCallbackDelegate:
- (instancetype)initWithWhiteBoardView:(WhiteBoardView *)boardView config:(WhiteSdkConfiguration *)config commonCallbackDelegate:(nullable id<WhiteCommonCallbackDelegate>)callback初始化 WhiteSDK 对象。 请确保在调用其他 API 前先调用该方法创建并初始化白板 SDK 对象。
参数
| 参数名 | 描述 |
|---|---|
boardView | 白板界面，详见 WhiteBoardView。 |
config | 白板 SDK 对象配置，详见 WhiteSdkConfiguration。 |
callback | 通用回调事件，详见 WhiteCommonCallbackDelegate。 |
initWithWhiteBoardView:config:
- (instancetype)initWithWhiteBoardView:(WhiteBoardView *)boardView config:(WhiteSdkConfiguration *)config该方法已废弃。请使用 initWithWhiteBoardView:config:commonCallbackDelegate: 或 initWithWhiteBoardView:config:commonCallbackDelegate:audioMixerBridgeDelegate: 方法。 (Deprecated: 该方法已废弃。请使用 initWithWhiteBoardView:config:commonCallbackDelegate: 或 initWithWhiteBoardView:config:commonCallbackDelegate:audioMixerBridgeDelegate: 方法。
初始化 WhiteSDK 对象。)
参数
| 参数名 | 描述 |
|---|---|
boardView | 白板界面，详见 WhiteBoardView。 |
config | 白板 SDK 对象配置，详见 WhiteSdkConfiguration。 |
prepareWhiteConnectionForAppId:region:expireSeconds:attachingSuperView:
+ (void)prepareWhiteConnectionForAppId:(NSString *)appId region:(WhiteRegionKey)region expireSeconds:(NSNumber *_Nullable)expireSeconds attachingSuperView:(UIView *_Nullable)superView提前选择最佳接入域名，用于加快用户首次连接速度。
参数
| 参数名 | 描述 |
|---|---|
appId | 白板项目的唯一标识，详见获取白板项目的 App Identifier。 |
region | 需要选择的数据中心。可选值包括： |
expireSeconds | 数据缓存时间 (s)，可为空，默认为 24 小时。 |
superView | 挂载的父视图，可为空，默认为 UIApplication.shared.keyWindow。 |
讨论
声网建议在加入白板房间前调用该方法，例如设备检测页、白板房间列表页等，有助于提升加入白板房间的连接速度。
setupFontFaces:
- (void)setupFontFaces:(NSArray<WhiteFontFace*> *)fontFaces声明在本地白板中可用的字体。
参数
| 参数名 | 描述 |
|---|---|
fontFaces | 字体配置文件，详见 WhiteFontFace。 |
可用性
2.11.3
调用该方法声明的字体可用于显示 PPT 中的文字和工具输入的文字。
该方法和 loadFontFaces 都可以声明在本地白板中可用的字体，区别是 setupFontFaces 没有回调，因为无法判断字体声明是否正确；loadFontFaces 会触发回调，报告每一种的预加载结果。
Note:
-
该方法只对本地白板生效，不影响远端白板的字体显示。
-
通过该方法声明的字体，只有当被使用时，才会触发下载。
-
不同的字体在不同设备上的渲染可能不同，例如，在某些设备上，要等字体加载完成后，才会渲染文字；而在另外一些设备上，会先使用默认的字体渲染文字，等指定的字体加载完毕后，再整体刷新。
-
每次调用该方法都会覆盖原来的字体声明。
-
请勿同时调用该方法和 loadFontFaces 方法。否则，无法预期行为。
loadFontFaces:completionHandler:
- (void)loadFontFaces:(NSArray<WhiteFontFace*> *)fontFaces completionHandler:(void ( ^ ) ( BOOL success , WhiteFontFace *fontFace , NSError *_Nullable error ))completionHandler声明在本地白板中可用的字体并预加载。
参数
| 参数名 | 描述 |
|---|---|
fontFaces | WhiteFontFace 对象 ，详见 WhiteFontFace。 |
completionHandler | 方法调用结果：
|
可用性
2.11.3
调用该方法预加载的字体可以用于显示 PPT 中的文字和工具输入的文字。
该方法和 setupFontFaces 都可以声明在本地白板中可用的字体，区别是 loadFontFaces 会触发回调，报告每一种的预加载结果。
Note:
-
该方法只对本地白板生效，不影响远端白板的字体显示。
-
使用该方法预加载的字体，只有当该字体被使用时，才会触发下载。
-
不同的字体在不同设备上的渲染可能不同，例如，在某些设备上，要等字体加载完成后，才会渲染文字；而在另外一些设备上，会先使用默认的字体渲染文字，等指定的字体加载完毕后，再整体刷新。
-
通过该方法预加载的字体无法删除，每次调用都会在原来的基础上新增。
-
请勿同时调用该方法和 setupFontFaces 方法。否则，无法预期行为。
updateTextFont:
getSlideVolumeWithCompletionHandler:
- (void)getSlideVolumeWithCompletionHandler:(void ( ^ ) ( CGFloat volume , NSError *error ))completionHandler获取当前 PPT 的音量。
参数
| 参数名 | 描述 |
|---|---|
completionHandler | 方法调用结果： |
updateSlideVolume:
setCommonCallbackDelegate:
- (void)setCommonCallbackDelegate:(nullable id<WhiteCommonCallbackDelegate>)callbackDelegate设置通用回调事件。
参数
| 参数名 | 描述 |
|---|---|
callbackDelegate | 通用回调事件，详见 WhiteCommonCallbackDelegate。 |
讨论
SDK 通过 WhiteCommonCallbackDelegate 类向 app 报告 SDK 运行时的各项事件。
setSlideDelegate:
- (void)setSlideDelegate:(nullable id<WhiteSlideDelegate>)slideDelegate设置多窗口 PPT 回调事件。
参数
| 参数名 | 描述 |
|---|---|
slideDelegate | PPT 回调事件，详见 WhiteSlideDelegate。 |
讨论
SDK 通过 WhiteSlideDelegate 类处理 PPT 相关回调。
requestSlideLogToFilePath:result:
- (void)requestSlideLogToFilePath:(NSString *)path result:(void ( ^ ) ( BOOL success , NSError *error ))result将 Slide 日志写入到指定的文件路径。
参数
| 参数名 | 描述 |
|---|---|
path | 将要写入文件的 path。如果文件不存在，会直接创建文件。如果文件已存在，则会在文件末尾继续写入日志。 |
result | 日志写入结果。 |
Room Methods
joinRoomWithConfig:callbacks:completionHandler:
- (void)joinRoomWithConfig:(WhiteRoomConfig *)config callbacks:(nullable id<WhiteRoomCallbackDelegate>)callbacks completionHandler:(void ( ^ ) ( BOOL success , WhiteRoom *_Nullable room , NSError *_Nullable error ))completionHandler设置房间参数和事件回调并加入互动白板实时房间。
参数
| 参数名 | 描述 |
|---|---|
config | 互动白板实时房间的参数配置，详见 WhiteRoomConfig。 |
callbacks | 房间事件回调，详见 WhiteRoomCallbackDelegate。 |
completionHandler | 方法调用结果：
|
Replayer Methods
createReplayerWithConfig:callbacks:completionHandler:
- (void)createReplayerWithConfig:(WhitePlayerConfig *)config callbacks:(nullable id<WhitePlayerEventDelegate>)eventCallbacks completionHandler:(void ( ^ ) ( BOOL success , WhitePlayer *_Nullable player , NSError *_Nullable error ))completionHandler创建互动白板回放房间。
参数
| 参数名 | 描述 |
|---|---|
config | 白板回放的参数配置，详见 WhitePlayerConfig。 |
eventCallbacks | 白板回放事件的回调。详见 WhitePlayerEventDelegate。 |
completionHandler | 方法调用结果：
|
isPlayable:result:
- (void)isPlayable:(WhitePlayerConfig *)config result:(void ( ^ ) ( BOOL isPlayable ))result查看房间是否能够回放。
参数
| 参数名 | 描述 |
|---|---|
config | 白板回放的参数配置，详见 WhitePlayerConfig。 |
result | 回调。返回房间是否能够回放。
|
可用性
2.11.0
讨论
当播放器状态改变时，Player 会触发该回调，向你报告新的播放状态。