文档中心
互动白板
API 参考
Agora Interactive Whiteboard Java API Reference
Agora Java API Reference for Android
|
double | getPlaybackSpeed () |
|
void | setPlaybackSpeed (double playbackSpeed) |
|
void | getPlaybackSpeed (final Promise< Double > promise) |
|
void | play () |
|
void | pause () |
|
void | stop () |
|
void | seekToScheduleTime (long seekTime) |
|
void | setObserverMode (PlayerObserverMode mode) |
|
PlayerPhase | getPlayerPhase () |
|
void | getPhase (final Promise< PlayerPhase > promise) |
|
PlayerState | getPlayerState () |
|
void | getPlayerState (final Promise< PlayerState > promise) |
|
PlayerTimeInfo | getPlayerTimeInfo () |
|
void | getPlayerTimeInfo (final Promise< PlayerTimeInfo > promise) |
|
void | addPlayerListener (@NonNull PlayerListener playerListener) |
|
void | removePlayerListener (@NonNull PlayerListener playerListener) |
|
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() |
|
◆ getPlaybackSpeed() [1/2]
double com.herewhite.sdk.Player.getPlaybackSpeed |
( |
| ) |
|
获取白板回放的倍速。
- 自从
- 2.5.2
- 注解
- 该方法为同步调用。
- 该方法获取的是播放倍速。例如,当返回值为
2.0
时,表示当前得播放速度是原速的 2 倍。
- 回放暂停时,返回值也不会为 0。
- 返回
- 白板回放的播放倍速。
◆ setPlaybackSpeed()
void com.herewhite.sdk.Player.setPlaybackSpeed |
( |
double |
playbackSpeed | ) |
|
设置白板回放的倍速。
- 自从
- 2.5.2
- 参数
-
playbackSpeed | 白板回放的倍速。取值必须大于 0,设为 1 表示按原速播放。 |
◆ getPlaybackSpeed() [2/2]
void com.herewhite.sdk.Player.getPlaybackSpeed |
( |
final Promise< Double > |
promise | ) |
|
获取白板回放的倍速。
- 自从
- 2.5.2
- 注解
- 该方位为异步调用。我们推荐你仅在调试或问题排查时使用。一般情况下可以使用同步方法
getPlaybackSpeed
[1/2] 获取播放速度。
- 该方法获取的是播放倍速。例如,当返回值为
2.0
时,表示当前得播放速度是原速的 2 倍。
- 回放暂停时,返回值也不会为 0。
- 参数
-
promise | Promise<Double> 接口实例,详见 Promise 。你可以通过该接口获取 getPlaybackSpeed 的调用结果:
- 如果获取成功,将返回白板回放的倍速。
- 如果获取失败,将返回错误信息。
|
◆ play()
void com.herewhite.sdk.Player.play |
( |
| ) |
|
开始白板回放。
暂停回放后,也可以调用该方法继续白板回放。
◆ pause()
void com.herewhite.sdk.Player.pause |
( |
| ) |
|
◆ stop()
void com.herewhite.sdk.Player.stop |
( |
| ) |
|
◆ seekToScheduleTime()
void com.herewhite.sdk.Player.seekToScheduleTime |
( |
long |
seekTime | ) |
|
设置白板回放的播放位置。
白板回放的起始时间点为 0,成功调用该方法后,白板回放会在指定位置开始播放。
- 参数
-
◆ setObserverMode()
◆ getPlayerPhase()
PlayerPhase com.herewhite.sdk.Player.getPlayerPhase |
( |
| ) |
|
获取白板回放的阶段。
- 自从
- 2.4.0
在 Player
生命周期内,你可以调用该方法获取白板回放当前所处的阶段。
- 注解
-
- 返回
- 白板回放的阶段,详见
PlayerPhase
。
◆ getPhase()
获取白板回放的阶段。
在 Player
生命周期内,你可以调用该方法获取白板回放当前所处的阶段。
- 注解
-
- 参数
-
promise | Promise<PlayerPhase> 接口实例,详见 Promise 。你可以通过该接口获取 getPhase 方法的调用结果:
- 如果方法调用成功,将返回白板回放的阶段。
- 如果方法调用失败,将返回错误信息。
|
◆ getPlayerState() [1/2]
PlayerState com.herewhite.sdk.Player.getPlayerState |
( |
| ) |
|
获取白板回放的状态。
- 自从
- 2.4.0
- 注解
- 该方法为同步调用。
- 如果白板回放处于
waitingFirstFrame
阶段,则该方法返回 null
。
- 返回
- 白板回放的状态,详见
PlayerState
。
◆ getPlayerState() [2/2]
获取白板回放的状态。
- 注解
- 该方法为异步调用。我们推荐你仅在调试或问题排查时使用。一般情况下可以使用同步方法
getPlayerState
[1/2] 获取。
- 如果白板回放处于
waitingFirstFrame
阶段,则该方法返回 null
。
- 参数
-
promise | Promise<PlayerState> 接口实例,详见 Promise 。你可以通过该接口获取 getPlayerState 方法调用的结果:
|
◆ getPlayerTimeInfo() [1/2]
获取白板回放的时间信息。
- 自从
- 2.4.0
该方法获取的时间信息,包含当前的播放进度,回放的总时长,以及回放的起始时间,单位为毫秒。
- 注解
- 该方法为同步调用。
- 该方法获取的当前播放进度可能不准确。
- 返回
- 白板回放的时间信息,详见
PlayerTimeInfo
。
◆ getPlayerTimeInfo() [2/2]
获取白板回放的时间信息,该方法为异步调用。
该方法获取的时间信息,包含当前的播放进度,回放的总时长,以及回放的起始时间,单位为毫秒。
- 注解
- 该方法为异步调用。我们推荐你仅在调试或问题排查时使用。一般情况下可以使用同步方法
getPlayerTimeInfo
进行获取。
- 参数
-
promise | Promise<PlayerTimeInfo> 接口实例,详见 Promise 。你可以通过该接口获取 getPlayerTimeInfo 方法的调用结果:
|
◆ addPlayerListener()
void com.herewhite.sdk.Player.addPlayerListener |
( |
@NonNull PlayerListener |
playerListener | ) |
|
◆ removePlayerListener()
void com.herewhite.sdk.Player.removePlayerListener |
( |
@NonNull PlayerListener |
playerListener | ) |
|