# com.herewhite.sdk.domain.PlayerConfiguration class 参考 (/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-player-configuration)

> For AI agents: see the complete documentation index at [llms.txt](/llms.txt).

<a id="details"></a>

## 详细描述 [#详细描述]

适用版本：**Whiteboard Android SDK 2.16.134**。

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

父类：[WhiteObject](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-white-object)；继承接口详见父类。

## 属性与 JSON 字段 [#属性与-json-字段]

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

| 字段 | 声明 | 源码初值 | 说明 |
| --- | --- | --- | --- |
| [room](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-player-configuration#aa2a9b123de3533bc4524b9797f681d4e) | `String room` | 未显式赋值 | [api-center-table-0 details](#table-slot-api-center-table-0) |
| [roomToken](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-player-configuration#ac70b90a6fbf33f4a510a0ba183b7ae45) | `String roomToken` | 未显式赋值 | [api-center-table-1 details](#table-slot-api-center-table-1) |
| [slice](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-player-configuration#a9e0dd67e3303324029d05d23d218c6df) | `String slice` | 未显式赋值 | [api-center-table-2 details](#table-slot-api-center-table-2) |
| [beginTimestamp](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-player-configuration#a6838e5bc6edb33121b9a8e12da6b7b5c) | `Long beginTimestamp` | 未显式赋值 | [api-center-table-3 details](#table-slot-api-center-table-3) |
| [duration](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-player-configuration#ac1c1bbe56e3136105b90589a3288f537) | `Long duration` | 未显式赋值 | [api-center-table-4 details](#table-slot-api-center-table-4) |
| [cameraBound](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-player-configuration#aab6717c3096c8af256c00fa14800b6ae) | `CameraBound cameraBound` | 未显式赋值 | [api-center-table-5 details](#table-slot-api-center-table-5) |
| [step](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-player-configuration#a916fbba272977a1933a4ba896134bb5b) | `Long step` | 500L | [api-center-table-6 details](#table-slot-api-center-table-6) |
| [windowParams](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-player-configuration#a923d0ea15f1a2c54fa37aae67761babf) | `WindowParams windowParams` | 未显式赋值 | [api-center-table-7 details](#table-slot-api-center-table-7) |
| [region](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-player-configuration#a1af049f66ada5d6ea8dc2eba0766baf0) | `Region region` | 未显式赋值 | [api-center-table-8 details](#table-slot-api-center-table-8) |
| [mediaURL](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-player-configuration#a4eb5f9e549a37c88965f538b002b73f6) | `String mediaURL` | 未显式赋值 | [api-center-table-9 details](#table-slot-api-center-table-9) |
| [modulesOrigin](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-player-configuration#ae4e7d5def7e5979c1437e7d3b18625ca) | `String modulesOrigin` | 未显式赋值 | [api-center-table-10 details](#table-slot-api-center-table-10) |

<a id="table-slot-api-center-table-0"></a>

**api-center-table-0 details**

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

<a id="table-slot-api-center-table-1"></a>

**api-center-table-1 details**

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

<a id="table-slot-api-center-table-2"></a>

**api-center-table-2 details**

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

<a id="table-slot-api-center-table-3"></a>

**api-center-table-3 details**

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

<a id="table-slot-api-center-table-4"></a>

**api-center-table-4 details**

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

<a id="table-slot-api-center-table-5"></a>

**api-center-table-5 details**

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

<a id="table-slot-api-center-table-6"></a>

**api-center-table-6 details**

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

<a id="table-slot-api-center-table-7"></a>

**api-center-table-7 details**

多窗口属性

<a id="table-slot-api-center-table-8"></a>

**api-center-table-8 details**

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

<a id="table-slot-api-center-table-9"></a>

**api-center-table-9 details**

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

<a id="table-slot-api-center-table-10"></a>

**api-center-table-10 details**

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

@example https://modules.example.com

| 公开成员签名 |  |
| --- | --- |
|  | [PlayerConfiguration](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-player-configuration#ae4917641a1b574ca9890df07a63be9dd) (String room, String roomToken) |
| Region | [getRegion](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-player-configuration#a3c294a0ef621000505c13935f9ffd905) () |
| void | [setRegion](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-player-configuration#a4eca0814cce92b714359d5e4be1470d9) (Region region) |
| CameraBound | [getCameraBound](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-player-configuration#a87cb77037b45b245e55b09be0da7b0c7) () |
| void | [setCameraBound](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-player-configuration#ae80328445e5c166209c21b96a40ac056) (CameraBound cameraBound) |
| void | [setStep](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-player-configuration#a1319a38a90ada34208465e12ce33aebb) (Long duration, TimeUnit timeUnit) |
| String | [getRoom](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-player-configuration#a3fcd9ad7418984031bf1f32fb743946b) () |
| void | [setRoom](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-player-configuration#ad9bc2ea3cf0f4feac6eb8b7c3eef1cee) (String room) |
| String | [getRoomToken](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-player-configuration#aa7d71bcaa254a7699b6d6e7a4675c7bd) () |
| void | [setRoomToken](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-player-configuration#aa6648f3b40e1e09689e78ccc17ae4669) (String roomToken) |
| Long | [getBeginTimestamp](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-player-configuration#a10f9800f5e3beb8e5d2cfb305599e68b) () |
| void | [setBeginTimestamp](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-player-configuration#abaf6dd344696e305d439723d92cee269) (Long beginTimestamp) |
| Long | [getDuration](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-player-configuration#a4073facc38a9e9c709b76518f8a008b6) () |
| void | [setDuration](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-player-configuration#aa512f2424bb5b02b0095a928d5a91ee8) (Long duration) |
| WindowParams | [getWindowParams](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-player-configuration#a7bb2769a8175f039f27778737c6ed90d) () |
| void | [setWindowParams](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-player-configuration#aebb8e3d0a80b29d518bf9908f11d2cd8) (WindowParams windowParams) |
| String | [getModulesOrigin](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-player-configuration#a1ef9584bd58a5591070d0e96e8ead143) () |
| void | [setModulesOrigin](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-player-configuration#ae5fa5e208242734a40f6ab90b055b252) (String modulesOrigin) |

## 变量说明 [#变量说明]

<a id="aa2a9b123de3533bc4524b9797f681d4e"></a>

### room [#room]

```text
String room
```

源码初值：未显式赋值

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

<a id="ac70b90a6fbf33f4a510a0ba183b7ae45"></a>

### roomToken [#roomtoken]

```text
String roomToken
```

源码初值：未显式赋值

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

<a id="a9e0dd67e3303324029d05d23d218c6df"></a>

### slice [#slice]

```text
String slice
```

源码初值：未显式赋值

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

<a id="a6838e5bc6edb33121b9a8e12da6b7b5c"></a>

### beginTimestamp [#begintimestamp]

```text
Long beginTimestamp
```

源码初值：未显式赋值

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

<a id="ac1c1bbe56e3136105b90589a3288f537"></a>

### duration [#duration]

```text
Long duration
```

源码初值：未显式赋值

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

<a id="aab6717c3096c8af256c00fa14800b6ae"></a>

### cameraBound [#camerabound]

```text
CameraBound cameraBound
```

源码初值：未显式赋值

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

<a id="a916fbba272977a1933a4ba896134bb5b"></a>

### step [#step]

```text
Long step
```

源码初值：500L

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

<a id="a923d0ea15f1a2c54fa37aae67761babf"></a>

### windowParams [#windowparams]

```text
WindowParams windowParams
```

源码初值：未显式赋值

多窗口属性

<a id="a1af049f66ada5d6ea8dc2eba0766baf0"></a>

### region [#region]

```text
Region region
```

源码初值：未显式赋值

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

<a id="a4eb5f9e549a37c88965f538b002b73f6"></a>

### mediaURL [#mediaurl]

```text
String mediaURL
```

源码初值：未显式赋值

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

<a id="ae4e7d5def7e5979c1437e7d3b18625ca"></a>

### modulesOrigin [#modulesorigin]

```text
String modulesOrigin
```

源码初值：未显式赋值

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

@example https://modules.example.com

## 函数说明 [#函数说明]

<a id="ae4917641a1b574ca9890df07a63be9dd"></a>

### PlayerConfiguration() [#playerconfiguration]

<ApiSignature>

PlayerConfiguration(String room, String roomToken)

</ApiSignature>

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

<ParameterList title="参数">
<Parameter name="room">

房间 UUID，即房间唯一标识符，必须和加入互动白板房间实例时设置的房间 UUID 一致。

</Parameter>
<Parameter name="roomToken">

用于鉴权的 [Room](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room) Token，必须是使用上面传入的房间 UUID 生成的 [Room](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room) Token。

</Parameter>
</ParameterList>

<a id="a3c294a0ef621000505c13935f9ffd905"></a>

### getRegion() [#getregion]

<ApiSignature>

Region getRegion()

</ApiSignature>

获取 [`Player`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-player) 实例的数据中心。

<h4 data-toc-hidden="true" id={"返回值"}>返回值</h4>

[`Player`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-player) 实例的数据中心。详见 \{ [Region](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/enumcom-1-1herewhite-1-1sdk-1-1domain-1-1-region) [Region](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/enumcom-1-1herewhite-1-1sdk-1-1domain-1-1-region)\}。

<a id="a4eca0814cce92b714359d5e4be1470d9"></a>

### setRegion() [#setregion]

<ApiSignature>

void setRegion(Region region)

</ApiSignature>

设置 [`Player`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-player) 实例的数据中心。

如果你不调用该方法，SDK 默认使用 \{ [com.herewhite.sdk.WhiteSdkConfiguration](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-white-sdk-configuration) [WhiteSdkConfiguration](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-white-sdk-configuration)\} 中设置的数据中心。

<ParameterList title="参数">
<Parameter name="region">

[`Player`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-player) 实例的数据中心。详见 \{ [Region](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/enumcom-1-1herewhite-1-1sdk-1-1domain-1-1-region) [Region](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/enumcom-1-1herewhite-1-1sdk-1-1domain-1-1-region)\}。

</Parameter>
</ParameterList>

<a id="a87cb77037b45b245e55b09be0da7b0c7"></a>

### getCameraBound() [#getcamerabound]

<ApiSignature>

CameraBound getCameraBound()

</ApiSignature>

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

<h4 data-toc-hidden="true" id={"返回值-1"}>返回值</h4>

视角边界，详见 \{ [CameraBound](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-camera-bound) [CameraBound](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-camera-bound)\}。

<a id="ae80328445e5c166209c21b96a40ac056"></a>

### setCameraBound() [#setcamerabound]

<ApiSignature>

void setCameraBound(CameraBound cameraBound)

</ApiSignature>

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

该方法设置的视角边界必须和 \{ [com.herewhite.sdk.RoomParams::setCameraBound(CameraBound)](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params#a068607b4928ceef7265db739fa4e3cb8)\} 中设置视角边界一致。

<ParameterList title="参数">
<Parameter name="cameraBound">

视角边界，详见 \{ [CameraBound](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-camera-bound) [CameraBound](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-camera-bound)\}。

</Parameter>
</ParameterList>

<a id="a1319a38a90ada34208465e12ce33aebb"></a>

### setStep() [#setstep]

<ApiSignature>

void setStep(Long duration, TimeUnit timeUnit)

</ApiSignature>

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

<ParameterList title="参数">
<Parameter name="duration">

间隔时长，默认为每隔 0.5 秒回调一次播放进度。

</Parameter>
<Parameter name="timeUnit">

时长单位，默认值为毫秒 （`MILLISECONDS`），取值详见 [TimeUnit](https://developer.android.com/reference/java/util/concurrent/TimeUnit)。

</Parameter>
</ParameterList>

<a id="a3fcd9ad7418984031bf1f32fb743946b"></a>

### getRoom() [#getroom]

<ApiSignature>

String getRoom()

</ApiSignature>

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

<h4 data-toc-hidden="true" id={"返回值-2"}>返回值</h4>

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

<a id="ad9bc2ea3cf0f4feac6eb8b7c3eef1cee"></a>

### setRoom() [#setroom]

<ApiSignature>

void setRoom(String room)

</ApiSignature>

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

<ParameterList title="参数">
<Parameter name="room">

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

</Parameter>
</ParameterList>

<a id="aa7d71bcaa254a7699b6d6e7a4675c7bd"></a>

### getRoomToken() [#getroomtoken]

<ApiSignature>

String getRoomToken()

</ApiSignature>

获取待回放的互动白板房间的 [Room](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room) Token。

<h4 data-toc-hidden="true" id={"返回值-3"}>返回值</h4>

互动白板房间的 [Room](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room) Token。

<a id="aa6648f3b40e1e09689e78ccc17ae4669"></a>

### setRoomToken() [#setroomtoken]

<ApiSignature>

void setRoomToken(String roomToken)

</ApiSignature>

设置待回放的互动白板房间的 [Room](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room) Token。

<h4 data-toc-hidden="true" id={"返回值-4"}>返回值</h4>

用于鉴权的 [Room](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room) Token，必须和初始化互动白板房间实例时设置的 [Room](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room) Token 一致。

<a id="a10f9800f5e3beb8e5d2cfb305599e68b"></a>

### getBeginTimestamp() [#getbegintimestamp]

<ApiSignature>

Long getBeginTimestamp()

</ApiSignature>

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

<h4 data-toc-hidden="true" id={"返回值-5"}>返回值</h4>

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

<a id="abaf6dd344696e305d439723d92cee269"></a>

### setBeginTimestamp() [#setbegintimestamp]

<ApiSignature>

void setBeginTimestamp(Long beginTimestamp)

</ApiSignature>

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

<ParameterList title="参数">
<Parameter name="beginTimestamp">

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

</Parameter>
</ParameterList>

<a id="a4073facc38a9e9c709b76518f8a008b6"></a>

### getDuration() [#getduration]

<ApiSignature>

Long getDuration()

</ApiSignature>

获取回放的持续时长。

<h4 data-toc-hidden="true" id={"返回值-6"}>返回值</h4>

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

<a id="aa512f2424bb5b02b0095a928d5a91ee8"></a>

### setDuration() [#setduration]

<ApiSignature>

void setDuration(Long duration)

</ApiSignature>

设置回放的持续时长。

<ParameterList title="参数">
<Parameter name="duration">

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

</Parameter>
</ParameterList>

<a id="a7bb2769a8175f039f27778737c6ed90d"></a>

### getWindowParams() [#getwindowparams]

<ApiSignature>

WindowParams getWindowParams()

</ApiSignature>

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

<a id="aebb8e3d0a80b29d518bf9908f11d2cd8"></a>

### setWindowParams() [#setwindowparams]

<ApiSignature>

void setWindowParams(WindowParams windowParams)

</ApiSignature>

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

<a id="a1ef9584bd58a5591070d0e96e8ead143"></a>

### getModulesOrigin() [#getmodulesorigin]

<ApiSignature>

String getModulesOrigin()

</ApiSignature>

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

<h4 data-toc-hidden="true" id={"返回值-7"}>返回值</h4>

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

<a id="ae5fa5e208242734a40f6ab90b055b252"></a>

### setModulesOrigin() [#setmodulesorigin]

<ApiSignature>

void setModulesOrigin(String modulesOrigin)

</ApiSignature>

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

<ParameterList title="参数">
<Parameter name="modulesOrigin">

modules 地址。示例 `https://modules.example.com`。

</Parameter>
</ParameterList>