WhiteSdkConfiguration Class Reference

appIdentifier

@property (nonatomic, copy) NSString *appIdentifier

白板项目的唯一标识。

enableImgErrorCallback

@property (nonatomic, assign) BOOL enableImgErrorCallback

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

讨论

• YES：开启监听。

• NO：（默认）关闭。

enableIFramePlugin

@property (nonatomic, assign) BOOL enableIFramePlugin

是否启用 iframe 插件。

讨论

• YES：开启。

• NO：未启用。

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

region

@property (nonatomic, strong, nullable) WhiteRegionKey region

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

讨论

数据中心包括：

• WhiteRegionCN：中国杭州。该数据中心为其他数据中心服务区未覆盖的地区提供服务。

• WhiteRegionUS：美国硅谷。该数据中心为北美洲、南美洲地区提供服务。

• WhiteRegionIN：印度孟买。该数据中心为印度地区提供服务。

• WhiteRegionSG：新加坡。该数据中心为新加坡、东亚、东南亚地区提供服务。

• WhiteRegionEU：欧洲（法兰克福）。该数据中心为欧洲地区提供服务。

Note:

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

renderEngine

@property (nonatomic, copy) WhiteSdkRenderEngineKey renderEngine

画笔教具的渲染引擎模式。可选择以下两种模式：

• WhiteSdkRenderEngineSvg：SVG 渲染模式。2.8.0 及之前版本默认使用渲染模式，该模式兼容性较好，但性能较差。
• WhiteSdkRenderEngineCanvas：Canvas 渲染模式。2.8.0 版本起新增 canvas 渲染模式，该模式性能较好，但兼容性较差。2.9.0 及之后版本的 WhiteSdk 默认使用 canvas 渲染模式。

userCursor

@property (nonatomic, assign) BOOL userCursor

是否显示用户头像。

讨论

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

• YES：显示。

• NO：（默认）不显示。

fonts

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

自定义字体名称和地址。

preloadDynamicPPT

@property (nonatomic, assign) BOOL preloadDynamicPPT

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

讨论

Note：

声网不推荐设置 setPreloadDynamicPPT(true)，这样会使 PPT 显示缓慢。

• YES：开启。

• NO: （默认）未开启。

enableInterrupterAPI

@property (nonatomic, assign) BOOL enableInterrupterAPI

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

讨论

• YES：开启。

• NO：关闭。

log

@property (nonatomic, assign) BOOL log

是否开启调试日志回调。

讨论

• YES：开启。

• NO：（默认）关闭。

loggerOptions

@property (nonatomic, copy) NSDictionary *loggerOptions

日志等级。

讨论

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

例如，你选择 info 级别，就可以看到在 error、warn、info 级别上的所有日志信息。

)

@property (nonatomic, strong) WhitePptParams *__deprecated_msg ( "use WhiteSlideAppParams instead" )

该属性已废弃。请使用 WhiteSlideAppParams (Deprecated: 该属性已废弃。请使用 WhiteSlideAppParams)

whiteSlideAppParams

@property (nonatomic, strong) WhiteSlideAppParams *whiteSlideAppParams

PPT 渲染显示相关参数。详见 WhiteSlideAppParams。

enableSlideInterrupterAPI

@property (nonatomic, assign) BOOL enableSlideInterrupterAPI

是否开启 PPT 资源 URL 拦截替换功能。 开启之后，你需要通过 WhiteSDK.setSlideDelegate 设置多窗口 PPT 回调事件，并在 slideUrlInterrupter 回调中添加 URL 的替换处理逻辑。

讨论

• YES：开启。

• NO：（默认）关闭。

disableNewPencilStroke

@property (nonatomic, assign) BOOL disableNewPencilStroke

是否关闭新铅笔工具（AppliancePencil）的笔锋效果。

讨论

• YES：关闭笔锋效果。

• NO：（默认）开启笔锋效果。

该属性仅在 disableNewPencil 设为 NO 时生效。

apiHosts

@property (nonatomic, copy, nullable) NSArray<NSString*> *apiHosts

配置白板的 API 服务器域名列表，可以用于服务器代理。配置后，白板不再使用 SDK 自带配置。 @example [api.example.com]

initWithApp:

- (instancetype)initWithApp:(NSString *)appIdentifier

初始化 WhiteSdkConfiguration 对象。

参数

参数名	描述
appIdentifier	白板项目的唯一标识。详见获取白板项目的 App Identifier。

返回值

初始化的 WhiteSdkConfiguration 对象。