com.herewhite.sdk.domain.WhiteDisplayerState class 参考
- Android
更新时间不可用
详细描述
适用版本:Whiteboard Android SDK 2.16.134。
WhiteDisplayerState 类,为互动白板实时房间和回放房间共有的状态类。
@since 2.4.8
父类:WhiteObject;继承接口详见父类。
属性与 JSON 字段
Java 非公开字段通过对应 getter/setter 访问;可选包装类型未设置时通常不写入 JSON。初值包含字段声明及无参构造中的直接赋值;其他构造参数以签名为准。
| 字段 | 声明 | 源码初值 | 说明 |
|---|---|---|---|
| globalState | Object globalState | 未显式赋值 | 模型属性;通过对应 getter/setter 访问。 |
| roomMembers | RoomMember[] roomMembers | 未显式赋值 | 模型属性;通过对应 getter/setter 访问。 |
| sceneState | SceneState sceneState | 未显式赋值 | 模型属性;通过对应 getter/setter 访问。 |
| windowBoxState | String windowBoxState | 未显式赋值 | 模型属性;通过对应 getter/setter 访问。 |
| pageState | PageState pageState | 未显式赋值 | 模型属性;通过对应 getter/setter 访问。 |
| appState | AppState appState | 未显式赋值 | 模型属性;通过对应 getter/setter 访问。 |
| cameraState | CameraState cameraState | 未显式赋值 | 模型属性;通过对应 getter/setter 访问。 |
| 公开成员签名 | |
|---|---|
| public static <T extends GlobalState> void | setCustomGlobalStateClass(Class<T> classOfT) |
| GlobalState | getGlobalState () |
| RoomMember[] | getRoomMembers () |
| SceneState | getSceneState () |
| CameraState | getCameraState () |
| String | getWindowBoxState () |
| PageState | getPageState () |
| AppState | getAppState () |
变量说明
globalState
Object globalState源码初值:未显式赋值
模型属性;通过对应 getter/setter 访问。
roomMembers
RoomMember[] roomMembers源码初值:未显式赋值
模型属性;通过对应 getter/setter 访问。
sceneState
SceneState sceneState源码初值:未显式赋值
模型属性;通过对应 getter/setter 访问。
windowBoxState
String windowBoxState源码初值:未显式赋值
模型属性;通过对应 getter/setter 访问。
pageState
PageState pageState源码初值:未显式赋值
模型属性;通过对应 getter/setter 访问。
appState
AppState appState源码初值:未显式赋值
模型属性;通过对应 getter/setter 访问。
cameraState
CameraState cameraState源码初值:未显式赋值
模型属性;通过对应 getter/setter 访问。
函数说明
setCustomGlobalStateClass()
public static <T extends GlobalState> void setCustomGlobalStateClass(Class<T> classOfT)
设置自定义 GlobalState类。
自从
2.4.8
设置后,所有 GlobalState 都会转换为该类的实例。
| 参数名 | 描述 |
|---|---|
<T> | 类型约束,自定义的 |
classOfT | 自定义的 |
getGlobalState()
GlobalState getGlobalState()获取房间的全局状态。
返回值
房间的全局状态。
getRoomMembers()
RoomMember[] getRoomMembers()获取房间的用户列表。
注解
房间的用户列表仅包含互动模式(具有读写权限)的用户,不包含订阅模式(只读权限)的用户。
返回值
用户列表,详见 RoomMember。
getSceneState()
SceneState getSceneState()获取当前场景目录下的场景状态。
返回值
当前场景目录下的场景状态,详见 SceneState。
getCameraState()
CameraState getCameraState()获取视角状态。
返回值
视角状态,详见 CameraState。
getWindowBoxState()
String getWindowBoxState()获取多窗口下窗口展示状态,为一下值: maximized: 最大化 minimized: 最小化 normal: 默认展开
注意
返回值
窗口展开状态
getPageState()
PageState getPageState()查询统一页面状态,返回 target、可选 appId、1-based page/pageCount 和可选相对 scale。查询目标用 mainView 或 appId;状态 target 返回 mainView/DocsViewer/Slide/Presentation。
getAppState()
AppState getAppState()获取多窗口下应用状态
返回值
应用状态