com.herewhite.sdk.domain.PlayerConfiguration class 参考

详细描述Copy Anchor Link

适用版本：Whiteboard Android SDK 2.16.134。

PlayerConfiguration 类，用于配置白板回放房间实例。

父类：WhiteObject；继承接口详见父类。

属性与 JSON 字段Copy Anchor Link

Java 非公开字段通过对应 getter/setter 访问；可选包装类型未设置时通常不写入 JSON。初值包含字段声明及无参构造中的直接赋值；其他构造参数以签名为准。

变量说明Copy Anchor Link

roomCopy Anchor Link

String room

源码初值：未显式赋值

模型属性；通过对应 getter/setter 访问。

roomTokenCopy Anchor Link

String roomToken

源码初值：未显式赋值

模型属性；通过对应 getter/setter 访问。

sliceCopy Anchor Link

String slice

源码初值：未显式赋值

模型属性；通过对应 getter/setter 访问。

beginTimestampCopy Anchor Link

Long beginTimestamp

源码初值：未显式赋值

模型属性；通过对应 getter/setter 访问。

durationCopy Anchor Link

Long duration

源码初值：未显式赋值

模型属性；通过对应 getter/setter 访问。

cameraBoundCopy Anchor Link

CameraBound cameraBound

源码初值：未显式赋值

模型属性；通过对应 getter/setter 访问。

stepCopy Anchor Link

Long step

源码初值：500L

模型属性；通过对应 getter/setter 访问。

windowParamsCopy Anchor Link

WindowParams windowParams

源码初值：未显式赋值

多窗口属性

regionCopy Anchor Link

Region region

源码初值：未显式赋值

模型属性；通过对应 getter/setter 访问。

mediaURLCopy Anchor Link

String mediaURL

源码初值：未显式赋值

文档中隐藏 音频地址，暂不支持视频。 Player 会自动与音视频播放做同步，保证同时播放，当一方缓冲时，会暂停。

modulesOriginCopy Anchor Link

String modulesOrigin

源码初值：未显式赋值

白板请求 modules 数据的地址，配置后不会请求白板默认地址

@example https://modules.example.com

函数说明Copy Anchor Link

PlayerConfiguration()Copy Anchor Link

PlayerConfiguration(String room, String roomToken)

回放房间的构造方法，用于初始化回放房间实例。

getRegion()Copy Anchor Link

Region getRegion()

获取 Player 实例的数据中心。

返回值

Player 实例的数据中心。详见 { Region Region}。

setRegion()Copy Anchor Link

void setRegion(Region region)

设置 Player 实例的数据中心。

如果你不调用该方法，SDK 默认使用 { com.herewhite.sdk.WhiteSdkConfiguration WhiteSdkConfiguration} 中设置的数据中心。

getCameraBound()Copy Anchor Link

CameraBound getCameraBound()

获取本地用户的视角边界。

返回值

视角边界，详见 { CameraBound CameraBound}。

setCameraBound()Copy Anchor Link

void setCameraBound(CameraBound cameraBound)

设置本地用户的视角边界。

该方法设置的视角边界必须和 { com.herewhite.sdk.RoomParams::setCameraBound(CameraBound)} 中设置视角边界一致。

setStep()Copy Anchor Link

void setStep(Long duration, TimeUnit timeUnit)

设置 SDK 回调播放进度的频率。

getRoom()Copy Anchor Link

String getRoom()

获取待回放的互动白板房间的 UUID。

返回值

待回放的互动白板房间的 UUID。

setRoom()Copy Anchor Link

void setRoom(String room)

设置待回放的互动白板房间的 UUID。

getRoomToken()Copy Anchor Link

String getRoomToken()

获取待回放的互动白板房间的 Room Token。

返回值

互动白板房间的 Room Token。

setRoomToken()Copy Anchor Link

void setRoomToken(String roomToken)

设置待回放的互动白板房间的 Room Token。

返回值

用于鉴权的 Room Token，必须和初始化互动白板房间实例时设置的 Room Token 一致。

getBeginTimestamp()Copy Anchor Link

Long getBeginTimestamp()

获取白板回放的起始时间。

返回值

Unix 时间戳（毫秒），表示回放的起始 UTC 时间。

setBeginTimestamp()Copy Anchor Link

void setBeginTimestamp(Long beginTimestamp)

设置白板回放的起始时间。

getDuration()Copy Anchor Link

Long getDuration()

获取回放的持续时长。

返回值

回放的持续时长，单位为毫秒。

setDuration()Copy Anchor Link

void setDuration(Long duration)

设置回放的持续时长。

getWindowParams()Copy Anchor Link

WindowParams getWindowParams()

getWindowParams：com.herewhite.sdk.domain.PlayerConfiguration 的公开成员。参数和返回类型见下方签名。

setWindowParams()Copy Anchor Link

void setWindowParams(WindowParams windowParams)

setWindowParams：com.herewhite.sdk.domain.PlayerConfiguration 的公开成员。参数和返回类型见下方签名。

getModulesOrigin()Copy Anchor Link

String getModulesOrigin()

获取白板请求 modules 数据的地址。

返回值

方法调用成功时返回 modules 地址。

setModulesOrigin()Copy Anchor Link

void setModulesOrigin(String modulesOrigin)

设置白板请求 modules 数据的地址。 配置后不会请求白板默认地址。