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

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

构造及析构函数说明

PlayerConfiguration()

com.herewhite.sdk.domain.PlayerConfiguration.PlayerConfiguration	(	String	room,
		String	roomToken
	)

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

参数

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

成员函数说明

getRegion()

Region com.herewhite.sdk.domain.PlayerConfiguration.getRegion

(

)

获取 Player 实例的数据中心。

返回值

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

setRegion()

void com.herewhite.sdk.domain.PlayerConfiguration.setRegion

(

Region

region

)

设置 Player 实例的数据中心。

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

参数

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

getCameraBound()

CameraBound com.herewhite.sdk.domain.PlayerConfiguration.getCameraBound

(

)

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

返回值

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

setCameraBound()

void com.herewhite.sdk.domain.PlayerConfiguration.setCameraBound

(

CameraBound

cameraBound

)

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

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

参数

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

setStep()

void com.herewhite.sdk.domain.PlayerConfiguration.setStep	(	Long	duration,
		TimeUnit	timeUnit
	)

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

参数

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

getRoom()

String com.herewhite.sdk.domain.PlayerConfiguration.getRoom

(

)

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

返回值

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

setRoom()

void com.herewhite.sdk.domain.PlayerConfiguration.setRoom

(

String

room

)

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

参数

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

getRoomToken()

String com.herewhite.sdk.domain.PlayerConfiguration.getRoomToken

(

)

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

返回值

互动白板房间的 Room Token。

setRoomToken()

void com.herewhite.sdk.domain.PlayerConfiguration.setRoomToken

(

String

roomToken

)

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

返回值

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

getBeginTimestamp()

Long com.herewhite.sdk.domain.PlayerConfiguration.getBeginTimestamp

(

)

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

返回值

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

setBeginTimestamp()

void com.herewhite.sdk.domain.PlayerConfiguration.setBeginTimestamp

(

Long

beginTimestamp

)

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

参数

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

getDuration()

Long com.herewhite.sdk.domain.PlayerConfiguration.getDuration

(

)

获取回放的持续时长。

返回值

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

setDuration()

void com.herewhite.sdk.domain.PlayerConfiguration.setDuration

(

Long

duration

)

设置回放的持续时长。

参数

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

getModulesOrigin()

String com.herewhite.sdk.domain.PlayerConfiguration.getModulesOrigin

(

)

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

返回值

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

setModulesOrigin()

void com.herewhite.sdk.domain.PlayerConfiguration.setModulesOrigin

(

String

modulesOrigin

)

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

参数

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