com.herewhite.sdk.WhiteSdk类参考

WhiteSdk 类。

构造及析构函数说明

WhiteSdk() [1/4]

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

初始化白板 SDK 实例。

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

参数

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

WhiteSdk() [2/4]

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

初始化白板 SDK 实例。

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

参数

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

WhiteSdk() [3/4]

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

初始化白板 SDK 实例。

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

弃用:: 该参数已废弃。请改用 CommonCallbacks 接口中的 urlInterrupter 方法。

参数

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

WhiteSdk() [4/4]

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

初始化白板 SDK 实例。

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

参数

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

成员函数说明

setCommonCallbacks()

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

设置通用事件回调。

SDK 通过 CommonCallback 类向 app 报告 SDK 运行时的各项事件。

参数

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

getAudioMixerImplement()

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

获取 AudioMixerImplement 实例。

返回值

AudioMixerImplement 实例。

Version()

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

查询 SDK 版本号。

返回值

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

joinRoom() [1/2]

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

加入互动白板实时房间。

参数

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

joinRoom() [2/2]

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]

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

创建互动白板回放房间。

参数

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

createPlayer() [2/2]

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()

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

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

自从

2.11.0

参数

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

setupFontFaces()

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

声明在本地白板中可用的字体。

自从

2.11.2

调用该方法声明的字体可用于显示 PPT 中的文字和白板工具输入的文字。

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

注解

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

通过该方法声明的字体，只有当被使用时，才会触发下载。
不同的字体在不同设备上的渲染可能不同，例如，在某些设备上，要等字体加载完成后，才会渲染文字；而在另外一些设备上，会先使用默认的字体渲染文字，等指定的字体加载完毕后，再整体刷新。
每次调用该方法都会覆盖原来的字体声明。
请勿同时调用该方法和 loadFontFaces 方法。否则，无法预期行为。

参数

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

loadFontFaces()

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

声明并预加载在本地白板中可用的字体。

自从

2.11.2

调用该方法预加载的字体可以用于显示 PPT 中的文字和白板工具输入的文字。

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

注解

该方法只对本地白板生效，不影响远端白板的字体显示。
使用该方法预加载的字体，只有当该字体被使用时，才会触发下载。
不同的字体在不同设备上的渲染可能不同，例如，在某些设备上，要等字体加载完成后，才会渲染文字；而在另外一些设备上，会先使用默认的字体渲染文字，等指定的字体加载完毕后，再整体刷新。
通过该方法预加载的字体无法删除，每次调用都会在原来的基础上新增。
请勿同时调用该方法和 setupFontFaces 方法。否则，无法预期行为。

参数

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

updateTextFont()

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

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

自从

2.11.2

注解

该方法只对本地白板生效，不影响远端白板的字体显示。
该方法只能设置文字白板工具使用的字体，不能用于 PPT 中的文字显示。

参数

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

releaseRoom() [1/2]

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

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

自从

2.4.12

releaseRoom() [2/2]

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

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

弃用:: 该方法已废弃。请改用 releaseRoom。

参数

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

releasePlayer() [1/2]

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

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

自从

2.4.12

releasePlayer() [2/2]

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

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

弃用:: 该方法已废弃。请改用 releasePlayer。

参数

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

requestSlideLog()

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

请求 Slide 的日志。

参数

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

updateSlideVolume()

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

更新当前 PPT 的音量。

参数

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

getSlideVolume()

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

获取当前 PPT 的音量。

参数

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

setSlideListener()

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

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

参数

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

prepareWhiteConnection()

static void com.herewhite.sdk.WhiteSdk.prepareWhiteConnection	(	Context	context,
		ConnectionPrepareParam	param
	)

提前选择线路以加快首次加入白板房间时的连接速度。

声网建议在加入白板房间前调用该方法，例如设备检测页、白板房间列表页等，有助于提升加入白板房间的连接速度。

参数

参数名	描述
context	安卓活动 (Android Activity) 的上下文。
param	白板预连接参数，详见 `ConnectionPrepareParam`。

构造及析构函数说明​

WhiteSdk() [1/4]

参数​

WhiteSdk() [2/4]

参数​

WhiteSdk() [3/4]

参数​

WhiteSdk() [4/4]

参数​

成员函数说明​

setCommonCallbacks()

参数​

getAudioMixerImplement()

返回值​

Version()

返回值​

joinRoom() [1/2]

参数​

joinRoom() [2/2]

参数​

createPlayer() [1/2]

参数​

createPlayer() [2/2]

参数​

isPlayable()

参数​

setupFontFaces()

参数​

loadFontFaces()

参数​

updateTextFont()

参数​

releaseRoom() [1/2]

releaseRoom() [2/2]

参数​

releasePlayer() [1/2]

releasePlayer() [2/2]

参数​

requestSlideLog()

参数​

updateSlideVolume()

参数​

getSlideVolume()

参数​

setSlideListener()

参数​

prepareWhiteConnection()

参数​

构造及析构函数说明

参数

参数

参数

参数

成员函数说明

参数

返回值

返回值

参数

参数

参数

参数

参数

参数

参数

参数

参数

参数

参数

参数

参数

参数

参数