# com.herewhite.sdk.RoomParams class 参考 (/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params)
> For AI agents: see the complete documentation index at [llms.txt](/llms.txt).
## 详细描述 [#详细描述]
适用版本:**Whiteboard Android SDK 2.16.134**。
`RoomParams` 类,用于配置实时房间的参数。
@note `RoomParams` 类中所有的方法都必须在 `joinRoom` 前调用;成功加入房间后,调用该类中的任何方法都不会生效。
父类:[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。初值包含字段声明及无参构造中的直接赋值;其他构造参数以签名为准。
| 字段 | 声明 | 源码初值 | 说明 |
| --- | --- | --- | --- |
| [uuid](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params#ad7d4698cb6a3a5676124447d28560beb) | `String uuid` | 未显式赋值 | [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-1-room-params#ab6123b30eb47ead6fd7bbdb01fde8814) | `String roomToken` | 未显式赋值 | [api-center-table-1 details](#table-slot-api-center-table-1) |
| [region](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params#a342241d425fd0a5e5cc7eeeb273e1a12) | `Region region` | 未显式赋值 | [api-center-table-2 details](#table-slot-api-center-table-2) |
| [cameraBound](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params#aede89d2dad6b4fd7b557619a93b61f11) | `CameraBound cameraBound` | 未显式赋值 | [api-center-table-3 details](#table-slot-api-center-table-3) |
| [timeout](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params#add95df760cc5f007418221ef816434e8) | `long timeout` | 45000 | [api-center-table-4 details](#table-slot-api-center-table-4) |
| [disableEraseImage](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params#abaf4f91c4b914cd3d2e3266ef2034521) | `boolean disableEraseImage` | false | [api-center-table-5 details](#table-slot-api-center-table-5) |
| [disableDeviceInputs](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params#a577b480f592987fb02ec87de2767792b) | `boolean disableDeviceInputs` | false | [api-center-table-6 details](#table-slot-api-center-table-6) |
| [disableOperations](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params#ae4808f289f77f57f918fb4df0b6250f0) | `boolean disableOperations` | false | [api-center-table-7 details](#table-slot-api-center-table-7) |
| [disableCameraTransform](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params#ae2b8e2130140b095221983699ae25190) | `boolean disableCameraTransform` | false | [api-center-table-8 details](#table-slot-api-center-table-8) |
| [disableBezier](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params#a2ed278b17e69bee23c6cd6f547ce2169) | `boolean disableBezier` | false | [api-center-table-9 details](#table-slot-api-center-table-9) |
| [disableNewPencil](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params#a6db99428eeb4c84ba5db3d1bbcee8c1e) | `boolean disableNewPencil` | true | [api-center-table-10 details](#table-slot-api-center-table-10) |
| [userPayload](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params#a337845d163db233df199fa6628e5ae1e) | `Object userPayload` | 未显式赋值 | [api-center-table-11 details](#table-slot-api-center-table-11) |
| [undoCacheScenesCount](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params#a1f125ca75e3e9090eee2e22f9df5be25) | `Integer undoCacheScenesCount` | 未显式赋值 | [api-center-table-12 details](#table-slot-api-center-table-12) |
| [windowParams](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params#afb6f36176a24f59415f67d0ed32e5c59) | `WindowParams windowParams` | 未显式赋值 | [api-center-table-13 details](#table-slot-api-center-table-13) |
| [disableTextOperations](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params#aa0f5eb36b29d6b3ec313acd71a9c987a) | `boolean disableTextOperations` | false | [api-center-table-14 details](#table-slot-api-center-table-14) |
| [modulesOrigin](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params#aae3f8b8816661dbb74ca6137c9f37808) | `String modulesOrigin` | 未显式赋值 | [api-center-table-15 details](#table-slot-api-center-table-15) |
| [optimizeOptions](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params#a98a34291ea2338c65c9e1ffa311aafa2) | `RoomOptimizeOptions optimizeOptions` | 未显式赋值 | [api-center-table-16 details](#table-slot-api-center-table-16) |
| [appliancePluginOptions](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params#addd3da5b2adab7f7b78b435af95fe42b) | `AppliancePluginOptions appliancePluginOptions` | 未显式赋值 | [api-center-table-17 details](#table-slot-api-center-table-17) |
| [disableInitialStateCallback](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params#a945b25c82203df4a7da5b4a6292bea3f) | `boolean disableInitialStateCallback` | false | [api-center-table-18 details](#table-slot-api-center-table-18) |
**api-center-table-0 details**
模型属性;通过对应 getter/setter 访问。
**api-center-table-1 details**
模型属性;通过对应 getter/setter 访问。
**api-center-table-2 details**
模型属性;通过对应 getter/setter 访问。
**api-center-table-3 details**
模型属性;通过对应 getter/setter 访问。
**api-center-table-4 details**
重连时,最大重连尝试时间,单位:毫秒,默认 45 秒。
**api-center-table-5 details**
模型属性;通过对应 getter/setter 访问。
**api-center-table-6 details**
模型属性;通过对应 getter/setter 访问。
**api-center-table-7 details**
模型属性;通过对应 getter/setter 访问。
**api-center-table-8 details**
禁止设备输入引发的视角变化;不会禁止程序调用支持的视角接口。
**api-center-table-9 details**
模型属性;通过对应 getter/setter 访问。
**api-center-table-10 details**
模型属性;通过对应 getter/setter 访问。
**api-center-table-11 details**
模型属性;通过对应 getter/setter 访问。
**api-center-table-12 details**
撤销/重做保留的场景缓存数量;在入房前配置,未设置时交由内嵌 Web SDK 决定。
**api-center-table-13 details**
多窗口属性
**api-center-table-14 details**
是否关闭 ``insertText``与``updateText`` 操作权限
**api-center-table-15 details**
模型属性;通过对应 getter/setter 访问。
**api-center-table-16 details**
白板渲染优化配置项。
**api-center-table-17 details**
本地绘制插件参数,extras 为配置嵌套层;与启用开关配合使用。
**api-center-table-18 details**
是否禁止初始化时的回调
| 公开成员签名 | |
| --- | --- |
| | [RoomParams](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params#ada87eefb4b25310cfa6df81038417f58) (String uuid, String roomToken, String uid) |
| | [RoomParams](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params#a5aa8c28b510f899e97cf2b26c56e5f48) (String uuid, String roomToken, String uid, MemberInformation memberInfo) |
| | [RoomParams](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params#a625545247367efb54b7d799dd19bffc2) (String uuid, String roomToken, String uid, Object userPayload) |
| Region | [getRegion](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params#a7b068e0e3ab5e20b3ba216d2e6156124) () |
| void | [setRegion](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params#affd817d704b87cee8c9aa38697d459c7) (Region region) |
| boolean | [isWritable](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params#a46ee2c4da1611653b0d20e5080bc7636) () |
| void | [setWritable](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params#a9dbc3e05cc1229492c3f91ce48b305cd) (boolean writable) |
| boolean | [getDisableEraseImage](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params#a35f2724130ce493f7bbbdaa8665e28de) () |
| void | [setDisableEraseImage](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params#a580315c5bf3976be29a97acb90261331) (boolean disableEraseImage) |
| void | [setTimeout](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params#a3f7054556c1f72ac03f754538b55e5c0) (long timeout, TimeUnit timeUnit) |
| boolean | [isDisableDeviceInputs](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params#a02b980237de8d8e9d91b4ebc5bf63887) () |
| void | [setDisableDeviceInputs](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params#a0be8c01908f2826302fb50ce5c98c0e1) (boolean disableDeviceInputs) |
| boolean | [isDisableOperations](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params#a94cc0f493d873a3ba55caffb70b0f0cf) () |
| void | [setDisableOperations](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params#acf4a08b32a536804e91c4dd22f476a04) (boolean disableOperations) |
| boolean | [isDisableBezier](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params#ac4ed37a313c3087cb24170ca6435ff2f) () |
| void | [setDisableBezier](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params#a6190fcaaf5dbea2b394cf5c73c9fa411) (boolean disableBezier) |
| boolean | [isDisableCameraTransform](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params#ade13f69996cb32fd94120c46d8b0af0c) () |
| void | [setDisableCameraTransform](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params#a891549135084e1b843281a099c2c0561) (boolean disableCameraTransform) |
| boolean | [isDisableNewPencil](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params#a3b6b4fd252c282c685e217109eeb60c5) () |
| void | [setDisableNewPencil](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params#a49c41b2dfd21f764d6e3ff63ca09f19d) (boolean disableNewPencil) |
| CameraBound | [getCameraBound](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params#afd4fb99429b98be70014888b7a9286b6) () |
| void | [setCameraBound](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params#a068607b4928ceef7265db739fa4e3cb8) (CameraBound cameraBound) |
| Object | [getUserPayload](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params#a9b6f02c4298339cc91ce8f88576f3049) () |
| void | [setUserPayload](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params#a17c8130727ea71cdeca6c3c2362cc0b7) (Object userPayload) |
| MemberInformation | [getMemberInfo](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params#abb2f190ee04cbfcb95001ee3cd29c1d1) () |
| void | [setMemberInfo](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params#ac3d609dd67f195eb947fa4a19abcfa37) (MemberInformation memberInfo) |
| String | [getUuid](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params#a0f9c1507ca1f9e7c35d0b11f6801eb60) () |
| void | [setUuid](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params#a59c71a74ef95003eb7fe1a3a1783c290) (String uuid) |
| String | [getRoomToken](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params#a5752788874ff70d8e732c3105be828fb) () |
| void | [setRoomToken](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params#a6630be6ab3d486467c80ae7d8ee2c4a8) (String roomToken) |
| Integer | [getUndoCacheScenesCount](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params#a1e14e97d7d1b5055ecf3d819ad3920af) () |
| void | [setUndoCacheScenesCount](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params#af271a742fcbce32a60b15db9871a63c0) (Integer undoCacheScenesCount) |
| WindowParams | [getWindowParams](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params#a4a60b886a9e4149256d78df36a51be4c) () |
| void | [setWindowParams](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params#a8d2a306a66f7f2a7f4f3d32a987b8f63) (WindowParams windowParams) |
| boolean | [isDisableTextOperations](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params#a4c580bf300660445105a94e18217108a) () |
| void | [setDisableTextOperations](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params#a638a9fe6f428d2821f0b3a07de0bed71) (boolean disableTextOperations) |
| boolean | [isUseNativeWebSocket](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params#ad5a9e486b8d4729382f3e4b4d8895859) () |
| void | [setUseNativeWebSocket](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params#a366cbea6a84e8c73e8425153fd40fe16) (boolean nativeWebSocket) |
| boolean | [isUsingFloatBar](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params#a3f7bff7cbb7a7f7fb5e7b185a9bd8eac) () |
| void | [setUsingFloatBar](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params#a62a0c199916003f9745a509081fc64ab) (boolean floatBar) |
| String | [getModulesOrigin](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params#aa8e1d1c2aa0e00f942d91c01e1bc751a) () |
| void | [setModulesOrigin](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params#ab55b1761e938355bb3fecf6ea3418bb5) (String modulesOrigin) |
| RoomOptimizeOptions | [getOptimizeOptions](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params#abdf298203235b04c112f30e453f0e748) () |
| void | [setOptimizeOptions](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params#a31d0567336c0fd36819ecc7091d69663) (RoomOptimizeOptions optimizeOptions) |
| boolean | [isDisableInitialStateCallback](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params#a6623f523165cea86c4d0b91595c8f62b) () |
| void | [setDisableInitialStateCallback](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params#ad400a36cae5a169fbd2e3b50df6d8e50) (boolean disableInitialStateCallback) |
| AppliancePluginOptions | [getAppliancePluginOptions](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params#ab93b46b37acf427c12c74d4e7cfd192e) () |
| void | [setAppliancePluginOptions](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params#a5121f17e30594201381fec68dbd02250) (AppliancePluginOptions appliancePluginOptions) |
## 变量说明 [#变量说明]
### uuid [#uuid]
```text
String uuid
```
源码初值:未显式赋值
模型属性;通过对应 getter/setter 访问。
### roomToken [#roomtoken]
```text
String roomToken
```
源码初值:未显式赋值
模型属性;通过对应 getter/setter 访问。
### region [#region]
```text
Region region
```
源码初值:未显式赋值
模型属性;通过对应 getter/setter 访问。
### cameraBound [#camerabound]
```text
CameraBound cameraBound
```
源码初值:未显式赋值
模型属性;通过对应 getter/setter 访问。
### timeout [#timeout]
```text
long timeout
```
源码初值:45000
重连时,最大重连尝试时间,单位:毫秒,默认 45 秒。
### disableEraseImage [#disableeraseimage]
```text
boolean disableEraseImage
```
源码初值:false
模型属性;通过对应 getter/setter 访问。
### disableDeviceInputs [#disabledeviceinputs]
```text
boolean disableDeviceInputs
```
源码初值:false
模型属性;通过对应 getter/setter 访问。
### disableOperations [#disableoperations]
```text
boolean disableOperations
```
源码初值:false
模型属性;通过对应 getter/setter 访问。
### disableCameraTransform [#disablecameratransform]
```text
boolean disableCameraTransform
```
源码初值:false
禁止设备输入引发的视角变化;不会禁止程序调用支持的视角接口。
### disableBezier [#disablebezier]
```text
boolean disableBezier
```
源码初值:false
模型属性;通过对应 getter/setter 访问。
### disableNewPencil [#disablenewpencil]
```text
boolean disableNewPencil
```
源码初值:true
模型属性;通过对应 getter/setter 访问。
### userPayload [#userpayload]
```text
Object userPayload
```
源码初值:未显式赋值
模型属性;通过对应 getter/setter 访问。
### undoCacheScenesCount [#undocachescenescount]
```text
Integer undoCacheScenesCount
```
源码初值:未显式赋值
撤销/重做保留的场景缓存数量;在入房前配置,未设置时交由内嵌 Web SDK 决定。
### windowParams [#windowparams]
```text
WindowParams windowParams
```
源码初值:未显式赋值
多窗口属性
### disableTextOperations [#disabletextoperations]
```text
boolean disableTextOperations
```
源码初值:false
是否关闭 ``insertText``与``updateText`` 操作权限
### modulesOrigin [#modulesorigin]
```text
String modulesOrigin
```
源码初值:未显式赋值
模型属性;通过对应 getter/setter 访问。
### optimizeOptions [#optimizeoptions]
```text
RoomOptimizeOptions optimizeOptions
```
源码初值:未显式赋值
白板渲染优化配置项。
### appliancePluginOptions [#appliancepluginoptions]
```text
AppliancePluginOptions appliancePluginOptions
```
源码初值:未显式赋值
本地绘制插件参数,extras 为配置嵌套层;与启用开关配合使用。
### disableInitialStateCallback [#disableinitialstatecallback]
```text
boolean disableInitialStateCallback
```
源码初值:false
是否禁止初始化时的回调
## 函数说明 [#函数说明]
### RoomParams() [#roomparams]