# com.herewhite.sdk.WhiteSdk class 参考 (/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-white-sdk) > For AI agents: see the complete documentation index at [llms.txt](/llms.txt). ## 详细描述 [#详细描述] 适用版本:**Whiteboard Android SDK 2.16.134**。 `WhiteSdk` 类。 ## 属性与 JSON 字段 [#属性与-json-字段] Java 非公开字段通过对应 getter/setter 访问;可选包装类型未设置时通常不写入 JSON。初值包含字段声明及无参构造中的直接赋值;其他构造参数以签名为准。 | 字段 | 声明 | 源码初值 | 说明 | | --- | --- | --- | --- | | [audioMixerImplement](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-white-sdk#aba0eed27fb3254d4695f496044242861) | `AudioMixerImplement audioMixerImplement` | 未显式赋值 | [api-center-table-0 details](#table-slot-api-center-table-0) | | [audioEffectImplement](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-white-sdk#a95e03fbed07c9a2ae00dd29231442031) | `AudioEffectImplement audioEffectImplement` | 未显式赋值 | [api-center-table-1 details](#table-slot-api-center-table-1) | | [slideListener](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-white-sdk#a2245848a489a805bc1a7a851f6b37647) | `SlideListener slideListener` | 未显式赋值 | [api-center-table-2 details](#table-slot-api-center-table-2) | **api-center-table-0 details** 模型属性;通过对应 getter/setter 访问。 **api-center-table-1 details** 模型属性;通过对应 getter/setter 访问。 **api-center-table-2 details** 模型属性;通过对应 getter/setter 访问。 | 公开成员签名 | | | --- | --- | | | [WhiteSdk](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-white-sdk#a73aa1e911a6a08ff7de4b605f7b0b32c) (JsBridgeInterface bridge, Context context, WhiteSdkConfiguration whiteSdkConfiguration) | | | [WhiteSdk](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-white-sdk#a7694b8a246b356de3d432da2b8eb4c0a) (JsBridgeInterface bridge, Context context, WhiteSdkConfiguration whiteSdkConfiguration, CommonCallback commonCallback) | | | [WhiteSdk](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-white-sdk#a335e2c96662783c39395af6093e1aa70) (JsBridgeInterface bridge, Context context, WhiteSdkConfiguration whiteSdkConfiguration, UrlInterrupter urlInterrupter) | | | [WhiteSdk](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-white-sdk#ad090a47a1e654bce4e8c4e81ce1ad7e3) (JsBridgeInterface bridge, Context context, WhiteSdkConfiguration whiteSdkConfiguration, CommonCallback commonCallback, AudioMixerBridge audioMixerBridge) | | | [WhiteSdk](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-white-sdk#a8142b727763e7342375af0f861759512) (JsBridgeInterface bridge, Context context, WhiteSdkConfiguration whiteSdkConfiguration, CommonCallback commonCallback, AudioMixerBridge audioMixerBridge, AudioEffectBridge audioEffectBridge) | | String | [Version](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-white-sdk#a3e1a37b99f7f9dfc2bf9e191a9142868) () | | void | [setAudioMixerBridge](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-white-sdk#a6336fbbdb7c676d36e1698a8435542f0) (AudioMixerBridge audioMixerBridge) | | void | [setAudioEffectBridge](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-white-sdk#a48d9197890acc11f2e3bf9fbd0e93e2a) (AudioEffectBridge audioEffectBridge) | | void | [setCommonCallbacks](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-white-sdk#a7a6c33cf1d72b129c992e634f3e81a2f) (CommonCallback commonCallback) | | AudioMixerImplement | [getAudioMixerImplement](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-white-sdk#af5317b1d059982b20c6f3c48912fdf61) () | | AudioEffectImplement | [getAudioEffectImplement](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-white-sdk#acf859058b025848cc7e4acc04807b5de) () | | void | [joinRoom](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-white-sdk#a2f336e8d806643f508cd6c7c1cb0ad3b) (RoomParams roomParams, Promise<Room> roomPromise) | | void | [joinRoom](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-white-sdk#a307c801d0203f3010797c449fd6b7f49) (RoomParams roomParams, RoomListener roomListener, Promise<Room> roomPromise) | | void | [createPlayer](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-white-sdk#a685ef819eb970df4ab0ea6e513b4a6d1) (PlayerConfiguration playerConfiguration, Promise<Player> playerPromise) | | void | [createPlayer](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-white-sdk#a52f15c160d689ebb1f74801820d05607) (PlayerConfiguration playerConfiguration, PlayerListener listener, Promise<Player> playerPromise) | | void | [isPlayable](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-white-sdk#a76a9f524257626f12bc0f6f0ddd4f3a6) (PlayerConfiguration playerConfiguration, Promise<Boolean> playablePromise) | | void | [setupFontFaces](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-white-sdk#a52e56f75148bb1527efd370a9ecee1a0) (FontFace[] fontFaces) | | void | [loadFontFaces](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-white-sdk#a27f75d293d58992a1c9f3d6ae25ae9d9) (FontFace[] fontFaces, Promise<JSONObject> loadPromise) | | void | [registerApp](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-white-sdk#a8ae38ebf042c152e54b50cca590fa794) (WindowRegisterAppParams params, Promise<Boolean> registerPromise) | | void | [getLocalLogState](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-white-sdk#a6870772bb41b156c6decd3b65ea2eb2b) (Promise<JSONObject> promise) | | void | [collectLocalLogs](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-white-sdk#ae8b4f11a2ac467ad52ec78454b200d40) (Promise<JSONObject> promise) | | void | [flushLocalLogs](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-white-sdk#ac3d59db23fa6d78a5d92ad95f3393b87) (Promise<JSONObject> promise) | | void | [uploadLocalLogs](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-white-sdk#acef917c1d41754ce628906bf9143aa65) (Promise<JSONObject> promise) | | void | [reloadBackgroundImage](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-white-sdk#ae66ec46f024b4d67dc73a19a6bc61cd1) (ReloadBackgroundImageParams params, Promise<ReloadBackgroundImageResult> promise) | | void | [hasBackgroundImage](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-white-sdk#a94212e7f1d03bb9f873ddfa8ba124477) (HasBackgroundImageParams params, Promise<Boolean> promise) | | void | [updateTextFont](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-white-sdk#a0d82c56c6e406fc8b96a6b47ecced374) (String[] names) | | void | [releaseRoom](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-white-sdk#a14df05dcc0e6681aae7983538c66a93b) () | | void | [releaseRoom](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-white-sdk#a743253d09f13f40560e845944f357d93) (String uuid) | | void | [releasePlayer](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-white-sdk#aeceb0e6867b96866585cd284d3340ef3) () | | void | [releasePlayer](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-white-sdk#ad1e4ff5b0da99533b334b277b15b6d38) (String uuid) | | void | [requestSlideLog](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-white-sdk#adcb9ec225769170f2f48b0a7ddc32109) (File logFile, Promise<Boolean> promise) | | void | [updateSlideVolume](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-white-sdk#a9c86735f67c57fd523d0d871b914451c) (float volume) | | void | [getSlideVolume](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-white-sdk#a25896f064b76f67c2f700209d9819622) (Promise<Double> promise) | | void | [setSlideListener](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-white-sdk#a9394cbd9f55e04b7430cf90bd12f54bb) (SlideListener slideListener) | | void | [setUnifiedPageStateListener](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-white-sdk#aa6f040b9388bac0e459812fd6dc32cc0) (UnifiedPageStateListener listener) | | void | [recoverSlide](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-white-sdk#afa8f85db0b50d403e84294604814804c) (String slideId, int slideIndex) | | void | [recoverSlide](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-white-sdk#aefc7b22c66a78692a6411dbcace66564) (String slideId) | | void | [prepareWhiteConnection](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-white-sdk#a21f1a893a0c7eb75a81e8b4d0a75a046) (Context context, ConnectionPrepareParam param) | | void | [reportNativeLog](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-white-sdk#a9f9d521b6274a375731379fa84c517d5) (String[] logs) | | [leaveRoom](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-white-sdk#aeddd30f3e861a75876f9e4824ed42481) | `public void leaveRoom(Promise promise)` | ## 变量说明 [#变量说明] ### audioMixerImplement [#audiomixerimplement] ```text AudioMixerImplement audioMixerImplement ``` 源码初值:未显式赋值 模型属性;通过对应 getter/setter 访问。 ### audioEffectImplement [#audioeffectimplement] ```text AudioEffectImplement audioEffectImplement ``` 源码初值:未显式赋值 模型属性;通过对应 getter/setter 访问。 ### slideListener [#slidelistener] ```text SlideListener slideListener ``` 源码初值:未显式赋值 模型属性;通过对应 getter/setter 访问。 ## 函数说明 [#函数说明] ### WhiteSdk() [#whitesdk] WhiteSdk(JsBridgeInterface bridge, Context context, WhiteSdkConfiguration whiteSdkConfiguration) 初始化白板 SDK 实例。 请确保在调用其他 API 前先调用 [`WhiteSdk`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-white-sdk) 创建并初始化白板 SDK 实例。 白板界面,详见 [`WhiteboardView`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-whiteboard-view)。 安卓活动 (Android Activity) 的上下文。 SDK 实例的配置,详见 [`WhiteSdkConfiguration`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-white-sdk-configuration)。 ### WhiteSdk() [#whitesdk-1] WhiteSdk(JsBridgeInterface bridge, Context context, WhiteSdkConfiguration whiteSdkConfiguration, CommonCallback commonCallback) 初始化白板 SDK 实例。 请确保在调用其他 API 前先调用 [`WhiteSdk`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-white-sdk) 创建并初始化白板 SDK 实例。 白板界面,详见 [`WhiteboardView`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-whiteboard-view)。 安卓活动 (Android Activity) 的上下文。 SDK 实例的配置,详见 [`WhiteSdkConfiguration`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-white-sdk-configuration)。 通用事件回调,详见 [`CommonCallback`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/interfacecom-1-1herewhite-1-1sdk-1-1-common-callback)。 ### WhiteSdk() [#whitesdk-2] WhiteSdk(JsBridgeInterface bridge, Context context, WhiteSdkConfiguration whiteSdkConfiguration, UrlInterrupter urlInterrupter) 初始化白板 SDK 实例。 请确保在调用其他 API 前先调用 [`WhiteSdk`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-white-sdk) 创建并初始化白板 SDK 实例。 白板界面,详见 [`WhiteboardView`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-whiteboard-view)。 安卓活动 (Android Activity) 的上下文。 SDK 实例的配置,详见 [`WhiteSdkConfiguration`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-white-sdk-configuration)。 图片 URL 拦截设置,详见 [`UrlInterrupter`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/interfacecom-1-1herewhite-1-1sdk-1-1domain-1-1-url-interrupter)。 :::error[弃用:] 该参数已废弃。请改用 [`CommonCallbacks`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/interfacecom-1-1herewhite-1-1sdk-1-1-common-callbacks) 接口中的 [`urlInterrupter`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/interfacecom-1-1herewhite-1-1sdk-1-1-common-callback#a28839222c6e4b44a001da833300991d4) 方法。 ::: ### WhiteSdk() [#whitesdk-3] WhiteSdk(JsBridgeInterface bridge, Context context, WhiteSdkConfiguration whiteSdkConfiguration, CommonCallback commonCallback, AudioMixerBridge audioMixerBridge) 初始化白板 SDK 实例。 请确保在调用其他 API 前先调用 [`WhiteSdk`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-white-sdk) 创建并初始化白板 SDK 实例。 白板界面,详见 [`WhiteboardView`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-whiteboard-view)。 安卓活动 (Android Activity) 的上下文。 SDK 实例的配置,详见 [`WhiteSdkConfiguration`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-white-sdk-configuration)。 通用事件回调,详见 [`CommonCallback`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/interfacecom-1-1herewhite-1-1sdk-1-1-common-callback)。 混音设置,详见 [`AudioMixerBridge`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/interfacecom-1-1herewhite-1-1sdk-1-1-audio-mixer-bridge)。当你同时使用 Agora RTC SDK 和互动白板 SDK, 且白板中展示的动态 PPT 中包含音频文件时,你可以调用 [`AudioMixerBridge`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/interfacecom-1-1herewhite-1-1sdk-1-1-audio-mixer-bridge) 接口,将动态 PPT 中的所有音频交给 Agora RTC SDK 进行混音播放。 ### WhiteSdk() [#whitesdk-4] WhiteSdk(JsBridgeInterface bridge, Context context, WhiteSdkConfiguration whiteSdkConfiguration, CommonCallback commonCallback, AudioMixerBridge audioMixerBridge, AudioEffectBridge audioEffectBridge) 初始化白板 SDK 实例。 <p> 请确保在调用其他 API 前先调用 `WhiteSdk` 创建并初始化白板 SDK 实例。 #### 参数 [#参数] 白板界面,详见 WhiteboardView。 安卓活动 (Android Activity) 的上下文。 SDK 实例的配置,详见 WhiteSdkConfiguration。 通用事件回调,详见 CommonCallback。 混音设置,详见 AudioMixerBridge。当你同时使用 Agora RTC SDK 和互动白板 SDK, 且白板中展示的动态 PPT 中包含音频文件时,你可以调用 `AudioMixerBridge` 接口,将动态 PPT 中的所有音频交给 Agora RTC SDK 进行混音播放。 ### Version() [#version] static String Version() 查询 SDK 版本号。

返回值

当前的 SDK 版本号,格式为字符串,如 `"2.12.28"`。 ### setAudioMixerBridge() [#setaudiomixerbridge] static void setAudioMixerBridge(AudioMixerBridge audioMixerBridge) setAudioMixerBridge:com.herewhite.sdk.WhiteSdk 的公开成员。参数和返回类型见下方签名。 ### setAudioEffectBridge() [#setaudioeffectbridge] static void setAudioEffectBridge(AudioEffectBridge audioEffectBridge) setAudioEffectBridge:com.herewhite.sdk.WhiteSdk 的公开成员。参数和返回类型见下方签名。 ### setCommonCallbacks() [#setcommoncallbacks] void setCommonCallbacks(CommonCallback commonCallback) 设置通用事件回调。 SDK 通过 [`CommonCallback`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/interfacecom-1-1herewhite-1-1sdk-1-1-common-callback) 类向 app 报告 SDK 运行时的各项事件。 通用回调事件,详见 [`CommonCallback`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/interfacecom-1-1herewhite-1-1sdk-1-1-common-callback) ### getAudioMixerImplement() [#getaudiomixerimplement] AudioMixerImplement getAudioMixerImplement() 获取 [`AudioMixerImplement`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-audio-mixer-implement) 实例。

返回值

[`AudioMixerImplement`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-audio-mixer-implement) 实例。 ### getAudioEffectImplement() [#getaudioeffectimplement] AudioEffectImplement getAudioEffectImplement() 获取 AudioEffectImplement 实例。 此实例用于接收音效相关的回调。 :::info[自此版本] 2.16.73 :::

返回值

方法返回值,类型为 AudioEffectImplement。 ### joinRoom() [#joinroom] void joinRoom(RoomParams roomParams, Promise<Room> roomPromise) 加入互动白板实时房间。 互动白板实时房间的参数配置,详见 [`RoomParams`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params)。 `Promise<`[`Room`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room)`>` 接口实例,详见 [`Promise`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/interfacecom-1-1herewhite-1-1sdk-1-1domain-1-1-promise)。你可以通过该接口获取 `joinRoom` 的调用结果: - 如果方法调用成功,将返回房间对象,详见 [`Room`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room)。 - 如果方法调用失败,将返回错误信息。 ### joinRoom() [#joinroom-1] void joinRoom(RoomParams roomParams, RoomListener roomListener, Promise<Room> roomPromise) 加入互动白板实时房间。 互动白板实时房间的参数配置,详见 [`RoomParams`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params)。 房间事件回调,详见 [`RoomListener`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/interfacecom-1-1herewhite-1-1sdk-1-1-room-listener)。在重连时,如果不传 `roomListener` 参数,则会使用上一次设置的 `roomListener`。如果要释放 `roomListener`,可以调用 [`releaseRoom`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-white-sdk#a743253d09f13f40560e845944f357d93)。 `Promise<`[`Room`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room)`>` 接口实例,详见 [`Promise`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/interfacecom-1-1herewhite-1-1sdk-1-1domain-1-1-promise)。你可以通过该接口获取 `joinRoom` 的调用结果: - 如果方法调用成功,则返回房间对象,详见 [`Room`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room)。 - 如果方法调用失败,则返回错误信息。 ### createPlayer() [#createplayer] void createPlayer(PlayerConfiguration playerConfiguration, Promise<Player> playerPromise) 创建互动白板回放房间。 白板回放的参数配置,详见 [`PlayerConfiguration`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-player-configuration)。 `Promise<`[`Player`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-player)`>` 接口实例,详见 [`Promise`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/interfacecom-1-1herewhite-1-1sdk-1-1domain-1-1-promise)。你可以通过该接口获取 `createPlayer` 的调用结果: - 如果方法调用成功,将返回新创建的回放房间对象,详见 [`Player`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-player)。 - 如果方法调用失败,将返回错误信息。 ### createPlayer() [#createplayer-1] void createPlayer(PlayerConfiguration playerConfiguration, PlayerListener listener, Promise<Player> playerPromise) 创建互动白板回放房间。 白板回放的参数配置,详见 [`PlayerConfiguration`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-player-configuration)。 白板回放事件的回调,详见 [`PlayerListener`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/interfacecom-1-1herewhite-1-1sdk-1-1-player-listener)。 `Promise<`[`Player`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-player)`>` 接口实例,详见 [`Promise`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/interfacecom-1-1herewhite-1-1sdk-1-1domain-1-1-promise)。你可以通过该接口获取 `createPlayer` 的调用结果: - 如果方法调用成功,将返回新创建的回放房间对象,详见 [`Player`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-player)。 - 如果方法调用失败,将返回错误信息。 ### isPlayable() [#isplayable] void isPlayable(PlayerConfiguration playerConfiguration, Promise<Boolean> playablePromise) 查看房间是否有回放数据。 :::info[自从] 2.11.0 ::: 白板回放的参数配置,详见 [`PlayerConfiguration`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-player-configuration)。 `Promise` 接口实例,详见 [`Promise`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/interfacecom-1-1herewhite-1-1sdk-1-1domain-1-1-promise)。你可以通过该接口获取 `isPlayable` 的调用结果: - 如果方法调用成功,则返回 `true`。 - 如果方法调用失败,则返回 `false`。 ### setupFontFaces() [#setupfontfaces] void setupFontFaces(FontFace[] fontFaces) 声明在本地白板中可用的字体。 :::info[自从] 2.11.2 ::: 调用该方法声明的字体可用于显示 PPT 中的文字和白板工具输入的文字。 该方法和 [`loadFontFaces`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-white-sdk#a27f75d293d58992a1c9f3d6ae25ae9d9) 都可以声明在本地白板中可用的字体,区别是 `setupFontFaces` 没有回调,因为无法判断字体声明是否正确;`loadFontFaces` 会触发回调,报告每一种的预加载结果。 :::info[注解] - 该方法只对本地白板生效,不影响远端白板的字体显示。 - 通过该方法声明的字体,只有当被使用时,才会触发下载。 - 不同的字体在不同设备上的渲染可能不同,例如,在某些设备上,要等字体加载完成后,才会渲染文字;而在另外一些设备上,会先使用默认的字体渲染文字,等指定的字体加载完毕后,再整体刷新。 - 每次调用该方法都会覆盖原来的字体声明。 - 请勿同时调用该方法和 `loadFontFaces` 方法。否则,无法预期行为。 ::: `FontFace` 实例,详见 [`FontFace`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-font-face)。 ### loadFontFaces() [#loadfontfaces] void loadFontFaces(FontFace[] fontFaces, Promise<JSONObject> loadPromise) 声明并预加载在本地白板中可用的字体。 :::info[自从] 2.11.2 ::: 调用该方法预加载的字体可以用于显示 PPT 中的文字和白板工具输入的文字。 该方法和 [`setupFontFaces`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-white-sdk#a52e56f75148bb1527efd370a9ecee1a0) 都可以声明在本地白板中可用的字体,区别是 `setupFontFaces` 没有回调,因为无法判断字体声明是否正确;`loadFontFaces` 会触发回调,报告每一种的预加载结果。 :::info[注解] - 该方法只对本地白板生效,不影响远端白板的字体显示。 - 使用该方法预加载的字体,只有当该字体被使用时,才会触发下载。 - 不同的字体在不同设备上的渲染可能不同,例如,在某些设备上,要等字体加载完成后,才会渲染文字;而在另外一些设备上,会先使用默认的字体渲染文字,等指定的字体加载完毕后,再整体刷新。 - 通过该方法预加载的字体无法删除,每次调用都会在原来的基础上新增。 - 请勿同时调用该方法和 `setupFontFaces` 方法。否则,无法预期行为。 ::: 指定的字体,详见 [`FontFace`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-font-face)。 `Promise` 接口实例,详见 [`Promise`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/interfacecom-1-1herewhite-1-1sdk-1-1domain-1-1-promise)。你可以通过该接口获取 `loadFontFaces` 的调用结果: - 如果方法调用成功,则返回 `FontFace` 对象。 - 如果方法调用失败,则返回错误信息。 ### registerApp() [#registerapp] void registerApp(WindowRegisterAppParams params, Promise<Boolean> registerPromise) 在添加自定义 App 前注册 App,kind 必须一致。URL 注册或 JS 字符串注册参数见 WindowRegisterAppParams。 ### getLocalLogState() [#getlocallogstate] void getLocalLogState(Promise<JSONObject> promise) 查询 WebView 内本地日志运行状态,异步返回 JSON 对象。 ### collectLocalLogs() [#collectlocallogs] void collectLocalLogs(Promise<JSONObject> promise) 收集本地诊断日志,异步返回 JSON 对象;需要初始化时显式开启本地日志。 ### flushLocalLogs() [#flushlocallogs] void flushLocalLogs(Promise<JSONObject> promise) 将 WebView 内本地日志刷新到持久化存储,异步返回 JSON 对象。 ### uploadLocalLogs() [#uploadlocallogs] void uploadLocalLogs(Promise<JSONObject> promise) 触发本地日志上传;enabled 与 enabledUpload 均需启用,结果通过异步 JSON 和日志状态事件观察。 ### reloadBackgroundImage() [#reloadbackgroundimage] void reloadBackgroundImage(ReloadBackgroundImageParams params, Promise<ReloadBackgroundImageResult> promise) 重新加载当前聚焦场景此前失败的 Appliance Plugin 背景图。参数包含 source="appliance"、viewId 和可选 scenePath/url;返回 accepted/reloadedCount/可选 reason,accepted 不表示图片已加载成功。需要同时开启 useMultiViews 和 enableAppliancePlugin。 ### hasBackgroundImage() [#hasbackgroundimage] void hasBackgroundImage(HasBackgroundImageParams params, Promise<Boolean> promise) 按 viewId、scenePath、imageUrl 及 sources 查询 Appliance Plugin 管理的背景图,sources 填写 ["appliance"],返回布尔值。需要同时开启 useMultiViews 和 enableAppliancePlugin。 ### updateTextFont() [#updatetextfont] void updateTextFont(String[] names) 设置文字白板工具在本地白板中使用的字体。 :::info[自从] 2.11.2 ::: :::info[注解] - 该方法只对本地白板生效,不影响远端白板的字体显示。 - 该方法只能设置文字白板工具使用的字体,不能用于 PPT 中的文字显示。 ::: 字体名称。如果用户系统中不存在该字体,则文字白板工具无法使用该字体。请确保你已经调用 `setupFontFaces` 或 `loadFontFaces` 将指定字体加载到本地白板中。 ### releaseRoom() [#releaseroom] void releaseRoom() 释放 Native 房间实例和监听资源;业务侧应先调用 disconnect 并处理完成,再释放。 ### releaseRoom() [#releaseroom-1] void releaseRoom(String uuid) 释放 Native 房间实例和监听资源;业务侧应先调用 disconnect 并处理完成,再释放。 ### releasePlayer() [#releaseplayer] void releasePlayer() 释放 Native 回放实例和监听资源。 ### releasePlayer() [#releaseplayer-1] void releasePlayer(String uuid) 释放 Native 回放实例和监听资源。 ### requestSlideLog() [#requestslidelog] void requestSlideLog(File logFile, Promise<Boolean> promise) 请求 Slide 的日志。 用于存储 Slide 日志的日志文件。 请求调用回调结果。 ### updateSlideVolume() [#updateslidevolume] void updateSlideVolume(float volume) 更新当前 PPT 的音量。 音量值,取值范围为 (0,1]。 ### getSlideVolume() [#getslidevolume] void getSlideVolume(Promise<Double> promise) 获取当前 PPT 的音量。 方法调用结果,包含 `volume` 和 `error` 两个字段: - 调用成功:`volume` 返回值为 (0,1] 之间的值,代表当前 PPT 的音量,`error` 返回值为 `nil`。 - 调用失败:`volume` 返回值为 0,`error` 返回值为错误消息。 ### setSlideListener() [#setslidelistener] void setSlideListener(SlideListener slideListener) 设置 SlideApp 回调。 SlideApp 通过 `SlideListener` 类向 app 报告内部运行时的各项事件。 通用回调事件,详见 [`SlideListener`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/interfacecom-1-1herewhite-1-1sdk-1-1window-1-1-slide-listener)。 ### setUnifiedPageStateListener() [#setunifiedpagestatelistener] void setUnifiedPageStateListener(UnifiedPageStateListener listener) 设置或移除统一页状态监听器,接收实际页码/倍率观察与异步命令失败;传 null 移除监听。 ### recoverSlide() [#recoverslide] void recoverSlide(String slideId, int slideIndex) 恢复 Slide #### 参数 [#参数-1] 使用错误消息里告知的 slideId 指定要跳转到哪一页, 如果想要跳转到下一页可以使用错误消息里告知的报错页码 + 1 ### recoverSlide() [#recoverslide-1] void recoverSlide(String slideId) 恢复指定 PPT 的渲染状态。 如果 PPT 渲染失败,你可以调用该方法恢复 PPT 的渲染状态。 PPT ID。 ### prepareWhiteConnection() [#preparewhiteconnection] static void prepareWhiteConnection(Context context, ConnectionPrepareParam param) 提前选择线路以加快首次加入白板房间时的连接速度。 声网建议在加入白板房间前调用该方法,例如设备检测页、白板房间列表页等,有助于提升加入白板房间的连接速度。 安卓活动 (Android Activity) 的上下文。 白板预连接参数,详见 [`ConnectionPrepareParam`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-connection-prepare-param)。 ### reportNativeLog() [#reportnativelog] void reportNativeLog(String[] logs) reportNativeLog:com.herewhite.sdk.WhiteSdk 的公开成员。参数和返回类型见下方签名。 ## 公开成员函数 [#公开成员函数] ### leaveRoom [#leaveroom] ```text public void leaveRoom(Promise promise) ``` 异步退出当前宿主所属 Room。成功的 Object 仅为完成通知,不包含房间状态或可读取的 closed 字段;失败调用 catchEx。退出完成后再释放资源或继续下一次入房。