文档中心
互动白板
API 参考
Agora Interactive Whiteboard Java API Reference
Agora Java API Reference for Android
|
void | postIframeMessage (String string) |
|
void | postIframeMessage (WhiteObject object) |
|
void | getScenePathType (String path, final Promise< WhiteScenePathType > promise) |
|
void | getScene (String path, final Promise< Scene > promise) |
|
void | getEntireScenes (final Promise< Map< String, Scene[]> > promise) |
|
void | refreshViewSize () |
|
void | scaleIframeToFit () |
|
void | scalePptToFit () |
|
void | scalePptToFit (AnimationMode mode) |
|
void | addMagixEventListener (String eventName, EventListener eventListener) |
|
void | addHighFrequencyEventListener (String eventName, FrequencyEventListener eventListener, Integer fireInterval) |
|
void | removeMagixEventListener (String eventName) |
|
void | convertToPointInWorld (double x, double y, final Promise< Point > promise) |
|
void | setCameraBound (CameraBound bound) |
|
void | setBackgroundColor (@ColorInt int intColor) |
|
int | getBackgroundColor () |
|
void | getScenePreviewImage (String scenePath, final Promise< Bitmap > promise) |
|
void | getSceneSnapshotImage (String scenePath, final Promise< Bitmap > promise) |
|
void | disableCameraTransform (Boolean disable) |
|
void | moveCamera (CameraConfig camera) |
|
void | moveCameraToContainer (RectangleConfig rectangle) |
|
|
void | post (Runnable runnable) |
|
|
final JsBridgeInterface | bridge |
|
String | uuid |
|
int | densityDpi |
|
|
static final Gson | gson = new Gson() |
|
Displayer
类。该类为 Room
类和 Player
类的父类。 Room
和 Player
类可以继承该类下的方法。
◆ postIframeMessage() [1/2]
void com.herewhite.sdk.Displayer.postIframeMessage |
( |
String |
string | ) |
|
向 iframe 插件发送字符串信息。
- 自从
- 2.11.4
- 参数
-
◆ postIframeMessage() [2/2]
void com.herewhite.sdk.Displayer.postIframeMessage |
( |
WhiteObject |
object | ) |
|
向 iframe 插件发送 key-value 格式的信息。
- 自从
- 2.11.4
- 参数
-
◆ getScenePathType()
查询场景路径类型。
你可以在该方法中指定想要查询的场景路径,SDK 会返回该路径对应的场景类型。
- 参数
-
path | 想要查询的场景路径。 |
promise | Promise<WhiteScenePathType> 接口实例,详见 Promise 。你可以通过该接口获取 getScenePathType 方法的调用结果:
|
◆ getScene()
void com.herewhite.sdk.Displayer.getScene |
( |
String |
path, |
|
|
final Promise< Scene > |
promise |
|
) |
| |
获取指定场景的信息。
- 参数
-
path | 场景的路径。请确保场景路径以 / 开头,并且由场景目录和场景名构成,例如,/math/classA 。 |
promise | Promise<Scene> 接口实例,详见 Promise 。你可以通过该接口获取 getScene 方法的调用结果:
- 如果方法调用成功,将返回场景信息。详见
Scene 。
- 如果方法调用失败,将返回错误信息。
|
◆ getEntireScenes()
void com.herewhite.sdk.Displayer.getEntireScenes |
( |
final Promise< Map< String, Scene[]> > |
promise | ) |
|
获取当前房间内所有场景的信息。
- 参数
-
promise | Promise<Map<String, Scene[]>> 接口实例,详见 Promise 。你可以通过该接口获取 getEntireScenes 方法的调用结果:
- 如果方法调用成功,将返回当前房间内所有场景的信息。
- 如果方法调用失败,将返回错误信息。
|
◆ refreshViewSize()
void com.herewhite.sdk.Displayer.refreshViewSize |
( |
| ) |
|
◆ scaleIframeToFit()
void com.herewhite.sdk.Displayer.scaleIframeToFit |
( |
| ) |
|
调整视角,以保证完整显示 H5 课件的内容。
- 自从
- 2.12.13
◆ scalePptToFit() [1/2]
void com.herewhite.sdk.Displayer.scalePptToFit |
( |
| ) |
|
以渐变模式调整视角,以保证完整显示 PPT 的内容。
- 自从
- 2.4.22
◆ scalePptToFit() [2/2]
void com.herewhite.sdk.Displayer.scalePptToFit |
( |
AnimationMode |
mode | ) |
|
根据指定的动画模式调整视角,以保证完整显示 PPT 的内容。
- 自从
- 2.4.28
- 参数
-
◆ addMagixEventListener()
void com.herewhite.sdk.Displayer.addMagixEventListener |
( |
String |
eventName, |
|
|
EventListener |
eventListener |
|
) |
| |
注册自定义事件监听。
成功注册后,你可以接收到对应的自定义事件通知。
- 注解
- 对于同名的自定义事件,SDK 仅支持触发一个回调。
- 参数
-
eventName | 想要监听的自定义事件名称。 |
eventListener | 自定义事件回调,详见 EventListener 。如果添加多个同名的事件回调,则之前添加的回调会被覆盖。 |
◆ addHighFrequencyEventListener()
void com.herewhite.sdk.Displayer.addHighFrequencyEventListener |
( |
String |
eventName, |
|
|
FrequencyEventListener |
eventListener, |
|
|
Integer |
fireInterval |
|
) |
| |
注册高频自定义事件监听。
成功注册后,你可以接收到对应的自定义事件通知。
- 注解
- 对于同名的自定义事件,SDK 仅支持触发一个回调。
- 参数
-
eventName | 想要监听的自定义事件名称。 |
eventListener | 自定义事件回调,详见 FrequencyEventListener 。如果添加多个同名的事件回调,则之前添加的回调会被覆盖。 |
fireInterval | SDK 触发回调的频率,单位为毫秒。该参数最小值为 500 ms,如果设置为低于该值会被重置为 500 ms。 |
◆ removeMagixEventListener()
void com.herewhite.sdk.Displayer.removeMagixEventListener |
( |
String |
eventName | ) |
|
◆ convertToPointInWorld()
void com.herewhite.sdk.Displayer.convertToPointInWorld |
( |
double |
x, |
|
|
double |
y, |
|
|
final Promise< Point > |
promise |
|
) |
| |
转换白板上点的坐标。
该方法可以将 Android 内部坐标系(以屏幕左上角为原点)中的坐标转换为世界坐标系(以白板初始化时的中点为原点)坐标。
- 参数
-
x | 点在 Android 坐标系中的 X 轴坐标。 |
y | 点在 Android 坐标系中的 Y 轴坐标。 |
promise | Promise<Point> 接口实例,详见 Promise 。你可以通过该接口获取 convertToPointInWorld 的调用结果:
- 如果方法调用成功,将返回点在世界坐标系上的坐标。详见
Point 。
- 如果方法调用失败,将返回错误信息。
|
◆ setCameraBound()
void com.herewhite.sdk.Displayer.setCameraBound |
( |
CameraBound |
bound | ) |
|
◆ setBackgroundColor()
void com.herewhite.sdk.Displayer.setBackgroundColor |
( |
@ColorInt int |
intColor | ) |
|
设置白板的背景色。
- 自从
- 2.4.14
- 弃用:
- 该方法已废弃,请改用 Android 系统的 setBackgroundColor 方法。
- 注解
- 该方法仅对本地白板有效,不会影响房间内其他用户白板的背景色。
- 参数
-
intColor | 白板的背景色,格式为 16 进制 RGBA 定义下的 Hex 值。注意 A 属性不能达到使白板透明的效果。 |
◆ getBackgroundColor()
int com.herewhite.sdk.Displayer.getBackgroundColor |
( |
| ) |
|
获取本地白板的背景色。
- 自从
- 2.4.0
- 弃用:
- 该方法已废弃。
- 返回
- 本地白板的背景色,格式为 16 进制 ARGB 定义下的 Hex 值。
◆ getScenePreviewImage()
void com.herewhite.sdk.Displayer.getScenePreviewImage |
( |
String |
scenePath, |
|
|
final Promise< Bitmap > |
promise |
|
) |
| |
获取指定场景的预览图。
- 自从
- 2.3.0
- 参数
-
scenePath | 场景路径。 |
promise | Promise<Bitmap> 接口实例,详见 Promise 。你可以通过该接口获取 getScenePreviewImage 方法的调用结果:
- 如果方法调用成功,将返回指定场景的预览图。
- 如果方法调用失败,将返回错误码。
|
◆ getSceneSnapshotImage()
void com.herewhite.sdk.Displayer.getSceneSnapshotImage |
( |
String |
scenePath, |
|
|
final Promise< Bitmap > |
promise |
|
) |
| |
获取指定场景的截图。
- 自从
- 2.3.0
- 参数
-
scenePath | 场景路径。 |
promise | Promise<Bitmap> 接口实例,详见 Promise 。你可以通过该接口获取 getSceneSnapshotImage 方法的调用结果:
- 如果方法调用成功,将返回指定场景的截图。
- 如果方法调用失败,将返回错误信息。
|
◆ disableCameraTransform()
void com.herewhite.sdk.Displayer.disableCameraTransform |
( |
Boolean |
disable | ) |
|
禁止/允许用户调整视角。
- 自从
- 2.11.0
该方法用于禁止或允许用户通过触屏手势移动或缩放视角。
- 参数
-
disable | 是否禁止用户调整视角:
true : 禁止用户调整视角。
false : (默认) 允许用户调整视角。
|
◆ moveCamera()
void com.herewhite.sdk.Displayer.moveCamera |
( |
CameraConfig |
camera | ) |
|
调整视角。
- 自从
- 2.2.0
调用该方法后,SDK 会根据传入的参数调整视角。
- 参数
-
◆ moveCameraToContainer()
void com.herewhite.sdk.Displayer.moveCameraToContainer |
( |
RectangleConfig |
rectangle | ) |
|
调整视角,以保证完整显示视觉矩形。
- 自从
- 2.2.0
- 参数
-