com.herewhite.sdk.WhiteSdkConfiguration类参考

WhiteSdk 实例的配置。

注解

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

构造及析构函数说明

WhiteSdkConfiguration() [1/2]

com.herewhite.sdk.WhiteSdkConfiguration.WhiteSdkConfiguration	(	String	appIdentifier,
		boolean	log
	)

初始化互动白板 SDK 配置。

参数

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

WhiteSdkConfiguration() [2/2]

com.herewhite.sdk.WhiteSdkConfiguration.WhiteSdkConfiguration ( String appIdentifier )

初始化互动白板 SDK 配置。

参数

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

成员函数说明

isEnableIFramePlugin()

boolean com.herewhite.sdk.WhiteSdkConfiguration.isEnableIFramePlugin ( )

获取是否启用 iframe 插件。

返回值

是否启用 iframe 插件：

true：开启。
false：未启用。

setEnableIFramePlugin()

void com.herewhite.sdk.WhiteSdkConfiguration.setEnableIFramePlugin ( boolean enableIFramePlugin )

启用/禁用 iframe 插件。

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

参数

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

getRegion()

Region com.herewhite.sdk.WhiteSdkConfiguration.getRegion ( )

获取设置的数据中心。

返回值

数据中心，详见 Region。

setRegion()

void com.herewhite.sdk.WhiteSdkConfiguration.setRegion ( Region region )

设置数据中心。

注解

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

参数

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

isDisableNewPencilStroke()

boolean com.herewhite.sdk.WhiteSdkConfiguration.isDisableNewPencilStroke ( )

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

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

返回值

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

setDisableNewPencilStroke()

void com.herewhite.sdk.WhiteSdkConfiguration.setDisableNewPencilStroke ( boolean disableNewPencilStroke )

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

注解

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

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

参数

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

setEnableSlideInterrupterAPI()

void com.herewhite.sdk.WhiteSdkConfiguration.setEnableSlideInterrupterAPI ( boolean enableSlideInterrupterAPI )

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

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

参数

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

getApiHosts()

List< String > com.herewhite.sdk.WhiteSdkConfiguration.getApiHosts ( )

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

setApiHosts()

void com.herewhite.sdk.WhiteSdkConfiguration.setApiHosts ( List< String > apiHosts )

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

参数

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

setRenderEngine()

void com.herewhite.sdk.WhiteSdkConfiguration.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`。

getRenderEngine()

RenderEngineType com.herewhite.sdk.WhiteSdkConfiguration.getRenderEngine ( )

获取绘图的渲染模式。

返回值

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

getPptParams()

PptParams com.herewhite.sdk.WhiteSdkConfiguration.getPptParams ( )

获取设置的动态 PPT 参数。

返回值

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

setPptParams()

void com.herewhite.sdk.WhiteSdkConfiguration.setPptParams ( PptParams pptParams )

设置动态 PPT 参数。

参数

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

getFonts()

HashMap< String, String > com.herewhite.sdk.WhiteSdkConfiguration.getFonts ( )

获取自定义字体。

返回值

自定义字体名称和地址。

setFonts()

void com.herewhite.sdk.WhiteSdkConfiguration.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 com.herewhite.sdk.WhiteSdkConfiguration.isPreloadDynamicPPT ( )

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

返回值

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

true：开启。
false: 未开启。

setPreloadDynamicPPT()

void com.herewhite.sdk.WhiteSdkConfiguration.setPreloadDynamicPPT ( boolean preloadDynamicPPT )

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

注解

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

参数

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

getLoggerOptions()

LoggerOptions com.herewhite.sdk.WhiteSdkConfiguration.getLoggerOptions ( )

获取设置的日志选项。

返回值

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

setLoggerOptions()

void com.herewhite.sdk.WhiteSdkConfiguration.setLoggerOptions ( LoggerOptions loggerOptions )

设置日志选项。

自从

2.4.2

参数

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

setUserCursor()

void com.herewhite.sdk.WhiteSdkConfiguration.setUserCursor ( boolean userCursor )

设置是否显示用户头像。

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

参数

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

isUserCursor()

boolean com.herewhite.sdk.WhiteSdkConfiguration.isUserCursor ( )

获取是否显示用户头像。

返回值

是否显示用户头像：

true：显示。
false：不显示。

isOnlyCallbackRemoteStateModify()

boolean com.herewhite.sdk.WhiteSdkConfiguration.isOnlyCallbackRemoteStateModify ( )

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

返回值

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

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

setOnlyCallbackRemoteStateModify()

void com.herewhite.sdk.WhiteSdkConfiguration.setOnlyCallbackRemoteStateModify ( boolean onlyCallbackRemoteStateModify )

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

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

参数

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

isLog()

boolean com.herewhite.sdk.WhiteSdkConfiguration.isLog ( )

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

返回值

是否开启调试日志打印：

true：开启。
false：关闭。

setLog()

void com.herewhite.sdk.WhiteSdkConfiguration.setLog ( boolean log )

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

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

参数

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

isEnableInterrupterAPI()

boolean com.herewhite.sdk.WhiteSdkConfiguration.isEnableInterrupterAPI ( )

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

返回值

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

true：开启。
false：关闭。

setEnableInterrupterAPI()

void com.herewhite.sdk.WhiteSdkConfiguration.setEnableInterrupterAPI ( boolean enableInterrupterAPI )

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

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

注解

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

参数

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

isEnableImgErrorCallback()

boolean com.herewhite.sdk.WhiteSdkConfiguration.isEnableImgErrorCallback ( )

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

返回值

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

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

setEnableImgErrorCallback()

void com.herewhite.sdk.WhiteSdkConfiguration.setEnableImgErrorCallback ( boolean enableImgErrorCallback )

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

参数

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

构造及析构函数说明​

WhiteSdkConfiguration() [1/2]

参数​

WhiteSdkConfiguration() [2/2]

参数​

成员函数说明​

isEnableIFramePlugin()

返回值​

setEnableIFramePlugin()

参数​

getRegion()

返回值​

setRegion()

参数​

isDisableNewPencilStroke()

返回值​

setDisableNewPencilStroke()

参数​

setEnableSlideInterrupterAPI()

参数​

getApiHosts()

setApiHosts()

参数​

setRenderEngine()

参数​

getRenderEngine()

返回值​

getPptParams()

返回值​

setPptParams()

参数​

getFonts()

返回值​

setFonts()

参数​

isPreloadDynamicPPT()

返回值​

setPreloadDynamicPPT()

参数​

getLoggerOptions()

返回值​

setLoggerOptions()

参数​

setUserCursor()

参数​

isUserCursor()

返回值​

isOnlyCallbackRemoteStateModify()

返回值​

setOnlyCallbackRemoteStateModify()

参数​

isLog()

返回值​

setLog()

参数​

isEnableInterrupterAPI()

返回值​

setEnableInterrupterAPI()

参数​

isEnableImgErrorCallback()

返回值​

setEnableImgErrorCallback()

参数​

构造及析构函数说明

参数

参数

成员函数说明

返回值

参数

返回值

参数

返回值

参数

参数

参数

参数

返回值

返回值

参数

返回值

参数

返回值

参数

返回值

参数

参数

返回值

返回值

参数

返回值

参数

返回值

参数

返回值

参数