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

适用版本：Whiteboard Android SDK 2.16.134。

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

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

属性与 JSON 字段

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

字段	声明	源码初值	说明
room	String room	未显式赋值	模型属性；通过对应 getter/setter 访问。
roomToken	String roomToken	未显式赋值	模型属性；通过对应 getter/setter 访问。
slice	String slice	未显式赋值	模型属性；通过对应 getter/setter 访问。
beginTimestamp	Long beginTimestamp	未显式赋值	模型属性；通过对应 getter/setter 访问。
duration	Long duration	未显式赋值	模型属性；通过对应 getter/setter 访问。
cameraBound	CameraBound cameraBound	未显式赋值	模型属性；通过对应 getter/setter 访问。
step	Long step	500L	模型属性；通过对应 getter/setter 访问。
windowParams	WindowParams windowParams	未显式赋值	多窗口属性
region	Region region	未显式赋值	模型属性；通过对应 getter/setter 访问。
mediaURL	String mediaURL	未显式赋值	文档中隐藏 音频地址，暂不支持视频。 Player 会自动与音视频播放做同步，保证同时播放，当一方缓冲时，会暂停。
modulesOrigin	String modulesOrigin	未显式赋值	白板请求 modules 数据的地址，配置后不会请求白板默认地址 @example https://modules.example.com

公开成员签名
	PlayerConfiguration (String room, String roomToken)
Region	getRegion ()
void	setRegion (Region region)
CameraBound	getCameraBound ()
void	setCameraBound (CameraBound cameraBound)
void	setStep (Long duration, TimeUnit timeUnit)
String	getRoom ()
void	setRoom (String room)
String	getRoomToken ()
void	setRoomToken (String roomToken)
Long	getBeginTimestamp ()
void	setBeginTimestamp (Long beginTimestamp)
Long	getDuration ()
void	setDuration (Long duration)
WindowParams	getWindowParams ()
void	setWindowParams (WindowParams windowParams)
String	getModulesOrigin ()
void	setModulesOrigin (String modulesOrigin)

变量说明

room

String room

源码初值：未显式赋值
模型属性；通过对应 getter/setter 访问。

roomToken

String roomToken

源码初值：未显式赋值
模型属性；通过对应 getter/setter 访问。

slice

String slice

源码初值：未显式赋值
模型属性；通过对应 getter/setter 访问。

beginTimestamp

Long beginTimestamp

源码初值：未显式赋值
模型属性；通过对应 getter/setter 访问。

duration

Long duration

源码初值：未显式赋值
模型属性；通过对应 getter/setter 访问。

cameraBound

CameraBound cameraBound

源码初值：未显式赋值
模型属性；通过对应 getter/setter 访问。

step

Long step

源码初值：500L
模型属性；通过对应 getter/setter 访问。

windowParams

WindowParams windowParams

源码初值：未显式赋值
多窗口属性

region

Region region

源码初值：未显式赋值
模型属性；通过对应 getter/setter 访问。

mediaURL

String mediaURL

源码初值：未显式赋值
文档中隐藏
音频地址，暂不支持视频。
Player 会自动与音视频播放做同步，保证同时播放，当一方缓冲时，会暂停。

modulesOrigin

String modulesOrigin

源码初值：未显式赋值
白板请求 modules 数据的地址，配置后不会请求白板默认地址
@example https://modules.example.com

函数说明

PlayerConfiguration()

PlayerConfiguration(String room, String roomToken)

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

参数

参数名	描述
room	房间 UUID，即房间唯一标识符，必须和加入互动白板房间实例时设置的房间 UUID 一致。
roomToken	用于鉴权的 Room Token，必须是使用上面传入的房间 UUID 生成的 Room Token。

getRegion()

Region getRegion()

获取 Player 实例的数据中心。

返回值

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

setRegion()

void setRegion(Region region)

设置 Player 实例的数据中心。

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

参数

参数名	描述
region	Player 实例的数据中心。详见 { Region Region}。

getCameraBound()

CameraBound getCameraBound()

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

返回值

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

setCameraBound()

void setCameraBound(CameraBound cameraBound)

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

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

参数

参数名	描述
cameraBound	视角边界，详见 { CameraBound CameraBound}。

setStep()

void setStep(Long duration, TimeUnit timeUnit)

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

参数

参数名	描述
duration	间隔时长，默认为每隔 0.5 秒回调一次播放进度。
timeUnit	时长单位，默认值为毫秒 （MILLISECONDS），取值详见 TimeUnit。

getRoom()

String getRoom()

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

返回值

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

setRoom()

void setRoom(String room)

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

参数

参数名	描述
room	房间 UUID，即房间唯一标识符，必须和初始化互动白板房间实例时设置的房间 UUID 一致。

getRoomToken()

String getRoomToken()

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

返回值

互动白板房间的 Room Token。

setRoomToken()

void setRoomToken(String roomToken)

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

返回值

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

getBeginTimestamp()

Long getBeginTimestamp()

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

返回值

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

setBeginTimestamp()

void setBeginTimestamp(Long beginTimestamp)

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

参数

参数名	描述
beginTimestamp	Unix 时间戳（毫秒），表示回放的起始 UTC 时间。例如，如果要将回放的起始时间设为 2021-03-10 18:03:34 GMT+0800，你需要传入 1615370614269。

getDuration()

Long getDuration()

获取回放的持续时长。

返回值

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

setDuration()

void setDuration(Long duration)

设置回放的持续时长。

参数

参数名	描述
duration	回放的持续时长，单位为毫秒。

getWindowParams()

WindowParams getWindowParams()

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

setWindowParams()

void setWindowParams(WindowParams windowParams)

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

getModulesOrigin()

String getModulesOrigin()

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

返回值

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

setModulesOrigin()

void setModulesOrigin(String modulesOrigin)

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

参数

参数名	描述
modulesOrigin	modules 地址。示例 https://modules.example.com。