# 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).

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

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

适用版本：**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) |

<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**

重连时，最大重连尝试时间，单位：毫秒，默认 45 秒。

<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**

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

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

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

禁止设备输入引发的视角变化；不会禁止程序调用支持的视角接口。

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

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

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

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

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

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

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

**api-center-table-11 details**

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

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

**api-center-table-12 details**

撤销/重做保留的场景缓存数量；在入房前配置，未设置时交由内嵌 Web SDK 决定。

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

**api-center-table-13 details**

多窗口属性

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

**api-center-table-14 details**

是否关闭 ``insertText``与``updateText`` 操作权限

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

**api-center-table-15 details**

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

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

**api-center-table-16 details**

白板渲染优化配置项。

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

**api-center-table-17 details**

本地绘制插件参数，extras 为配置嵌套层；与启用开关配合使用。

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

**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) |

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

<a id="ad7d4698cb6a3a5676124447d28560beb"></a>

### uuid [#uuid]

```text
String uuid
```

源码初值：未显式赋值

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

<a id="ab6123b30eb47ead6fd7bbdb01fde8814"></a>

### roomToken [#roomtoken]

```text
String roomToken
```

源码初值：未显式赋值

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

<a id="a342241d425fd0a5e5cc7eeeb273e1a12"></a>

### region [#region]

```text
Region region
```

源码初值：未显式赋值

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

<a id="aede89d2dad6b4fd7b557619a93b61f11"></a>

### cameraBound [#camerabound]

```text
CameraBound cameraBound
```

源码初值：未显式赋值

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

<a id="add95df760cc5f007418221ef816434e8"></a>

### timeout [#timeout]

```text
long timeout
```

源码初值：45000

重连时，最大重连尝试时间，单位：毫秒，默认 45 秒。

<a id="abaf4f91c4b914cd3d2e3266ef2034521"></a>

### disableEraseImage [#disableeraseimage]

```text
boolean disableEraseImage
```

源码初值：false

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

<a id="a577b480f592987fb02ec87de2767792b"></a>

### disableDeviceInputs [#disabledeviceinputs]

```text
boolean disableDeviceInputs
```

源码初值：false

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

<a id="ae4808f289f77f57f918fb4df0b6250f0"></a>

### disableOperations [#disableoperations]

```text
boolean disableOperations
```

源码初值：false

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

<a id="ae2b8e2130140b095221983699ae25190"></a>

### disableCameraTransform [#disablecameratransform]

```text
boolean disableCameraTransform
```

源码初值：false

禁止设备输入引发的视角变化；不会禁止程序调用支持的视角接口。

<a id="a2ed278b17e69bee23c6cd6f547ce2169"></a>

### disableBezier [#disablebezier]

```text
boolean disableBezier
```

源码初值：false

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

<a id="a6db99428eeb4c84ba5db3d1bbcee8c1e"></a>

### disableNewPencil [#disablenewpencil]

```text
boolean disableNewPencil
```

源码初值：true

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

<a id="a337845d163db233df199fa6628e5ae1e"></a>

### userPayload [#userpayload]

```text
Object userPayload
```

源码初值：未显式赋值

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

<a id="a1f125ca75e3e9090eee2e22f9df5be25"></a>

### undoCacheScenesCount [#undocachescenescount]

```text
Integer undoCacheScenesCount
```

源码初值：未显式赋值

撤销/重做保留的场景缓存数量；在入房前配置，未设置时交由内嵌 Web SDK 决定。

<a id="afb6f36176a24f59415f67d0ed32e5c59"></a>

### windowParams [#windowparams]

```text
WindowParams windowParams
```

源码初值：未显式赋值

多窗口属性

<a id="aa0f5eb36b29d6b3ec313acd71a9c987a"></a>

### disableTextOperations [#disabletextoperations]

```text
boolean disableTextOperations
```

源码初值：false

是否关闭 ``insertText``与``updateText`` 操作权限

<a id="aae3f8b8816661dbb74ca6137c9f37808"></a>

### modulesOrigin [#modulesorigin]

```text
String modulesOrigin
```

源码初值：未显式赋值

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

<a id="a98a34291ea2338c65c9e1ffa311aafa2"></a>

### optimizeOptions [#optimizeoptions]

```text
RoomOptimizeOptions optimizeOptions
```

源码初值：未显式赋值

白板渲染优化配置项。

<a id="addd3da5b2adab7f7b78b435af95fe42b"></a>

### appliancePluginOptions [#appliancepluginoptions]

```text
AppliancePluginOptions appliancePluginOptions
```

源码初值：未显式赋值

本地绘制插件参数，extras 为配置嵌套层；与启用开关配合使用。

<a id="a945b25c82203df4a7da5b4a6292bea3f"></a>

### disableInitialStateCallback [#disableinitialstatecallback]

```text
boolean disableInitialStateCallback
```

源码初值：false

是否禁止初始化时的回调

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

<a id="ada87eefb4b25310cfa6df81038417f58"></a>

### RoomParams() [#roomparams]

<ApiSignature>

RoomParams(String uuid, String roomToken, String uid)

</ApiSignature>

初始化房间配置参数。

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

房间 UUID， 即房间唯一标识符。传入的房间 UUID 必须和生成 [Room](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room) Token 时填入的房间 UUID 一致。

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

用于鉴权的 [Room](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room) Token。

</Parameter>
<Parameter name="uid">

自从 v2.15.0。用户唯一标识符，字符串格式，长度不能超过 1024 字节。如果你使用 2.15.0 及之后版本的 SDK，必须传入该参数。 请确保同一房间内每个用户 `uid` 的唯一性。

</Parameter>
</ParameterList>

<a id="a5aa8c28b510f899e97cf2b26c56e5f48"></a>

### RoomParams() [#roomparams-1]

<ApiSignature>

RoomParams(String uuid, String roomToken, String uid, MemberInformation memberInfo)

</ApiSignature>

初始化房间配置参数并传入用户信息。

<a id="弃用"></a>

:::error[弃用:]
该方法已经废弃。请使用 [`RoomParams`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params#a625545247367efb54b7d799dd19bffc2)[3/3]。
:::

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

房间 UUID， 即房间唯一标识符。传入的房间 UUID 必须和生成 [Room](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room) Token 时填入的房间 UUID 一致。

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

用于鉴权的 [Room](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room) Token。

</Parameter>
<Parameter name="uid">

自从 v2.15.0。用户唯一标识符，字符串格式，长度不能超过 1024 字节。如果你使用 2.15.0 及之后版本的 SDK，必须传入该参数。 请确保同一房间内每个用户 `uid` 的唯一性。

</Parameter>
<Parameter name="memberInfo">

自定义用户信息，详见 [`MemberInformation`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-member-information)。

</Parameter>
</ParameterList>

<a id="a625545247367efb54b7d799dd19bffc2"></a>

### RoomParams() [#roomparams-2]

<ApiSignature>

RoomParams(String uuid, String roomToken, String uid, Object userPayload)

</ApiSignature>

初始化房间配置参数并传入自定义的用户信息。

:::info[自从]
2.0.0
:::

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

房间 UUID， 即房间唯一标识符。传入的房间 UUID 必须和生成 [Room](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room) Token 时填入的房间 UUID 一致。

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

用于鉴权的 [Room](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room) Token。

</Parameter>
<Parameter name="uid">

自从 v2.15.0。用户唯一标识符，字符串格式，长度不能超过 1024 字节。如果你使用 2.15.0 及之后版本的 SDK，必须传入该参数。 请确保同一房间内每个用户 `uid` 的唯一性。

</Parameter>
<Parameter name="userPayload">

自定义用户信息，必须为 [`WhiteObject`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-white-object) 子类。

</Parameter>
</ParameterList>

<a id="a7b068e0e3ab5e20b3ba216d2e6156124"></a>

### getRegion() [#getregion]

<ApiSignature>

Region getRegion()

</ApiSignature>

获取设置的数据中心。

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

设置的数据中心，详见 [`Region`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/enumcom-1-1herewhite-1-1sdk-1-1domain-1-1-region)。

<a id="affd817d704b87cee8c9aa38697d459c7"></a>

### setRegion() [#setregion]

<ApiSignature>

void setRegion(Region region)

</ApiSignature>

设置数据中心。

:::info[注解]
- 该方法设置的数据中心必须与要加入的互动白板实时房间所在数据中心一致，否则无法加入房间。
- 该方法与 [`WhiteSdkConfiguration`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-white-sdk-configuration) 类中的 [`setRegion`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-white-sdk-configuration#a26095c960c0c25f4e5d07ac7dcea3b9d) 方法作用相同，两个方法只需要调用其中的一个。如果同时调用，该方法会覆盖 [`WhiteSdkConfiguration`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-white-sdk-configuration) 类中的 [`setRegion`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-white-sdk-configuration#a26095c960c0c25f4e5d07ac7dcea3b9d)。
:::

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

数据中心，详见 [`Region`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/enumcom-1-1herewhite-1-1sdk-1-1domain-1-1-region)。

</Parameter>
</ParameterList>

<a id="a46ee2c4da1611653b0d20e5080bc7636"></a>

### isWritable() [#iswritable]

<ApiSignature>

boolean isWritable()

</ApiSignature>

获取用户是否以互动模式加入白板房间。

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

用户是否以互动模式加入白板房间：

- `true`：以互动模式加入白板房间，即具有读写权限。
- `false`：以订阅模式加入白板房间，即具有只读权限。

<a id="a9dbc3e05cc1229492c3f91ce48b305cd"></a>

### setWritable() [#setwritable]

<ApiSignature>

void setWritable(boolean writable)

</ApiSignature>

设置用户是否以互动模式加入白板房间。

用户可以以以下模式加入互动白板实时房间：

- 互动模式：对白板具有读写权限，会出现在房间的成员列表中，对其他用户可见。
- 订阅模式：对白板具有只读权限，不会出现在房间的成员列表中，对其他用户不可见。

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

用户是否以互动模式加入白板房间：

- `true`：（默认）以互动模式加入白板房间。
- `false`：以订阅模式加入白板房间。

</Parameter>
</ParameterList>

<a id="a35f2724130ce493f7bbbdaa8665e28de"></a>

### getDisableEraseImage() [#getdisableeraseimage]

<ApiSignature>

boolean getDisableEraseImage()

</ApiSignature>

获取是否关闭橡皮擦擦除图片功能。

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

是否关闭橡皮擦擦除图片功能：

- `true`：橡皮擦不可以擦除图片。
- `false`：橡皮擦可以擦除图片。

<a id="a580315c5bf3976be29a97acb90261331"></a>

### setDisableEraseImage() [#setdisableeraseimage]

<ApiSignature>

void setDisableEraseImage(boolean disableEraseImage)

</ApiSignature>

设置是否关闭橡皮擦擦除图片功能。

默认情况下，橡皮擦可以擦除白板上的所有内容，包括图片。你可以调用 `setDisableEraseImage(true)` 设置橡皮擦不能擦除图片。

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

是否关闭橡皮擦擦除图片功能：

- `true`：橡皮擦不可以擦除图片。
- `false`：（默认）橡皮擦可以擦除图片。

</Parameter>
</ParameterList>

<a id="a3f7054556c1f72ac03f754538b55e5c0"></a>

### setTimeout() [#settimeout]

<ApiSignature>

void setTimeout(long timeout, TimeUnit timeUnit)

</ApiSignature>

设置加入房间的超时时间。

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

超时时长，默认值为 45000 毫秒。

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

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

</Parameter>
</ParameterList>

<a id="a02b980237de8d8e9d91b4ebc5bf63887"></a>

### isDisableDeviceInputs() [#isdisabledeviceinputs]

<ApiSignature>

boolean isDisableDeviceInputs()

</ApiSignature>

获取是否禁止白板工具响应用户输入。

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

是否禁止白板工具响应用户输入：

- `true`：禁止白板工具响应用户输入。
- `false`：允许白板工具响应用户输入。

<a id="a0be8c01908f2826302fb50ce5c98c0e1"></a>

### setDisableDeviceInputs() [#setdisabledeviceinputs]

<ApiSignature>

void setDisableDeviceInputs(boolean disableDeviceInputs)

</ApiSignature>

开启/禁止白板工具响应用户输入。

:::info[自从]
2.5.0
:::

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

是否禁止白板工具响应用户输入：

- `true`：禁止白板工具响应用户输入。
- `false`：（默认）允许白板工具响应用户输入。

</Parameter>
</ParameterList>

<a id="a94cc0f493d873a3ba55caffb70b0f0cf"></a>

### isDisableOperations() [#isdisableoperations]

<ApiSignature>

boolean isDisableOperations()

</ApiSignature>

获取是否禁止白板响应用户的操作。

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

是否禁止白板响应用户的操作。

- `true`：禁止白板响应用户的操作。
- `false`：允许白板响应用户的操作。

<a id="acf4a08b32a536804e91c4dd22f476a04"></a>

### setDisableOperations() [#setdisableoperations]

<ApiSignature>

void setDisableOperations(boolean disableOperations)

</ApiSignature>

允许/禁止白板响应用户任何操作。

:::info[自从]
2.5.0
:::

<a id="弃用-1"></a>

:::error[弃用:]
该方法已废弃。请使用 [`setDisableDeviceInputs`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params#a0be8c01908f2826302fb50ce5c98c0e1) 和 [`setDisableCameraTransform`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params#a891549135084e1b843281a099c2c0561)。
:::

禁止白板响应用户任何操作后，用户无法使用白板工具输入内容，也无法对白板进行视角缩放和视角移动。

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

是否禁止白板响应用户的操作：

- `true`：禁止白板响应用户的操作。
- `false`：（默认）允许白板响应用户的操作。

</Parameter>
</ParameterList>

<a id="ac4ed37a313c3087cb24170ca6435ff2f"></a>

### isDisableBezier() [#isdisablebezier]

<ApiSignature>

boolean isDisableBezier()

</ApiSignature>

获取是否关闭贝塞尔曲线优化。

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

是否关闭贝塞尔曲线优化：

- `true`: 关闭贝塞尔曲线优化。
- `false`: 开启贝塞尔曲线优化。

<a id="a6190fcaaf5dbea2b394cf5c73c9fa411"></a>

### setDisableBezier() [#setdisablebezier]

<ApiSignature>

void setDisableBezier(boolean disableBezier)

</ApiSignature>

设置是否关闭贝塞尔曲线优化。

:::info[自从]
2.5.0
:::

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

是否关闭贝塞尔曲线优化：

- `true`: 关闭贝塞尔曲线优化。
- `false`: （默认）开启贝塞尔曲线优化。

</Parameter>
</ParameterList>

<a id="ade13f69996cb32fd94120c46d8b0af0c"></a>

### isDisableCameraTransform() [#isdisablecameratransform]

<ApiSignature>

boolean isDisableCameraTransform()

</ApiSignature>

获取是否禁止本地用户操作白板视角。

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

是否禁止本地用户操作白板视角：

- `true`：禁止本地用户操作白板视角。
- `false`：允许本地用户操作白板视角。

<a id="a891549135084e1b843281a099c2c0561"></a>

### setDisableCameraTransform() [#setdisablecameratransform]

<ApiSignature>

void setDisableCameraTransform(boolean disableCameraTransform)

</ApiSignature>

禁止/允许本地用户操作白板的视角，包括缩放和移动视角。

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

是否禁止本地用户操作白板视角：

- `true`：禁止本地用户操作白板视角。
- `false`：（默认）允许本地用户操作白板视角。

</Parameter>
</ParameterList>

<a id="a3b6b4fd252c282c685e217109eeb60c5"></a>

### isDisableNewPencil() [#isdisablenewpencil]

<ApiSignature>

boolean isDisableNewPencil()

</ApiSignature>

获取是否关闭新铅笔工具。

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

是否关闭新铅笔工具：

- `true`: 关闭新铅笔工具。
- `false`: 开启新铅笔工具。

<a id="a49c41b2dfd21f764d6e3ff63ca09f19d"></a>

### setDisableNewPencil() [#setdisablenewpencil]

<ApiSignature>

void setDisableNewPencil(boolean disableNewPencil)

</ApiSignature>

关闭/开启新铅笔工具。

:::info[自从]
2.12.2
:::

:::info[注解]
- 在 2.12.2 版本中，`setDisableNewPencil` 的默认值为 `false`，自 2.12.3 版本起，`setDisableNewPencil` 的默认值改为 `true`。
- 为正常显示笔迹，在开启新铅笔工具前，请确保该房间内的所有用户使用如下 SDK：

  - Android SDK 2.12.3 版或之后
  - iOS SDK 2.12.3 版或之后
  - Web SDK 2.12.5 版或之后
:::

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

是否关闭新铅笔工具：

- `true`: （默认）关闭新铅笔工具。关闭后，SDK 对铅笔工具（`pencil`）应用旧版笔迹平滑算法。
- `false`: 开启新铅笔工具。开启后，SDK 对铅笔工具应用新版笔迹平滑算法，使书写笔迹更加流畅自然，并带有笔锋效果。

</Parameter>
</ParameterList>

<a id="afd4fb99429b98be70014888b7a9286b6"></a>

### getCameraBound() [#getcamerabound]

<ApiSignature>

CameraBound getCameraBound()

</ApiSignature>

获取视角边界。

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

视角边界。

<a id="a068607b4928ceef7265db739fa4e3cb8"></a>

### setCameraBound() [#setcamerabound]

<ApiSignature>

void setCameraBound(CameraBound cameraBound)

</ApiSignature>

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

:::info[自从]
2.5.0
:::

<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)。

</Parameter>
</ParameterList>

<a id="a9b6f02c4298339cc91ce8f88576f3049"></a>

### getUserPayload() [#getuserpayload]

<ApiSignature>

Object getUserPayload()

</ApiSignature>

获取自定义用户信息。

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

自定义用户信息。

<a id="a17c8130727ea71cdeca6c3c2362cc0b7"></a>

### setUserPayload() [#setuserpayload]

<ApiSignature>

void setUserPayload(Object userPayload)

</ApiSignature>

自定义用户信息。

:::info[自从]
2.0.0
:::

你可以在 `userPayload` 中传入自定义的用户信息，例如用户ID，昵称和头像，然后调用此方法将信息发送给应用程序。

:::info[注解]
为确保传入的 `userPayload` 格式正确，必须为 [`WhiteObject`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-white-object) 的子类。
:::

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

自定义的用户信息，必须为 key-value 结构，例如，`"avatar", "https://example.com/user.png")`。

</Parameter>
</ParameterList>

<a id="abb2f190ee04cbfcb95001ee3cd29c1d1"></a>

### getMemberInfo() [#getmemberinfo]

<ApiSignature>

MemberInformation getMemberInfo()

</ApiSignature>

获取自定义的用户信息。

<a id="弃用-2"></a>

:::error[弃用:]
该方法已废弃。请使用 [`getUserPayload`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params#a9b6f02c4298339cc91ce8f88576f3049)。
:::

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

自定义用户信息，详见 [`MemberInformation`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-member-information)。

<a id="ac3d609dd67f195eb947fa4a19abcfa37"></a>

### setMemberInfo() [#setmemberinfo]

<ApiSignature>

void setMemberInfo(MemberInformation memberInfo)

</ApiSignature>

自定义用户信息。

<a id="弃用-3"></a>

:::error[弃用:]
该方法已废弃。请使用 [`getUserPayload`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room-params#a9b6f02c4298339cc91ce8f88576f3049)。
:::

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

用户信息，详见 [`MemberInformation`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-member-information)。

</Parameter>
</ParameterList>

<a id="a0f9c1507ca1f9e7c35d0b11f6801eb60"></a>

### getUuid() [#getuuid]

<ApiSignature>

String getUuid()

</ApiSignature>

获取房间 UUID。

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

房间 UUID，即房间的唯一标识符。

<a id="a59c71a74ef95003eb7fe1a3a1783c290"></a>

### setUuid() [#setuuid]

<ApiSignature>

void setUuid(String uuid)

</ApiSignature>

设置房间 UUID。

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

房间 UUID，即房间的唯一标识符。

</Parameter>
</ParameterList>

<a id="a5752788874ff70d8e732c3105be828fb"></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={"返回值-12"}>返回值</h4>

[Room](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1-room) Token。

<a id="a6630be6ab3d486467c80ae7d8ee2c4a8"></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。

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

用于鉴权的 [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 的房间 UUID 必须和上面传入的房间 UUID 一致。

</Parameter>
</ParameterList>

<a id="a1e14e97d7d1b5055ecf3d819ad3920af"></a>

### getUndoCacheScenesCount() [#getundocachescenescount]

<ApiSignature>

Integer getUndoCacheScenesCount()

</ApiSignature>

撤销/重做保留的场景缓存数量；在入房前配置，未设置时交由内嵌 Web SDK 决定。

<a id="af271a742fcbce32a60b15db9871a63c0"></a>

### setUndoCacheScenesCount() [#setundocachescenescount]

<ApiSignature>

void setUndoCacheScenesCount(Integer undoCacheScenesCount)

</ApiSignature>

撤销/重做保留的场景缓存数量；在入房前配置，未设置时交由内嵌 Web SDK 决定。

<a id="a4a60b886a9e4149256d78df36a51be4c"></a>

### getWindowParams() [#getwindowparams]

<ApiSignature>

WindowParams getWindowParams()

</ApiSignature>

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

<a id="a8d2a306a66f7f2a7f4f3d32a987b8f63"></a>

### setWindowParams() [#setwindowparams]

<ApiSignature>

void setWindowParams(WindowParams windowParams)

</ApiSignature>

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

<a id="a4c580bf300660445105a94e18217108a"></a>

### isDisableTextOperations() [#isdisabletextoperations]

<ApiSignature>

boolean isDisableTextOperations()

</ApiSignature>

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

<a id="a638a9fe6f428d2821f0b3a07de0bed71"></a>

### setDisableTextOperations() [#setdisabletextoperations]

<ApiSignature>

void setDisableTextOperations(boolean disableTextOperations)

</ApiSignature>

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

<a id="ad5a9e486b8d4729382f3e4b4d8895859"></a>

### isUseNativeWebSocket() [#isusenativewebsocket]

<ApiSignature>

boolean isUseNativeWebSocket()

</ApiSignature>

获取是否开启全链路加速功能。

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

是否开启全链路加速功能：

- `true`：开启。
- `false`：关闭。

<a id="a366cbea6a84e8c73e8425153fd40fe16"></a>

### setUseNativeWebSocket() [#setusenativewebsocket]

<ApiSignature>

void setUseNativeWebSocket(boolean nativeWebSocket)

</ApiSignature>

开启全链路加速功能。

Agora 互动白板服务集成了 Agora 全链路加速（FPA）服务。 集成 Agora Whiteboard SDK 后，你只需调用 `setUseNativeWebSocket(true)`，即可在互动白板应用中开启全链路加速服务，提升传输质量。

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

是否开启全链路加速：

- `true`：开启全链路加速。
- `false`：（默认）关闭全链路加速。

</Parameter>
</ParameterList>

<a id="a3f7bff7cbb7a7f7fb5e7b185a9bd8eac"></a>

### isUsingFloatBar() [#isusingfloatbar]

<ApiSignature>

boolean isUsingFloatBar()

</ApiSignature>

获取浮动条功能是否已开启。

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

浮动条功能是否已开启：

- `true`：开启。
- `false`：关闭。

<a id="a62a0c199916003f9745a509081fc64ab"></a>

### setUsingFloatBar() [#setusingfloatbar]

<ApiSignature>

void setUsingFloatBar(boolean floatBar)

</ApiSignature>

设置是否开启开启浮动条功能。

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

是否开启浮动条：

- `true`：开启浮动条功能。
- `false`：（默认）关闭浮动条功能。

</Parameter>
</ParameterList>

<a id="aa8e1d1c2aa0e00f942d91c01e1bc751a"></a>

### getModulesOrigin() [#getmodulesorigin]

<ApiSignature>

String getModulesOrigin()

</ApiSignature>

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

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

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

<a id="ab55b1761e938355bb3fecf6ea3418bb5"></a>

### setModulesOrigin() [#setmodulesorigin]

<ApiSignature>

void setModulesOrigin(String modulesOrigin)

</ApiSignature>

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

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

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

</Parameter>
</ParameterList>

白板渲染优化配置项。详见 [`RoomOptimizeOptions`](/zh-CN/api-reference/whiteboard/whiteboard-sdk/android/classcom-1-1herewhite-1-1sdk-1-1domain-1-1-room-optimize-options)。

<a id="abdf298203235b04c112f30e453f0e748"></a>

### getOptimizeOptions() [#getoptimizeoptions]

<ApiSignature>

RoomOptimizeOptions getOptimizeOptions()

</ApiSignature>

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

<a id="a31d0567336c0fd36819ecc7091d69663"></a>

### setOptimizeOptions() [#setoptimizeoptions]

<ApiSignature>

void setOptimizeOptions(RoomOptimizeOptions optimizeOptions)

</ApiSignature>

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

<a id="a6623f523165cea86c4d0b91595c8f62b"></a>

### isDisableInitialStateCallback() [#isdisableinitialstatecallback]

<ApiSignature>

boolean isDisableInitialStateCallback()

</ApiSignature>

获取是否禁止初始化状态回调。

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

方法返回值，类型为 boolean。

<a id="ad400a36cae5a169fbd2e3b50df6d8e50"></a>

### setDisableInitialStateCallback() [#setdisableinitialstatecallback]

<ApiSignature>

void setDisableInitialStateCallback(boolean disableInitialStateCallback)

</ApiSignature>

禁止初始化状态回调

#### 参数 [#参数]

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

- `true`：禁止。 - `false`：（默认）不禁止。

</Parameter>
</ParameterList>

<a id="ab93b46b37acf427c12c74d4e7cfd192e"></a>

### getAppliancePluginOptions() [#getappliancepluginoptions]

<ApiSignature>

AppliancePluginOptions getAppliancePluginOptions()

</ApiSignature>

本地绘制插件参数，extras 为配置嵌套层；与启用开关配合使用。

<a id="a5121f17e30594201381fec68dbd02250"></a>

### setAppliancePluginOptions() [#setappliancepluginoptions]

<ApiSignature>

void setAppliancePluginOptions(AppliancePluginOptions appliancePluginOptions)

</ApiSignature>

本地绘制插件参数，extras 为配置嵌套层；与启用开关配合使用。