com.herewhite.sdk.WhiteSdk类 参考

WhiteSdk 类。

构造及析构函数说明

WhiteSdk() [1/4]

初始化白板 SDK 实例。
请确保在调用其他 API 前先调用 WhiteSdk 创建并初始化白板 SDK 实例。

Java

com.herewhite.sdk.WhiteSdk.WhiteSdk(JsBridgeInterface bridge, Context context, WhiteSdkConfiguration whiteSdkConfiguration )

参数

参数名	描述
bridge	白板界面，详见WhiteboardView。
context	安卓活动 (Android Activity) 的上下文。
whiteSdkConfiguration	SDK 实例的配置，详见WhiteSdkConfiguration。

WhiteSdk() [2/4]

初始化白板 SDK 实例。
请确保在调用其他 API 前先调用 WhiteSdk 创建并初始化白板 SDK 实例。

Java

com.herewhite.sdk.WhiteSdk.WhiteSdk(JsBridgeInterface bridge, Context context, WhiteSdkConfiguration whiteSdkConfiguration, @Nullable CommonCallback commonCallback )

参数

参数名	描述
bridge	白板界面，详见WhiteboardView。
context	安卓活动 (Android Activity) 的上下文。
whiteSdkConfiguration	SDK 实例的配置，详见WhiteSdkConfiguration。
commonCallback	通用事件回调，详见CommonCallback。

WhiteSdk() [3/4]

初始化白板 SDK 实例。
请确保在调用其他 API 前先调用 WhiteSdk 创建并初始化白板 SDK 实例。

Java

com.herewhite.sdk.WhiteSdk.WhiteSdk(JsBridgeInterface bridge, Context context, WhiteSdkConfiguration whiteSdkConfiguration, UrlInterrupter urlInterrupter )

参数

参数名	描述
bridge	白板界面，详见WhiteboardView。
context	安卓活动 (Android Activity) 的上下文。
whiteSdkConfiguration	SDK 实例的配置，详见WhiteSdkConfiguration。
urlInterrupter	图片 URL 拦截设置，详见UrlInterrupter。

WhiteSdk() [4/4]

初始化白板 SDK 实例。
请确保在调用其他 API 前先调用 WhiteSdk 创建并初始化白板 SDK 实例。

Java

com.herewhite.sdk.WhiteSdk.WhiteSdk(JsBridgeInterface bridge, Context context, WhiteSdkConfiguration whiteSdkConfiguration, @Nullable CommonCallback commonCallback, @Nullable AudioMixerBridge audioMixerBridge )

参数

参数名	描述
bridge	白板界面，详见WhiteboardView。
context	安卓活动 (Android Activity) 的上下文。
whiteSdkConfiguration	SDK 实例的配置，详见WhiteSdkConfiguration。
commonCallback	通用事件回调，详见CommonCallback。
audioMixerBridge	混音设置，详见AudioMixerBridge。当你同时使用 Agora RTC SDK 和互动白板 SDK, 且白板中展示的动态 PPT 中包含音频文件时，你可以调用AudioMixerBridge接口，将动态 PPT 中的所有音频交给 Agora RTC SDK 进行混音播放。

成员函数说明

setCommonCallbacks()

设置通用事件回调。
SDK 通过 CommonCallback 类向 app 报告 SDK 运行时的各项事件。

Java

void com.herewhite.sdk.WhiteSdk.setCommonCallbacks(CommonCallback commonCallback)

参数

参数名	描述
commonCallback	通用回调事件，详见CommonCallback

getAudioMixerImplement()

获取 AudioMixerImplement 实例。

Java

AudioMixerImplement com.herewhite.sdk.WhiteSdk.getAudioMixerImplement()

返回值

AudioMixerImplement 实例。

Version()

查询 SDK 版本号。

Java

static String com.herewhite.sdk.WhiteSdk.Version()

返回值

当前的 SDK 版本号，格式为字符串，如 "2.12.28" 。

joinRoom() [1/2]

加入互动白板实时房间。

Java

void com.herewhite.sdk.WhiteSdk.joinRoom(final RoomParams roomParams, final Promise< Room > roomPromise )

参数

参数名	描述
roomParams	互动白板实时房间的参数配置，详见RoomParams。
roomPromise	Promise<Room>接口实例，详见Promise。你可以通过该接口获取joinRoom的调用结果： 如果方法调用成功，将返回房间对象，详见Room。 如果方法调用失败，将返回错误信息。

joinRoom() [2/2]

加入互动白板实时房间。

Java

void com.herewhite.sdk.WhiteSdk.joinRoom(final RoomParams roomParams, final RoomListener roomListener, final Promise< Room > roomPromise )

参数

参数名	描述
roomParams	互动白板实时房间的参数配置，详见RoomParams。
roomListener	房间事件回调，详见RoomListener。在重连时，如果不传roomListener参数，则会使用上一次设置的roomListener。如果要释放roomListener，可以调用releaseRoom。
roomPromise	Promise<Room>接口实例，详见Promise。你可以通过该接口获取joinRoom的调用结果： 如果方法调用成功，则返回房间对象，详见Room。 如果方法调用失败，则返回错误信息。

createPlayer() [1/2]

创建互动白板回放房间。

Java

void com.herewhite.sdk.WhiteSdk.createPlayer(final PlayerConfiguration playerConfiguration, final Promise< Player > playerPromise )

参数

参数名	描述
playerConfiguration	白板回放的参数配置，详见PlayerConfiguration。
playerPromise	Promise<Player>接口实例，详见Promise。你可以通过该接口获取createPlayer的调用结果： 如果方法调用成功，将返回新创建的回放房间对象，详见Player。 如果方法调用失败，将返回错误信息。

createPlayer() [2/2]

创建互动白板回放房间。

Java

void com.herewhite.sdk.WhiteSdk.createPlayer(final PlayerConfiguration playerConfiguration, final PlayerListener listener, final Promise< Player > playerPromise )

参数

参数名	描述
playerConfiguration	白板回放的参数配置，详见PlayerConfiguration。
listener	白板回放事件的回调，详见PlayerListener。
playerPromise	Promise<Player>接口实例，详见Promise。你可以通过该接口获取createPlayer的调用结果： 如果方法调用成功，将返回新创建的回放房间对象，详见Player。 如果方法调用失败，将返回错误信息。

isPlayable()

查看房间是否有回放数据。

Java

void com.herewhite.sdk.WhiteSdk.isPlayable(final PlayerConfiguration playerConfiguration, final Promise< Boolean > playablePromise )

参数

参数名	描述
playerConfiguration	白板回放的参数配置，详见PlayerConfiguration。
playablePromise	Promise<Boolean>接口实例，详见Promise。你可以通过该接口获取isPlayable的调用结果： 如果方法调用成功，则返回true。 如果方法调用失败，则返回false。

setupFontFaces()

声明在本地白板中可用的字体。
调用该方法声明的字体可用于显示 PPT 中的文字和白板工具输入的文字。
该方法和 loadFontFaces 都可以声明在本地白板中可用的字体，区别是 setupFontFaces 没有回调，因为无法判断字体声明是否正确；loadFontFaces 会触发回调，报告每一种的预加载结果。

注解

• 该方法只对本地白板生效，不影响远端白板的字体显示。

• 通过该方法声明的字体，只有当被使用时，才会触发下载。

• 不同的字体在不同设备上的渲染可能不同，例如，在某些设备上，要等字体加载完成后，才会渲染文字；而在另外一些设备上，会先使用默认的字体渲染文字，等指定的字体加载完毕后，再整体刷新。

• 每次调用该方法都会覆盖原来的字体声明。

• 请勿同时调用该方法和 loadFontFaces 方法。否则，无法预期行为。

Java

void com.herewhite.sdk.WhiteSdk.setupFontFaces(FontFace[] fontFaces)

参数

参数名	描述
fontFaces	FontFace实例，详见FontFace。

loadFontFaces()

声明并预加载在本地白板中可用的字体。
调用该方法预加载的字体可以用于显示 PPT 中的文字和白板工具输入的文字。
该方法和 setupFontFaces 都可以声明在本地白板中可用的字体，区别是 setupFontFaces 没有回调，因为无法判断字体声明是否正确；loadFontFaces 会触发回调，报告每一种的预加载结果。

注解

• 该方法只对本地白板生效，不影响远端白板的字体显示。

• 使用该方法预加载的字体，只有当该字体被使用时，才会触发下载。

• 不同的字体在不同设备上的渲染可能不同，例如，在某些设备上，要等字体加载完成后，才会渲染文字；而在另外一些设备上，会先使用默认的字体渲染文字，等指定的字体加载完毕后，再整体刷新。

• 通过该方法预加载的字体无法删除，每次调用都会在原来的基础上新增。

• 请勿同时调用该方法和 setupFontFaces 方法。否则，无法预期行为。

Java

void com.herewhite.sdk.WhiteSdk.loadFontFaces(FontFace[] fontFaces, final Promise< JSONObject > loadPromise )

参数

参数名	描述
fontFaces	指定的字体，详见FontFace。
loadPromise	Promise<JSONObject>接口实例，详见Promise。你可以通过该接口获取loadFontFaces的调用结果： 如果方法调用成功，则返回FontFace对象。 如果方法调用失败，则返回错误信息。

updateTextFont()

设置文字白板工具在本地白板中使用的字体。

注解

• 该方法只对本地白板生效，不影响远端白板的字体显示。

• 该方法只能设置文字白板工具使用的字体，不能用于 PPT 中的文字显示。

Java

void com.herewhite.sdk.WhiteSdk.updateTextFont(String[] names)

参数

参数名	描述
names	字体名称。如果用户系统中不存在该字体，则文字白板工具无法使用该字体。请确保你已经调用setupFontFaces或loadFontFaces将指定字体加载到本地白板中。

releaseRoom() [1/2]

释放互动白板实时房间实例并删除 RoomListener 回调。

Java

void com.herewhite.sdk.WhiteSdk.releaseRoom()

releaseRoom() [2/2]

释放互动白板实时房间实例并删除 RoomListener 回调。

Java

void com.herewhite.sdk.WhiteSdk.releaseRoom(String uuid)

参数

参数名	描述
uuid	房间 UUID。该参数无实际意义，因为一个WhiteSdk实例只能对应一个实时房间，不需要使用 UUID 指定房间。

releasePlayer() [1/2]

释放回放房间实例并删除 PlayerListener 回调。

Java

void com.herewhite.sdk.WhiteSdk.releasePlayer()

releasePlayer() [2/2]

释放回放房间实例并删除 PlayerEventListener 回调。

Java

void com.herewhite.sdk.WhiteSdk.releasePlayer(String uuid)

参数

参数名	描述
uuid	回放房间的 UUID。该参数无实际意义，由于一个WhiteSdk实例只能对应一个回放房间，不需要使用 UUID 指定回放房间。

requestSlideLog()

请求 Slide 的日志。

Java

void com.herewhite.sdk.WhiteSdk.requestSlideLog(File logFile, final Promise< Boolean > promise )

参数

参数名	描述
logFile	用于存储 Slide 日志的日志文件。
promise	请求调用回调结果。

updateSlideVolume()

更新当前 PPT 的音量。

Java

void com.herewhite.sdk.WhiteSdk.updateSlideVolume(float volume)

参数

参数名	描述
volume	音量值，取值范围为 (0,1]。

getSlideVolume()

获取当前 PPT 的音量。

Java

void com.herewhite.sdk.WhiteSdk.getSlideVolume(Promise< Double > promise)

参数

参数名	描述
promise	方法调用结果，包含volume和error两个字段： 调用成功：volume返回值为 (0,1] 之间的值，代表当前 PPT 的音量，error返回值为nil。 调用失败：volume返回值为 0，error返回值为错误消息。

setSlideListener()

设置 SlideApp 回调。 SlideApp 通过 SlideListener 类向 app 报告内部运行时的各项事件。

Java

void com.herewhite.sdk.WhiteSdk.setSlideListener(SlideListener slideListener)

参数

参数名	描述
slideListener	通用回调事件，详见[`SlideListener。