文档中心
互动白板
API 参考
Agora Interactive Whiteboard Java API Reference
Agora Java API Reference for Android
◆ 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 | ) |
|
◆ isEnableIFramePlugin()
boolean com.herewhite.sdk.WhiteSdkConfiguration.isEnableIFramePlugin |
( |
| ) |
|
获取是否启用 iframe 插件。
- 返回
- 是否启用 iframe 插件:
◆ setEnableIFramePlugin()
void com.herewhite.sdk.WhiteSdkConfiguration.setEnableIFramePlugin |
( |
boolean |
enableIFramePlugin | ) |
|
◆ getRegion()
Region com.herewhite.sdk.WhiteSdkConfiguration.getRegion |
( |
| ) |
|
◆ setRegion()
void com.herewhite.sdk.WhiteSdkConfiguration.setRegion |
( |
Region |
region | ) |
|
设置数据中心。
- 注解
- 该方法设置的数据中心必须与要加入的互动白板实时房间所在数据中心一致;否则,SDK 将无法连接到房间 。
- 参数
-
◆ isDisableNewPencilStroke()
boolean com.herewhite.sdk.WhiteSdkConfiguration.isDisableNewPencilStroke |
( |
| ) |
|
获取新铅笔工具的笔锋效果是否关闭。
- 返回
- 新铅笔工具的笔锋效果是否关闭:
true
:关闭笔锋效果。
false
:开启笔锋效果。
◆ setDisableNewPencilStroke()
void com.herewhite.sdk.WhiteSdkConfiguration.setDisableNewPencilStroke |
( |
boolean |
disableNewPencilStroke | ) |
|
开启/关闭新铅笔工具的笔锋效果。
- 注解
- 该方法仅在调用
setDisableNewPencil(false)
后生效。
- 参数
-
disableNewPencilStroke | 是否关闭新铅笔工具的笔锋效果: |
true
:关闭笔锋效果。
false
:(默认)开启笔锋效果。
◆ 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
渲染模式。
- 参数
-
◆ getRenderEngine()
◆ getPptParams()
PptParams com.herewhite.sdk.WhiteSdkConfiguration.getPptParams |
( |
| ) |
|
◆ setPptParams()
void com.herewhite.sdk.WhiteSdkConfiguration.setPptParams |
( |
PptParams |
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 中的所有图片资源开启状态:
◆ 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 |
( |
| ) |
|
◆ setLoggerOptions()
void com.herewhite.sdk.WhiteSdkConfiguration.setLoggerOptions |
( |
LoggerOptions |
loggerOptions | ) |
|
◆ setUserCursor()
void com.herewhite.sdk.WhiteSdkConfiguration.setUserCursor |
( |
boolean |
userCursor | ) |
|
设置是否显示用户头像。
要显示用户头像,请确保你在 userPayload
对象中传入了头像的键值对, 并在调用 setUserPayload
。
- 参数
-
◆ isUserCursor()
boolean com.herewhite.sdk.WhiteSdkConfiguration.isUserCursor |
( |
| ) |
|
◆ isOnlyCallbackRemoteStateModify()
boolean com.herewhite.sdk.WhiteSdkConfiguration.isOnlyCallbackRemoteStateModify |
( |
| ) |
|
获取是否开启仅接收远端用户状态改变的回调。
- 返回
- 是否开启仅接收远端用户状态改变回调:
true
:开启。开启该功能后,本地用户仅会接收到远端用户状态改变的回调,自身状态的改变不会触发回调。
false
:关闭。关闭该功能后,本地用户会接收到远端用户状态改变的回调,也会接收到自身状态改变的回调。
◆ setOnlyCallbackRemoteStateModify()
void com.herewhite.sdk.WhiteSdkConfiguration.setOnlyCallbackRemoteStateModify |
( |
boolean |
onlyCallbackRemoteStateModify | ) |
|
开启/关闭仅接收远端用户状态改变的回调。
开启该功能后,本地用户仅会接收到远端用户状态改变的回调,自身状态的改变不会触发回调;关闭该功能后,本地用户会接收到远端用户状态改变的回调,也会接收到自身状态改变的回调。
- 参数
-
onlyCallbackRemoteStateModify | 是否开启仅接收远端用户状态改变回调:
|
◆ isLog()
boolean com.herewhite.sdk.WhiteSdkConfiguration.isLog |
( |
| ) |
|
获取是否开启调试日志打印。
- 返回
- 是否开启调试日志打印:
◆ setLog()
void com.herewhite.sdk.WhiteSdkConfiguration.setLog |
( |
boolean |
log | ) |
|
开启/关闭调试日志打印。
调试日志仅包含调用初始化互动白板 SDK、加入房间和开始回放等方法的回调。
- 参数
-
◆ isEnableInterrupterAPI()
boolean com.herewhite.sdk.WhiteSdkConfiguration.isEnableInterrupterAPI |
( |
| ) |
|
获取是否开启图片拦截和替换功能。
- 返回
- 是否开启图片拦截和替换功能:
◆ setEnableInterrupterAPI()
void com.herewhite.sdk.WhiteSdkConfiguration.setEnableInterrupterAPI |
( |
boolean |
enableInterrupterAPI | ) |
|
开启/关闭图片拦截替换功能。
该方法可以开启或关闭图片拦截功能。 如果开启,在图片实际插入白板前,SDK 会拦截图片并触发 urlInterrupter
回调,你可以在该回调中替换图片的地址。
- 注解
- Agora 建议不要开启图片拦截功能,否则会频繁触发回调。
- 参数
-
enableInterrupterAPI | 是否开启图片拦截和替换功能:
|
◆ isEnableImgErrorCallback()
boolean com.herewhite.sdk.WhiteSdkConfiguration.isEnableImgErrorCallback |
( |
| ) |
|
获取是否开启对图片加载失败事件的监听。
- 返回
- 是否监听图片加载失败事件:
◆ setEnableImgErrorCallback()
void com.herewhite.sdk.WhiteSdkConfiguration.setEnableImgErrorCallback |
( |
boolean |
enableImgErrorCallback | ) |
|
开启/关闭对图片加载失败事件的监听。
- 参数
-
enableImgErrorCallback | 是否开启对图片加载失败事件的监听:
true :开启。开启后,所有 img 标签加载事件都会在 onMessage 中回调。
false :(默认)关闭。
|