WhiteSdkConfiguration Class Reference

Inherits from WhiteObject
Declared in WhiteSdkConfiguration.h

Overview

用于配置 WhiteSDK 对象。

– initWithApp:

初始化 WhiteSdkConfiguration 对象。

- (instancetype)initWithApp:(NSString *)appIdentifier

Parameters

appIdentifier

白板项目的唯一标识。详见获取白板项目的 App Identifier

Return Value

初始化的 WhiteSdkConfiguration 对象。

Declared In

WhiteSdkConfiguration.h

  appIdentifier

白板项目的唯一标识。

@property (nonatomic, copy) NSString *appIdentifier

Availability

2.8.0

Declared In

WhiteSdkConfiguration.h

  enableImgErrorCallback

是否监听图片加载失败事件。

@property (nonatomic, assign) BOOL enableImgErrorCallback

Availability

2.12.0

Discussion

  • YES:开启监听。
  • NO:(默认)关闭。

Declared In

WhiteSdkConfiguration.h

  enableIFramePlugin

是否启用 iframe 插件。

@property (nonatomic, assign) BOOL enableIFramePlugin

Discussion

  • YES:开启。
  • NO:未启用。

2.10.0 默认打开,后续版本默认关闭。

Declared In

WhiteSdkConfiguration.h

  region

互动白板房间所在的数据中心。

@property (nonatomic, strong, nullable) WhiteRegionKey region

Availability

2.11.0

Discussion

数据中心包括:

  • "cn-hz":中国杭州。该数据中心为其他数据中心服务区未覆盖的地区提供服务。
  • "us-sv":美国硅谷。该数据中心为北美洲、南美洲地区提供服务。
  • "in-mum":印度孟买。该数据中心为印度地区提供服务。
  • "sg":新加坡。该数据中心为新加坡、东亚、东南亚地区提供服务。
  • "gb-lon":英国伦敦。该数据中心为欧洲地区提供服务。

Note:

SDK 初始化时设置的 region 必须和创建房间时指定的 region 一致;否则,SDK 无法连接到房间。

Declared In

WhiteSdkConfiguration.h

  renderEngine

画笔教具的渲染引擎模式。详见 WhiteSdkRenderEngineKey

@property (nonatomic, copy) WhiteSdkRenderEngineKey renderEngine

Availability

2.8.0

2.8.0 版本新增 canvas 渲染引擎。从 2.9.0 版本开始,默认值为 WhiteSdkRenderEngineCanvas

Declared In

WhiteSdkConfiguration.h

  userCursor

是否显示用户头像。

@property (nonatomic, assign) BOOL userCursor

Discussion

要显示用户头像,请确保你在 initWithUuid 时 在userPayload 对象中传入了头像的键值对。

  • YES:显示。
  • NO:(默认)不显示。

Declared In

WhiteSdkConfiguration.h

  fonts

自定义字体名称和地址。

@property (nonatomic, copy, nullable) NSDictionary *fonts

Declared In

WhiteSdkConfiguration.h

  preloadDynamicPPT

是否在加载动态 PPT 首页时,一次性加载动态 PPT 中的所有图片资源。

@property (nonatomic, assign) BOOL preloadDynamicPPT

Discussion

Note:

Agora 不推荐设置 setPreloadDynamicPPT(true),这样会使 PPT 显示缓慢。

  • YES:开启。
  • NO: (默认)未开启。

Declared In

WhiteSdkConfiguration.h

  enableInterrupterAPI

是否开启图片拦截和替换功能。

@property (nonatomic, assign) BOOL enableInterrupterAPI

Discussion

  • YES:开启。
  • NO:关闭。

Declared In

WhiteSdkConfiguration.h

  log

是否开启调试日志回调。

@property (nonatomic, assign) BOOL log

Discussion

  • YES:开启。
  • NO:(默认)关闭。

Declared In

WhiteSdkConfiguration.h

  loggerOptions

日志等级。

@property (nonatomic, copy) NSDictionary *loggerOptions

Discussion

日志级别顺序依次为 errorwarninfo、和 debug。选择一个级别,你就可以看到在该级别之前所有级别的日志信息。

例如,你选择 info 级别,就可以看到在 errorwarninfo 级别上的所有日志信息。

Declared In

WhiteSdkConfiguration.h

  pptParams

动态 ppt 参数。详见 WhitePptParams

@property (nonatomic, strong) WhitePptParams *pptParams

Declared In

WhiteSdkConfiguration.h