文档中心
互动白板
API 参考
Agora Interactive Whiteboard Java API Reference
Agora Java API Reference for Android
|
void | setCommonCallbacks (CommonCallback commonCallback) |
|
AudioMixerImplement | getAudioMixerImplement () |
|
| WhiteSdk (JsBridgeInterface bridge, Context context, WhiteSdkConfiguration whiteSdkConfiguration) |
|
| WhiteSdk (JsBridgeInterface bridge, Context context, WhiteSdkConfiguration whiteSdkConfiguration, @Nullable CommonCallback commonCallback) |
|
| WhiteSdk (JsBridgeInterface bridge, Context context, WhiteSdkConfiguration whiteSdkConfiguration, UrlInterrupter urlInterrupter) |
|
| WhiteSdk (JsBridgeInterface bridge, Context context, WhiteSdkConfiguration whiteSdkConfiguration, @Nullable CommonCallback commonCallback, @Nullable AudioMixerBridge audioMixerBridge) |
|
void | joinRoom (final RoomParams roomParams, final Promise< Room > roomPromise) |
|
void | joinRoom (final RoomParams roomParams, final RoomListener roomListener, final Promise< Room > roomPromise) |
|
void | createPlayer (final PlayerConfiguration playerConfiguration, final Promise< Player > playerPromise) |
|
void | createPlayer (final PlayerConfiguration playerConfiguration, final PlayerListener listener, final Promise< Player > playerPromise) |
|
void | isPlayable (final PlayerConfiguration playerConfiguration, final Promise< Boolean > playablePromise) |
|
void | setupFontFaces (FontFace[] fontFaces) |
|
void | loadFontFaces (FontFace[] fontFaces, final Promise< JSONObject > loadPromise) |
|
void | updateTextFont (String[] names) |
|
void | releaseRoom () |
|
void | releaseRoom (String uuid) |
|
void | releasePlayer () |
|
void | releasePlayer (String uuid) |
|
void | requestSlideLog (File logFile, final Promise< Boolean > promise) |
|
◆ WhiteSdk() [1/4]
com.herewhite.sdk.WhiteSdk.WhiteSdk |
( |
JsBridgeInterface |
bridge, |
|
|
Context |
context, |
|
|
WhiteSdkConfiguration |
whiteSdkConfiguration |
|
) |
| |
初始化白板 SDK 实例。
请确保在调用其他 API 前先调用 WhiteSdk
创建并初始化白板 SDK 实例。
- 参数
-
◆ WhiteSdk() [2/4]
初始化白板 SDK 实例。
请确保在调用其他 API 前先调用 WhiteSdk
创建并初始化白板 SDK 实例。
- 参数
-
◆ WhiteSdk() [3/4]
◆ WhiteSdk() [4/4]
初始化白板 SDK 实例。
请确保在调用其他 API 前先调用 WhiteSdk
创建并初始化白板 SDK 实例。
- 参数
-
◆ setCommonCallbacks()
void com.herewhite.sdk.WhiteSdk.setCommonCallbacks |
( |
CommonCallback |
commonCallback | ) |
|
◆ getAudioMixerImplement()
◆ Version()
static String com.herewhite.sdk.WhiteSdk.Version |
( |
| ) |
|
|
static |
查询 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]
加入互动白板实时房间。
- 参数
-
roomParams | 互动白板实时房间的参数配置,详见 RoomParams 。 |
roomListener | 房间事件回调,详见 RoomListener 。在重连时,如果不传 roomListener 参数,则会使用上一次设置的 roomListener 。如果要释放 roomListener ,可以调用 releaseRoom 。 |
roomPromise | Promise<Room> 接口实例,详见 Promise 。你可以通过该接口获取 joinRoom 的调用结果:
- 如果方法调用成功,则返回房间对象,详见
Room 。
- 如果方法调用失败,则返回错误信息。
|
◆ createPlayer() [1/2]
◆ createPlayer() [2/2]
◆ 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
方法。否则,无法预期行为。
- 参数
-
◆ 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 |
( |
| ) |
|
◆ releaseRoom() [2/2]
void com.herewhite.sdk.WhiteSdk.releaseRoom |
( |
String |
uuid | ) |
|
◆ releasePlayer() [1/2]
void com.herewhite.sdk.WhiteSdk.releasePlayer |
( |
| ) |
|
◆ releasePlayer() [2/2]
void com.herewhite.sdk.WhiteSdk.releasePlayer |
( |
String |
uuid | ) |
|
◆ requestSlideLog()
void com.herewhite.sdk.WhiteSdk.requestSlideLog |
( |
File |
logFile, |
|
|
final Promise< Boolean > |
promise |
|
) |
| |
请求 Slide 的日志。
- 参数
-
logFile | 用于存储 Slide 日志的日志文件。 |
promise | 请求调用回调结果。 |