com.herewhite.sdk.Player类 参考

Player 类，用于操作白板的回放。

成员函数说明

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

(

)

停止白板回放。

白板回放停止后，Player 资源会被释放。如果想要重新播放，需要重新初始化 Player 实例。

seekToScheduleTime()

void com.herewhite.sdk.Player.seekToScheduleTime

(

long

seekTime

)

设置白板回放的播放位置。

白板回放的起始时间点为 0，成功调用该方法后，白板回放会在指定位置开始播放。

参数

参数名	描述
seekTime	播放进度，单位为毫秒。

setObserverMode()

void com.herewhite.sdk.Player.setObserverMode

(

PlayerObserverMode

mode

)

设置白板回放的查看模式。

参数

参数名	描述
mode	白板回放的查看模式，详见 PlayerObserverMode。

getPlayerPhase()

PlayerPhase com.herewhite.sdk.Player.getPlayerPhase

(

)

获取白板回放的阶段。

自从

2.4.0

在 Player 生命周期内，你可以调用该方法获取白板回放当前所处的阶段。

注解

• 该方法为同步调用。
• 成功调用 stop、play 或 pause 等方法均会影响白板回放的阶段，但是通过该方法无法立即获取最新的白板回放阶段。 此时，你可以调用 getPhase 获取最新的回放阶段。

返回值

白板回放的阶段，详见 PlayerPhase。

getPhase()

void com.herewhite.sdk.Player.getPhase

(

final Promise< PlayerPhase >

promise

)

获取白板回放的阶段。

在 Player 生命周期内，你可以调用该方法获取白板回放当前所处的阶段。

注解

• 该方法为异步调用。我们推荐你仅在调试或问题排查时使用。一般情况下可以使用同步方法 getPlayerPhase 获取回放阶段。
• 成功调用 stop、play 或 pause 等方法后，你无法通过 getPlayerPhase 立即获取最新的白板回放阶段。 此时，你可以调用 getPhase。

参数

参数名	描述
promise	Promise<PlayerPhase> 接口实例，详见 Promise。你可以通过该接口获取 getPhase 方法的调用结果： 如果方法调用成功，将返回白板回放的阶段。 如果方法调用失败，将返回错误信息。

getPlayerState() [1/2]

PlayerState com.herewhite.sdk.Player.getPlayerState

(

)

获取白板回放的状态。

自从

2.4.0

注解

• 该方法为同步调用。
• 如果白板回放处于 waitingFirstFrame 阶段，则该方法返回 null。

返回值

白板回放的状态，详见 PlayerState。

getPlayerState() [2/2]

void com.herewhite.sdk.Player.getPlayerState

(

final Promise< PlayerState >

promise

)

获取白板回放的状态。

注解

• 该方法为异步调用。我们推荐你仅在调试或问题排查时使用。一般情况下可以使用同步方法 getPlayerState[1/2] 获取。
• 如果白板回放处于 waitingFirstFrame 阶段，则该方法返回 null。

参数

参数名	描述
promise	Promise<PlayerState> 接口实例，详见 Promise。你可以通过该接口获取 getPlayerState 方法调用的结果： 如果方法调用成功，将返回白板回放状态，详见 PlayerState。 如果方法调用失败，将返回错误信息。

getPlayerTimeInfo() [1/2]

PlayerTimeInfo com.herewhite.sdk.Player.getPlayerTimeInfo

(

)

获取白板回放的时间信息。

自从

2.4.0

该方法获取的时间信息，包含当前的播放进度，回放的总时长，以及回放的起始时间，单位为毫秒。

注解

• 该方法为同步调用。
• 该方法获取的当前播放进度可能不准确。

返回值

白板回放的时间信息，详见 PlayerTimeInfo。

getPlayerTimeInfo() [2/2]

void com.herewhite.sdk.Player.getPlayerTimeInfo

(

final Promise< PlayerTimeInfo >

promise

)

获取白板回放的时间信息，该方法为异步调用。

该方法获取的时间信息，包含当前的播放进度，回放的总时长，以及回放的起始时间，单位为毫秒。

注解

该方法为异步调用。我们推荐你仅在调试或问题排查时使用。一般情况下可以使用同步方法 getPlayerTimeInfo 进行获取。

参数

参数名	描述
promise	Promise<PlayerTimeInfo> 接口实例，详见 Promise。你可以通过该接口获取 getPlayerTimeInfo 方法的调用结果： 如果方法调用成功，将返回白板回放的时间信息，详见 PlayerTimeInfo。 如果方法调用失败，将返回错误信息。

addPlayerListener()

void com.herewhite.sdk.Player.addPlayerListener

(

@NonNull PlayerListener

playerListener

)

添加白板回放的回调。

参数

参数名	描述
playerListener	白板回放的回调。详见 PlayerListener。

removePlayerListener()

void com.herewhite.sdk.Player.removePlayerListener

(

@NonNull PlayerListener

playerListener

)

删除白板回放的回调。

参数

参数名	描述
playerListener	白板回放的回调。详见 PlayerListener。