com.herewhite.sdk.WhiteSdkConfiguration class 参考

详细描述Copy Anchor Link

适用版本：Whiteboard Android SDK 2.16.134。

WhiteSdk 实例的配置。

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

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

属性与 JSON 字段Copy Anchor Link

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

变量说明Copy Anchor Link

backgroundImageLoadOptionsCopy Anchor Link

com.herewhite.sdk.domain.BackgroundImageLoadOptions backgroundImageLoadOptions

源码初值：未显式赋值

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

regionCopy Anchor Link

Region region

源码初值：未显式赋值

模型属性；通过对应 getter/setter 访问。

logCopy Anchor Link

boolean log

源码初值：false

模型属性；通过对应 getter/setter 访问。

renderEngineCopy Anchor Link

RenderEngineType renderEngine

源码初值：RenderEngineType.canvas

模型属性；通过对应 getter/setter 访问。

enableInterrupterAPICopy Anchor Link

boolean enableInterrupterAPI

源码初值：false

模型属性；通过对应 getter/setter 访问。

enableSlideInterrupterAPICopy Anchor Link

boolean enableSlideInterrupterAPI

源码初值：false

模型属性；通过对应 getter/setter 访问。

preloadDynamicPPTCopy Anchor Link

boolean preloadDynamicPPT

源码初值：false

模型属性；通过对应 getter/setter 访问。

userCursorCopy Anchor Link

boolean userCursor

源码初值：false

模型属性；通过对应 getter/setter 访问。

onlyCallbackRemoteStateModifyCopy Anchor Link

boolean onlyCallbackRemoteStateModify

源码初值：false

模型属性；通过对应 getter/setter 访问。

enableIFramePluginCopy Anchor Link

boolean enableIFramePlugin

源码初值：false

模型属性；通过对应 getter/setter 访问。

enableRtcAudioEffectInterceptCopy Anchor Link

boolean enableRtcAudioEffectIntercept

源码初值：false

模型属性；通过对应 getter/setter 访问。

enableSyncedStoreCopy Anchor Link

boolean enableSyncedStore

源码初值：false

模型属性；通过对应 getter/setter 访问。

enableAppliancePluginCopy Anchor Link

boolean enableAppliancePlugin

源码初值：false

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

disableNewPencilStrokeCopy Anchor Link

boolean disableNewPencilStroke

源码初值：false

模型属性；通过对应 getter/setter 访问。

loggerOptionsCopy Anchor Link

LoggerOptions loggerOptions

源码初值：未显式赋值

模型属性；通过对应 getter/setter 访问。

pptParamsCopy Anchor Link

PptParams pptParams

源码初值：new PptParams(...)

pptParams 动态 ppt 专用参数

slideAppOptionsCopy Anchor Link

SlideAppOptions slideAppOptions

源码初值：new SlideAppOptions(...)

SlideApp 的配置项

presentationAppOptionsCopy Anchor Link

PresentationAppOptions presentationAppOptions

源码初值：未显式赋值

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

fontsCopy Anchor Link

HashMap<String, String> fonts

源码初值：未显式赋值

模型属性；通过对应 getter/setter 访问。

enableImgErrorCallbackCopy Anchor Link

boolean enableImgErrorCallback

源码初值：未显式赋值

模型属性；通过对应 getter/setter 访问。

useMultiViewsCopy Anchor Link

Boolean useMultiViews

源码初值：false

多窗口支持

apiHostsCopy Anchor Link

List<String> apiHosts

源码初值：未显式赋值

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

@example [api.example.com]

函数说明Copy Anchor Link

WhiteSdkConfiguration()Copy Anchor Link

WhiteSdkConfiguration(String appIdentifier, boolean log)

初始化互动白板 SDK 配置。

WhiteSdkConfiguration()Copy Anchor Link

WhiteSdkConfiguration(String appIdentifier)

初始化互动白板 SDK 配置。

isEnableIFramePlugin()Copy Anchor Link

boolean isEnableIFramePlugin()

获取是否启用 iframe 插件。

返回值

是否启用 iframe 插件：

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

setEnableIFramePlugin()Copy Anchor Link

void setEnableIFramePlugin(boolean enableIFramePlugin)

启用/禁用 iframe 插件。

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

getRegion()Copy Anchor Link

Region getRegion()

获取设置的数据中心。

返回值

数据中心，详见 Region。

setRegion()Copy Anchor Link

void setRegion(Region region)

设置数据中心。

isEnableRtcAudioEffectIntercept()Copy Anchor Link

boolean isEnableRtcAudioEffectIntercept()

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

setEnableRtcAudioEffectIntercept()Copy Anchor Link

void setEnableRtcAudioEffectIntercept(boolean enableRtcAudioEffectIntercept)

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

参数Copy Anchor Link

isDisableNewPencilStroke()Copy Anchor Link

boolean isDisableNewPencilStroke()

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

返回值

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

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

setDisableNewPencilStroke()Copy Anchor Link

void setDisableNewPencilStroke(boolean disableNewPencilStroke)

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

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

getRenderEngine()Copy Anchor Link

RenderEngineType getRenderEngine()

获取绘图的渲染模式。

返回值

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

setRenderEngine()Copy Anchor Link

void setRenderEngine(RenderEngineType renderEngine)

设置绘图的渲染模式。

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

getPptParams()Copy Anchor Link

PptParams getPptParams()

获取设置的动态 PPT 参数。

返回值

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

setPptParams()Copy Anchor Link

void setPptParams(PptParams pptParams)

设置动态 PPT 参数。

getFonts()Copy Anchor Link

HashMap<String, String> getFonts()

获取自定义字体。

返回值

自定义字体名称和地址。

setFonts()Copy Anchor Link

void setFonts(HashMap<String, String> fonts)

设置自定义字体。

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

isPreloadDynamicPPT()Copy Anchor Link

boolean isPreloadDynamicPPT()

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

返回值

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

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

setPreloadDynamicPPT()Copy Anchor Link

void setPreloadDynamicPPT(boolean preloadDynamicPPT)

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

addNativeTag()Copy Anchor Link

void addNativeTag(String tag, String value)

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

getLoggerOptions()Copy Anchor Link

LoggerOptions getLoggerOptions()

获取设置的日志选项。

返回值

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

setLoggerOptions()Copy Anchor Link

void setLoggerOptions(LoggerOptions loggerOptions)

设置日志选项。

getNetlessUA()Copy Anchor Link

List<String> getNetlessUA()

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

setNetlessUA()Copy Anchor Link

void setNetlessUA(List<String> netlessUA)

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

isUserCursor()Copy Anchor Link

boolean isUserCursor()

获取是否显示用户头像。

返回值

是否显示用户头像：

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

setUserCursor()Copy Anchor Link

void setUserCursor(boolean userCursor)

设置是否显示用户头像。

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

isOnlyCallbackRemoteStateModify()Copy Anchor Link

boolean isOnlyCallbackRemoteStateModify()

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

返回值

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

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

setOnlyCallbackRemoteStateModify()Copy Anchor Link

void setOnlyCallbackRemoteStateModify(boolean onlyCallbackRemoteStateModify)

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

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

isLog()Copy Anchor Link

boolean isLog()

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

返回值

是否开启调试日志打印：

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

setLog()Copy Anchor Link

void setLog(boolean log)

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

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

isEnableInterrupterAPI()Copy Anchor Link

boolean isEnableInterrupterAPI()

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

返回值

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

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

setEnableInterrupterAPI()Copy Anchor Link

void setEnableInterrupterAPI(boolean enableInterrupterAPI)

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

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

isEnableImgErrorCallback()Copy Anchor Link

boolean isEnableImgErrorCallback()

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

返回值

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

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

setEnableImgErrorCallback()Copy Anchor Link

void setEnableImgErrorCallback(boolean enableImgErrorCallback)

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

getBackgroundImageLoadOptions()Copy Anchor Link

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

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

setBackgroundImageLoadOptions()Copy Anchor Link

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

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

isEnableSyncedStore()Copy Anchor Link

boolean isEnableSyncedStore()

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

setEnableSyncedStore()Copy Anchor Link

void setEnableSyncedStore(boolean enableSyncedStore)

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

getUseMultiViews()Copy Anchor Link

Boolean getUseMultiViews()

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

setUseMultiViews()Copy Anchor Link

void setUseMultiViews(Boolean useMultiViews)

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

getSlideAppOptions()Copy Anchor Link

SlideAppOptions getSlideAppOptions()

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

setSlideAppOptions()Copy Anchor Link

void setSlideAppOptions(SlideAppOptions slideAppOptions)

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

getPresentationAppOptions()Copy Anchor Link

PresentationAppOptions getPresentationAppOptions()

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

setPresentationAppOptions()Copy Anchor Link

void setPresentationAppOptions(PresentationAppOptions presentationAppOptions)

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

isEnableSlideInterrupterAPI()Copy Anchor Link

boolean isEnableSlideInterrupterAPI()

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

setEnableSlideInterrupterAPI()Copy Anchor Link

void setEnableSlideInterrupterAPI(boolean enableSlideInterrupterAPI)

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

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

getApiHosts()Copy Anchor Link

List<String> getApiHosts()

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

setApiHosts()Copy Anchor Link

void setApiHosts(List<String> apiHosts)

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

isEnableAppliancePlugin()Copy Anchor Link

boolean isEnableAppliancePlugin()

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

返回值

是否启用 appliance-plugin：

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

setEnableAppliancePlugin()Copy Anchor Link

void setEnableAppliancePlugin(boolean enableAppliancePlugin)

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

公开成员函数Copy Anchor Link

setDynamicConfigCopy Anchor Link

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

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

公开成员函数Copy Anchor Link

getDynamicConfigCopy Anchor Link

public Map<String, String> getDynamicConfig()

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