com.herewhite.sdk.WhiteSdkConfiguration class 参考

适用版本：Whiteboard Android SDK 2.16.134。

WhiteSdk 实例的配置。

@note 成功初始化 WhiteSdk 后，无法再调用 WhiteSdkConfiguration 类中的任何方法修改 WhiteSdk 的配置。

父类：WhiteObject；继承接口详见父类。

属性与 JSON 字段

Java 非公开字段通过对应 getter/setter 访问；可选包装类型未设置时通常不写入 JSON。初值包含字段声明及无参构造中的直接赋值；其他构造参数以签名为准。

字段	声明	源码初值	说明
backgroundImageLoadOptions	com.herewhite.sdk.domain.BackgroundImageLoadOptions backgroundImageLoadOptions	未显式赋值	背景图片加载重试和超时配置，见 BackgroundImageLoadOptions。
region	Region region	未显式赋值	模型属性；通过对应 getter/setter 访问。
log	boolean log	false	模型属性；通过对应 getter/setter 访问。
renderEngine	RenderEngineType renderEngine	RenderEngineType.canvas	模型属性；通过对应 getter/setter 访问。
enableInterrupterAPI	boolean enableInterrupterAPI	false	模型属性；通过对应 getter/setter 访问。
enableSlideInterrupterAPI	boolean enableSlideInterrupterAPI	false	模型属性；通过对应 getter/setter 访问。
preloadDynamicPPT	boolean preloadDynamicPPT	false	模型属性；通过对应 getter/setter 访问。
userCursor	boolean userCursor	false	模型属性；通过对应 getter/setter 访问。
onlyCallbackRemoteStateModify	boolean onlyCallbackRemoteStateModify	false	模型属性；通过对应 getter/setter 访问。
enableIFramePlugin	boolean enableIFramePlugin	false	模型属性；通过对应 getter/setter 访问。
enableRtcAudioEffectIntercept	boolean enableRtcAudioEffectIntercept	false	模型属性；通过对应 getter/setter 访问。
enableSyncedStore	boolean enableSyncedStore	false	模型属性；通过对应 getter/setter 访问。
enableAppliancePlugin	boolean enableAppliancePlugin	false	启用内嵌高性能绘制插件，默认 false；Android/Harmony 无需单独安装 npm 插件，同房间各端应一致开启。
disableNewPencilStroke	boolean disableNewPencilStroke	false	模型属性；通过对应 getter/setter 访问。
loggerOptions	LoggerOptions loggerOptions	未显式赋值	模型属性；通过对应 getter/setter 访问。
pptParams	PptParams pptParams	new PptParams(...)	pptParams 动态 ppt 专用参数
slideAppOptions	SlideAppOptions slideAppOptions	new SlideAppOptions(...)	SlideApp 的配置项
presentationAppOptions	PresentationAppOptions presentationAppOptions	未显式赋值	本地内置 Presentation 配置，初始化 SDK 前传入。
fonts	HashMap<String, String> fonts	未显式赋值	模型属性；通过对应 getter/setter 访问。
enableImgErrorCallback	boolean enableImgErrorCallback	未显式赋值	模型属性；通过对应 getter/setter 访问。
useMultiViews	Boolean useMultiViews	false	多窗口支持
apiHosts	List<String> apiHosts	未显式赋值	配置白板的 API 服务器域名列表，可以用于服务器代理。配置后，白板不再使用 sdk 自带配置。 @example [api.example.com]

公开成员签名
	WhiteSdkConfiguration (String appIdentifier, boolean log)
	WhiteSdkConfiguration (String appIdentifier)
boolean	isEnableIFramePlugin ()
void	setEnableIFramePlugin (boolean enableIFramePlugin)
Region	getRegion ()
void	setRegion (Region region)
boolean	isEnableRtcAudioEffectIntercept ()
void	setEnableRtcAudioEffectIntercept (boolean enableRtcAudioEffectIntercept)
boolean	isDisableNewPencilStroke ()
void	setDisableNewPencilStroke (boolean disableNewPencilStroke)
RenderEngineType	getRenderEngine ()
void	setRenderEngine (RenderEngineType renderEngine)
PptParams	getPptParams ()
void	setPptParams (PptParams pptParams)
HashMap<String, String>	getFonts ()
void	setFonts (HashMap<String, String> fonts)
boolean	isPreloadDynamicPPT ()
void	setPreloadDynamicPPT (boolean preloadDynamicPPT)
void	addNativeTag (String tag, String value)
LoggerOptions	getLoggerOptions ()
void	setLoggerOptions (LoggerOptions loggerOptions)
List<String>	getNetlessUA ()
void	setNetlessUA (List<String> netlessUA)
boolean	isUserCursor ()
void	setUserCursor (boolean userCursor)
boolean	isOnlyCallbackRemoteStateModify ()
void	setOnlyCallbackRemoteStateModify (boolean onlyCallbackRemoteStateModify)
boolean	isLog ()
void	setLog (boolean log)
boolean	isEnableInterrupterAPI ()
void	setEnableInterrupterAPI (boolean enableInterrupterAPI)
boolean	isEnableImgErrorCallback ()
void	setEnableImgErrorCallback (boolean enableImgErrorCallback)
com.herewhite.sdk.domain.BackgroundImageLoadOptions	getBackgroundImageLoadOptions ()
void	setBackgroundImageLoadOptions (com.herewhite.sdk.domain.BackgroundImageLoadOptions options)
boolean	isEnableSyncedStore ()
void	setEnableSyncedStore (boolean enableSyncedStore)
Boolean	getUseMultiViews ()
void	setUseMultiViews (Boolean useMultiViews)
SlideAppOptions	getSlideAppOptions ()
void	setSlideAppOptions (SlideAppOptions slideAppOptions)
PresentationAppOptions	getPresentationAppOptions ()
void	setPresentationAppOptions (PresentationAppOptions presentationAppOptions)
boolean	isEnableSlideInterrupterAPI ()
void	setEnableSlideInterrupterAPI (boolean enableSlideInterrupterAPI)
List<String>	getApiHosts ()
void	setApiHosts (List<String> apiHosts)
boolean	isEnableAppliancePlugin ()
void	setEnableAppliancePlugin (boolean enableAppliancePlugin)
setDynamicConfig	public void setDynamicConfig(Map<String, String> dynamicConfig)
getDynamicConfig	public Map<String, String> getDynamicConfig()

变量说明

backgroundImageLoadOptions

com.herewhite.sdk.domain.BackgroundImageLoadOptions backgroundImageLoadOptions

源码初值：未显式赋值
背景图片加载重试和超时配置，见 BackgroundImageLoadOptions。

region

Region region

源码初值：未显式赋值
模型属性；通过对应 getter/setter 访问。

log

boolean log

源码初值：false
模型属性；通过对应 getter/setter 访问。

renderEngine

RenderEngineType renderEngine

源码初值：RenderEngineType.canvas
模型属性；通过对应 getter/setter 访问。

enableInterrupterAPI

boolean enableInterrupterAPI

源码初值：false
模型属性；通过对应 getter/setter 访问。

enableSlideInterrupterAPI

boolean enableSlideInterrupterAPI

源码初值：false
模型属性；通过对应 getter/setter 访问。

preloadDynamicPPT

boolean preloadDynamicPPT

源码初值：false
模型属性；通过对应 getter/setter 访问。

userCursor

boolean userCursor

源码初值：false
模型属性；通过对应 getter/setter 访问。

onlyCallbackRemoteStateModify

boolean onlyCallbackRemoteStateModify

源码初值：false
模型属性；通过对应 getter/setter 访问。

enableIFramePlugin

boolean enableIFramePlugin

源码初值：false
模型属性；通过对应 getter/setter 访问。

enableRtcAudioEffectIntercept

boolean enableRtcAudioEffectIntercept

源码初值：false
模型属性；通过对应 getter/setter 访问。

enableSyncedStore

boolean enableSyncedStore

源码初值：false
模型属性；通过对应 getter/setter 访问。

enableAppliancePlugin

boolean enableAppliancePlugin

源码初值：false
启用内嵌高性能绘制插件，默认 false；Android/Harmony 无需单独安装 npm 插件，同房间各端应一致开启。

disableNewPencilStroke

boolean disableNewPencilStroke

源码初值：false
模型属性；通过对应 getter/setter 访问。

loggerOptions

LoggerOptions loggerOptions

源码初值：未显式赋值
模型属性；通过对应 getter/setter 访问。

pptParams

PptParams pptParams

源码初值：new PptParams(...)
pptParams 动态 ppt 专用参数

slideAppOptions

SlideAppOptions slideAppOptions

源码初值：new SlideAppOptions(...)
SlideApp 的配置项

presentationAppOptions

PresentationAppOptions presentationAppOptions

源码初值：未显式赋值
本地内置 Presentation 配置，初始化 SDK 前传入。

fonts

HashMap<String, String> fonts

源码初值：未显式赋值
模型属性；通过对应 getter/setter 访问。

enableImgErrorCallback

boolean enableImgErrorCallback

源码初值：未显式赋值
模型属性；通过对应 getter/setter 访问。

useMultiViews

Boolean useMultiViews

源码初值：false
多窗口支持

apiHosts

List<String> apiHosts

源码初值：未显式赋值
配置白板的 API 服务器域名列表，可以用于服务器代理。配置后，白板不再使用 sdk 自带配置。
@example [api.example.com]

函数说明

WhiteSdkConfiguration()

WhiteSdkConfiguration(String appIdentifier, boolean log)

初始化互动白板 SDK 配置。

参数

参数名	描述
appIdentifier	白板项目的唯一标识。详见获取白板项目的 App Identifier。
log	是否开启调试日志回调： true：开启。 false：（默认）关闭。 调试日志仅包含调用初始化互动白板 SDK、加入房间和开始回放等方法的回调。

WhiteSdkConfiguration()

WhiteSdkConfiguration(String appIdentifier)

初始化互动白板 SDK 配置。

参数

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

isEnableIFramePlugin()

boolean isEnableIFramePlugin()

获取是否启用 iframe 插件。

返回值

是否启用 iframe 插件：

• true：开启。
• false：未启用。

setEnableIFramePlugin()

void setEnableIFramePlugin(boolean enableIFramePlugin)

启用/禁用 iframe 插件。

iframe 插件的功能，详见 iframe-bridge。

参数

参数名	描述
enableIFramePlugin	是否启用 iframe 插件： true：开启。 false：（默认）不启用。

getRegion()

Region getRegion()

获取设置的数据中心。

返回值

数据中心，详见 Region。

setRegion()

void setRegion(Region region)

设置数据中心。

注解

该方法设置的数据中心必须与要加入的互动白板实时房间所在数据中心一致；否则，SDK 将无法连接到房间 。

参数

参数名	描述
region	数据中心，详见 Region。

isEnableRtcAudioEffectIntercept()

boolean isEnableRtcAudioEffectIntercept()

isEnableRtcAudioEffectIntercept：com.herewhite.sdk.WhiteSdkConfiguration 的公开成员。参数和返回类型见下方签名。

setEnableRtcAudioEffectIntercept()

void setEnableRtcAudioEffectIntercept(boolean enableRtcAudioEffectIntercept)

设置是否启用 RTC SDK 的音效方法播放动态 PPT 中的音频。

参数

自从

2.16.75 当同时使用 Agora RTC SDK 和互动白板 SDK, 且互动白板中展示的动态 PPT 中包含音频文件时，你可以调用 RTC SDK 的音效方法播放动态 PPT 中的音频，以保证音频正常播放。

注解

初始化 WhiteSdk 时，如果你实现并传入 AudioEffectBridge 类，SDK 会自动设置 setEnableRtcAudioEffectIntercept(true)。你无需主动调用该方法。

参数

参数名	描述
enableRtcAudioEffectIntercept

isDisableNewPencilStroke()

boolean isDisableNewPencilStroke()

获取新铅笔工具的笔锋效果是否关闭。

• true：关闭笔锋效果。
• false：开启笔锋效果。

返回值

新铅笔工具的笔锋效果是否关闭：

setDisableNewPencilStroke()

void setDisableNewPencilStroke(boolean disableNewPencilStroke)

开启/关闭新铅笔工具的笔锋效果。

注解

该方法仅在调用 setDisableNewPencil(false) 后生效。

• true：关闭笔锋效果。
• false：（默认）开启笔锋效果。

参数

参数名	描述
disableNewPencilStroke	是否关闭新铅笔工具的笔锋效果：

getRenderEngine()

RenderEngineType getRenderEngine()

获取绘图的渲染模式。

返回值

绘图的渲染模式，详见 RenderEngineType。

setRenderEngine()

void setRenderEngine(RenderEngineType renderEngine)

设置绘图的渲染模式。

自从

2.8.0

为优化白板上绘图的渲染，自 2.8.0 版本起，白板 SDK 新增 canvas 渲染模式，并从 2.9.0 版本起，将 canvas 渲染模式作为默认的渲染模式。

注解

由于部分 Android 6.1 至 Android 8.1 设备无法支持 canvas 渲染模式，SDK 会自动将默认的渲染模式切换为 svg 渲染模式。

参数

参数名	描述
renderEngine	绘图的渲染模式，详见 RenderEngineType。

getPptParams()

PptParams getPptParams()

获取设置的动态 PPT 参数。

返回值

设置的动态 PPT 参数，详见 PptParams。

setPptParams()

void setPptParams(PptParams pptParams)

设置动态 PPT 参数。

参数

参数名	描述
pptParams	动态 PPT 参数，详见 PptParams。

getFonts()

HashMap<String, String> getFonts()

获取自定义字体。

返回值

自定义字体名称和地址。

setFonts()

void setFonts(HashMap<String, String> fonts)

设置自定义字体。

自从

2.2.0

为正常显示动态 PPT 中的非常规字体，在初始化 WhiteSdk 实例时，你可以调用该方法传入该字体文件的 URL 地址。

注解

调用该方法前，你需要将字体文件上传至你的 app 服务器或第三方云存储，并生成一个 URL 地址。

参数

参数名	描述
fonts	自定义字体，为 key-value 键值对，key 为字体名称，value 为字体的 URL 地址，例如 "Calibri", "https://your-cdn.com/Calibri.ttf"。

isPreloadDynamicPPT()

boolean isPreloadDynamicPPT()

获取是否开启一次性加载动态 PPT 中的所有图片资源。

返回值

一次性加载动态 PPT 中的所有图片资源开启状态：

• true：开启。
• false: 未开启。

setPreloadDynamicPPT()

void setPreloadDynamicPPT(boolean preloadDynamicPPT)

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

注解

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

参数

参数名	描述
preloadDynamicPPT	是否在加载动态 PPT 首页时，一次性加载动态 PPT 中的所有图片资源： true：一次性加载所有动态 PPT。 false: （默认）不一次性加载所有动态 PPT。

addNativeTag()

void addNativeTag(String tag, String value)

addNativeTag：com.herewhite.sdk.WhiteSdkConfiguration 的公开成员。参数和返回类型见下方签名。

getLoggerOptions()

LoggerOptions getLoggerOptions()

获取设置的日志选项。

返回值

设置的日志选项，详见 LoggerOptions。

setLoggerOptions()

void setLoggerOptions(LoggerOptions loggerOptions)

设置日志选项。

自从

2.4.2

参数

参数名	描述
loggerOptions	日志选择，详见 LoggerOptions。

getNetlessUA()

List<String> getNetlessUA()

getNetlessUA：com.herewhite.sdk.WhiteSdkConfiguration 的公开成员。参数和返回类型见下方签名。

setNetlessUA()

void setNetlessUA(List<String> netlessUA)

setNetlessUA：com.herewhite.sdk.WhiteSdkConfiguration 的公开成员。参数和返回类型见下方签名。

isUserCursor()

boolean isUserCursor()

获取是否显示用户头像。

返回值

是否显示用户头像：

• true：显示。
• false：不显示。

setUserCursor()

void setUserCursor(boolean userCursor)

设置是否显示用户头像。

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

参数

参数名	描述
userCursor	是否显示用户头像： true：显示。 false：（默认）不显示。

isOnlyCallbackRemoteStateModify()

boolean isOnlyCallbackRemoteStateModify()

获取是否开启仅接收远端用户状态改变的回调。

返回值

是否开启仅接收远端用户状态改变回调：

• true：开启。开启该功能后，本地用户仅会接收到远端用户状态改变的回调，自身状态的改变不会触发回调。
• false：关闭。关闭该功能后，本地用户会接收到远端用户状态改变的回调，也会接收到自身状态改变的回调。

setOnlyCallbackRemoteStateModify()

void setOnlyCallbackRemoteStateModify(boolean onlyCallbackRemoteStateModify)

开启/关闭仅接收远端用户状态改变的回调。

开启该功能后，本地用户仅会接收到远端用户状态改变的回调，自身状态的改变不会触发回调；关闭该功能后，本地用户会接收到远端用户状态改变的回调，也会接收到自身状态改变的回调。

参数

参数名	描述
onlyCallbackRemoteStateModify	是否开启仅接收远端用户状态改变回调： true：开启。 false：（默认）关闭。

isLog()

boolean isLog()

获取是否开启调试日志打印。

返回值

是否开启调试日志打印：

• true：开启。
• false：关闭。

setLog()

void setLog(boolean log)

开启/关闭调试日志打印。

调试日志仅包含调用初始化互动白板 SDK、加入房间和开始回放等方法的回调。

参数

参数名	描述
log	是否开启调试日志打印： true：开启。 false：（默认）关闭。

isEnableInterrupterAPI()

boolean isEnableInterrupterAPI()

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

返回值

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

• true：开启。
• false：关闭。

setEnableInterrupterAPI()

void setEnableInterrupterAPI(boolean enableInterrupterAPI)

开启/关闭图片拦截替换功能。

该方法可以开启或关闭图片拦截功能。 如果开启，在图片实际插入白板前，SDK 会拦截图片并触发 urlInterrupter 回调，你可以在该回调中替换图片的地址。

注解

Agora 建议不要开启图片拦截功能，否则会频繁触发回调。

参数

参数名	描述
enableInterrupterAPI	是否开启图片拦截和替换功能： true：开启。 false：（默认）关闭。

isEnableImgErrorCallback()

boolean isEnableImgErrorCallback()

获取是否开启对图片加载失败事件的监听。

返回值

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

• true：开启监听。
• false：关闭监听。

setEnableImgErrorCallback()

void setEnableImgErrorCallback(boolean enableImgErrorCallback)

开启/关闭对图片加载失败事件的监听。

参数

参数名	描述
enableImgErrorCallback	是否开启对图片加载失败事件的监听： true：开启。开启后，所有 img 标签加载事件都会在 onMessage 中回调。 false：（默认）关闭。

getBackgroundImageLoadOptions()

com.herewhite.sdk.domain.BackgroundImageLoadOptions getBackgroundImageLoadOptions()

背景图片加载重试和超时配置，见 BackgroundImageLoadOptions。

setBackgroundImageLoadOptions()

void setBackgroundImageLoadOptions(com.herewhite.sdk.domain.BackgroundImageLoadOptions options)

背景图片加载重试和超时配置，见 BackgroundImageLoadOptions。

isEnableSyncedStore()

boolean isEnableSyncedStore()

isEnableSyncedStore：com.herewhite.sdk.WhiteSdkConfiguration 的公开成员。参数和返回类型见下方签名。

setEnableSyncedStore()

void setEnableSyncedStore(boolean enableSyncedStore)

setEnableSyncedStore：com.herewhite.sdk.WhiteSdkConfiguration 的公开成员。参数和返回类型见下方签名。

getUseMultiViews()

Boolean getUseMultiViews()

getUseMultiViews：com.herewhite.sdk.WhiteSdkConfiguration 的公开成员。参数和返回类型见下方签名。

setUseMultiViews()

void setUseMultiViews(Boolean useMultiViews)

setUseMultiViews：com.herewhite.sdk.WhiteSdkConfiguration 的公开成员。参数和返回类型见下方签名。

getSlideAppOptions()

SlideAppOptions getSlideAppOptions()

getSlideAppOptions：com.herewhite.sdk.WhiteSdkConfiguration 的公开成员。参数和返回类型见下方签名。

setSlideAppOptions()

void setSlideAppOptions(SlideAppOptions slideAppOptions)

setSlideAppOptions：com.herewhite.sdk.WhiteSdkConfiguration 的公开成员。参数和返回类型见下方签名。

getPresentationAppOptions()

PresentationAppOptions getPresentationAppOptions()

本地内置 Presentation 配置，初始化 SDK 前传入。

setPresentationAppOptions()

void setPresentationAppOptions(PresentationAppOptions presentationAppOptions)

本地内置 Presentation 配置，初始化 SDK 前传入。

isEnableSlideInterrupterAPI()

boolean isEnableSlideInterrupterAPI()

isEnableSlideInterrupterAPI：com.herewhite.sdk.WhiteSdkConfiguration 的公开成员。参数和返回类型见下方签名。

setEnableSlideInterrupterAPI()

void setEnableSlideInterrupterAPI(boolean enableSlideInterrupterAPI)

开启/关闭 PPT 拦截替换功能。

该方法可以开启或关闭 PPT 资源的拦截功能。 如果开启，在加载 URL 资源时会拦截资源并触发 com.herewhite.sdk.window.SlideListener#slideUrlInterrupter(String, ResultCaller) 回调，你可以在该回调中替换资源的地址。

参数

参数名	描述
enableSlideInterrupterAPI	是否开启 PPT 资源拦截和替换功能： true：开启。 false：（默认）关闭。

getApiHosts()

List<String> getApiHosts()

获取白板的 API 服务器域名列表。

setApiHosts()

void setApiHosts(List<String> apiHosts)

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

参数

参数名	描述
apiHosts	白板的 API 服务器域名列表。例如 [api.example.com]。

isEnableAppliancePlugin()

boolean isEnableAppliancePlugin()

获取是否启用高性能白板绘制工具插件 (appliance-plugin)。

返回值

是否启用 appliance-plugin：

• true：开启。
• false：（默认）关闭。

setEnableAppliancePlugin()

void setEnableAppliancePlugin(boolean enableAppliancePlugin)

启用/禁用高性能白板绘制工具插件 (appliance-plugin)。

参数

参数名	描述
enableAppliancePlugin	是否启用 appliance-plugin： true：开启。 false：（默认）关闭。

公开成员函数

setDynamicConfig

public void setDynamicConfig(Map<String, String> dynamicConfig)

设置 region 到平台配置 HTTPS URL 的映射。创建 SDK 前设置；每次入房前按实际 region 加载，默认超时 5 秒，读取失败使用本地参数。本地显式参数优先。

公开成员函数

getDynamicConfig

public Map<String, String> getDynamicConfig()

返回本地配置地址映射，不是远端配置 JSON 或解析后的生效参数。