# com.herewhite.sdk.domain.WhiteDisplayerState class 参考 (/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-white-displayer-state)

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

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

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

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

`WhiteDisplayerState` 类，为互动白板实时房间和回放房间共有的状态类。

@since 2.4.8

父类：[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。初值包含字段声明及无参构造中的直接赋值；其他构造参数以签名为准。

| 字段 | 声明 | 源码初值 | 说明 |
| --- | --- | --- | --- |
| [globalState](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-white-displayer-state#a44dc6fb86b4168d090ee0614aa564e00) | `Object globalState` | 未显式赋值 | [api-center-table-0 details](#table-slot-api-center-table-0) |
| [roomMembers](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-white-displayer-state#a7d2be3aaa75e9c7813eeca09f13d1d1b) | `RoomMember[] roomMembers` | 未显式赋值 | [api-center-table-1 details](#table-slot-api-center-table-1) |
| [sceneState](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-white-displayer-state#a9b6da1f00cc46897eeeb0e538a4854d5) | `SceneState sceneState` | 未显式赋值 | [api-center-table-2 details](#table-slot-api-center-table-2) |
| [windowBoxState](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-white-displayer-state#aa1e8a5c6742ed99efb4b805d34408352) | `String windowBoxState` | 未显式赋值 | [api-center-table-3 details](#table-slot-api-center-table-3) |
| [pageState](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-white-displayer-state#a573146c642abb1cbb4cb11cd7d6c31dc) | `PageState pageState` | 未显式赋值 | [api-center-table-4 details](#table-slot-api-center-table-4) |
| [appState](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-white-displayer-state#a5057fcc39b9034718ad55e7c9a419064) | `AppState appState` | 未显式赋值 | [api-center-table-5 details](#table-slot-api-center-table-5) |
| [cameraState](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-white-displayer-state#afe856869b3ad7cc37eb4157e95ad40f4) | `CameraState cameraState` | 未显式赋值 | [api-center-table-6 details](#table-slot-api-center-table-6) |

<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 访问。

| 公开成员签名 |  |
| --- | --- |
| public static &lt;T extends GlobalState&gt; void | [setCustomGlobalStateClass](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-white-displayer-state#aaa54cefb8939135f2e47985dca839d85)(Class&lt;T&gt; classOfT) |
| GlobalState | [getGlobalState](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-white-displayer-state#aefd2ee071864d04fc4d0409a144a03e5) () |
| RoomMember[] | [getRoomMembers](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-white-displayer-state#a13126dbfb0259fab1b1bde9b998528f7) () |
| SceneState | [getSceneState](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-white-displayer-state#a35ef6f3c1faf8935eab1af9215cbb317) () |
| CameraState | [getCameraState](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-white-displayer-state#ad5ba0eaf21bb41fc21d582b7eacd59e7) () |
| String | [getWindowBoxState](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-white-displayer-state#a09d1e814bd6fc81787813412bafb73e6) () |
| PageState | [getPageState](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-white-displayer-state#a49147e8ba741fb83446432e6923020f6) () |
| AppState | [getAppState](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-white-displayer-state#a451430a9edaa91cb0b45de1498800c78) () |

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

<a id="a44dc6fb86b4168d090ee0614aa564e00"></a>

### globalState [#globalstate]

```text
Object globalState
```

源码初值：未显式赋值

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

<a id="a7d2be3aaa75e9c7813eeca09f13d1d1b"></a>

### roomMembers [#roommembers]

```text
RoomMember[] roomMembers
```

源码初值：未显式赋值

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

<a id="a9b6da1f00cc46897eeeb0e538a4854d5"></a>

### sceneState [#scenestate]

```text
SceneState sceneState
```

源码初值：未显式赋值

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

<a id="aa1e8a5c6742ed99efb4b805d34408352"></a>

### windowBoxState [#windowboxstate]

```text
String windowBoxState
```

源码初值：未显式赋值

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

<a id="a573146c642abb1cbb4cb11cd7d6c31dc"></a>

### pageState [#pagestate]

```text
PageState pageState
```

源码初值：未显式赋值

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

<a id="a5057fcc39b9034718ad55e7c9a419064"></a>

### appState [#appstate]

```text
AppState appState
```

源码初值：未显式赋值

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

<a id="afe856869b3ad7cc37eb4157e95ad40f4"></a>

### cameraState [#camerastate]

```text
CameraState cameraState
```

源码初值：未显式赋值

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

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

<a id="aaa54cefb8939135f2e47985dca839d85"></a>

### setCustomGlobalStateClass() [#setcustomglobalstateclass]

`public static <T extends GlobalState> void setCustomGlobalStateClass(Class<T> classOfT)`

设置自定义 [`GlobalState`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-global-state)类。

:::info[自从]
2.4.8
:::

设置后，所有 [`GlobalState`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-global-state) 都会转换为该类的实例。

<ParameterList title="参数">
<Parameter name="&lt;T&gt;">

类型约束，自定义的 [`GlobalState`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-global-state) 类必须继承 [`GlobalState`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-global-state) 类。

</Parameter>
<Parameter name="classOfT">

自定义的 [`GlobalState`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-global-state) 类。

</Parameter>
</ParameterList>

<a id="aefd2ee071864d04fc4d0409a144a03e5"></a>

### getGlobalState() [#getglobalstate]

<ApiSignature>

GlobalState getGlobalState()

</ApiSignature>

获取房间的全局状态。

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

房间的全局状态。

<a id="a13126dbfb0259fab1b1bde9b998528f7"></a>

### getRoomMembers() [#getroommembers]

<ApiSignature>

RoomMember[] getRoomMembers()

</ApiSignature>

获取房间的用户列表。

:::info[注解]
房间的用户列表仅包含互动模式（具有读写权限）的用户，不包含订阅模式（只读权限）的用户。
:::

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

用户列表，详见 [`RoomMember`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-room-member)。

<a id="a35ef6f3c1faf8935eab1af9215cbb317"></a>

### getSceneState() [#getscenestate]

<ApiSignature>

SceneState getSceneState()

</ApiSignature>

获取当前场景目录下的场景状态。

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

当前场景目录下的场景状态，详见 [`SceneState`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-scene-state)。

<a id="ad5ba0eaf21bb41fc21d582b7eacd59e7"></a>

### getCameraState() [#getcamerastate]

<ApiSignature>

CameraState getCameraState()

</ApiSignature>

获取视角状态。

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

视角状态，详见 [`CameraState`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-camera-state)。

<a id="a09d1e814bd6fc81787813412bafb73e6"></a>

### getWindowBoxState() [#getwindowboxstate]

<ApiSignature>

String getWindowBoxState()

</ApiSignature>

获取多窗口下窗口展示状态，为一下值：
maximized: 最大化
minimized: 最小化
normal: 默认展开

:::info[注意]

:::

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

窗口展开状态

<a id="a49147e8ba741fb83446432e6923020f6"></a>

### getPageState() [#getpagestate]

<ApiSignature>

PageState getPageState()

</ApiSignature>

查询统一页面状态，返回 target、可选 appId、1-based page/pageCount 和可选相对 scale。查询目标用 mainView 或 appId；状态 target 返回 mainView/DocsViewer/Slide/Presentation。

<a id="a451430a9edaa91cb0b45de1498800c78"></a>

### getAppState() [#getappstate]

<ApiSignature>

AppState getAppState()

</ApiSignature>

获取多窗口下应用状态

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

应用状态