# RoomOptions interface 参考 (/zh-CN/api-reference/whiteboard/whiteboard-sdk/harmonyos/interface-room-options)

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

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

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

适用版本：**@shengwang/whiteboard 0.2.11**。

buildRoomOptions(options) 的返回结构，包含 uuid/isWritable 等 Bridge 入房字段；可接收函数返回值，不是业务 joinRoom() 入口。

当前版本未从 SDK 包入口单独导出此类型名；通过所述配置、参数或返回值使用其结构。

## 类型结构（源码声明） [#类型结构源码声明]

下方源码文件的 export 声明不等同于 SDK 包入口导出；业务导入方式以上方说明为准。

```text
export interface RoomOptions
```

| [uuid](/zh-CN/api-reference/whiteboard/whiteboard-sdk/harmonyos/interface-room-options#a1f5f52b582ee4a85efefbc847eeeb560) | `uuid: string` |
| --- | --- |
| [roomToken](/zh-CN/api-reference/whiteboard/whiteboard-sdk/harmonyos/interface-room-options#a41ec0d7a6c3b3ed338fe905d8e71a11e) | `roomToken: string` |
| [uid](/zh-CN/api-reference/whiteboard/whiteboard-sdk/harmonyos/interface-room-options#a3ca2535afab8303a634d44583a19f08a) | `uid: string` |
| [region](/zh-CN/api-reference/whiteboard/whiteboard-sdk/harmonyos/interface-room-options#a114d1f449334c9b14cfdd418d193aaa0) | `region: Region` |
| [userPayload](/zh-CN/api-reference/whiteboard/whiteboard-sdk/harmonyos/interface-room-options#adca59c0629732ee531040862b83ead73) | `userPayload?: object` |
| [isWritable](/zh-CN/api-reference/whiteboard/whiteboard-sdk/harmonyos/interface-room-options#a901fd24a9e2a954ec8d6089f90b1ba60) | `isWritable?: boolean` |
| [disableDeviceInputs](/zh-CN/api-reference/whiteboard/whiteboard-sdk/harmonyos/interface-room-options#aa3b1296eb68e10b87fa78efb803b45b4) | `disableDeviceInputs?: boolean` |
| [disableOperations](/zh-CN/api-reference/whiteboard/whiteboard-sdk/harmonyos/interface-room-options#a4824d637f691522b1e8c2afa08aab768) | `disableOperations?: boolean` |
| [floatBar](/zh-CN/api-reference/whiteboard/whiteboard-sdk/harmonyos/interface-room-options#a75f7fae7a1582566d170d7af811b1cad) | `floatBar?: boolean` |
| [disableCameraTransform](/zh-CN/api-reference/whiteboard/whiteboard-sdk/harmonyos/interface-room-options#ab80b45140851b50a9ca1cda97a229c63) | `disableCameraTransform?: boolean` |
| [timeout](/zh-CN/api-reference/whiteboard/whiteboard-sdk/harmonyos/interface-room-options#ab6467e0e9d5848ba9d5ecfb7d3757865) | `timeout?: number` |
| [undoCacheScenesCount](/zh-CN/api-reference/whiteboard/whiteboard-sdk/harmonyos/interface-room-options#ad21ebe1fb1fc331cdbcb6a209e066be0) | `undoCacheScenesCount?: number` |
| [windowParams](/zh-CN/api-reference/whiteboard/whiteboard-sdk/harmonyos/interface-room-options#ae0e7ceea676dd945847d394ec57111a8) | `windowParams?: WindowParams` |
| [appliancePluginOptions](/zh-CN/api-reference/whiteboard/whiteboard-sdk/harmonyos/interface-room-options#a2b315d6a00747b070a1611288bbad5a4) | `appliancePluginOptions?: AppliancePluginOptions` |

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

<a id="a1f5f52b582ee4a85efefbc847eeeb560"></a>

### uuid [#uuid]

```text
uuid: string
```

类型成员，必填性和返回类型以声明为准。

<a id="a41ec0d7a6c3b3ed338fe905d8e71a11e"></a>

### roomToken [#roomtoken]

```text
roomToken: string
```

类型成员，必填性和返回类型以声明为准。

<a id="a3ca2535afab8303a634d44583a19f08a"></a>

### uid [#uid]

```text
uid: string
```

类型成员，必填性和返回类型以声明为准。

<a id="a114d1f449334c9b14cfdd418d193aaa0"></a>

### region [#region]

```text
region: Region
```

类型成员，必填性和返回类型以声明为准。

<a id="adca59c0629732ee531040862b83ead73"></a>

### userPayload [#userpayload]

```text
userPayload?: object
```

类型成员，必填性和返回类型以声明为准。

<a id="a901fd24a9e2a954ec8d6089f90b1ba60"></a>

### isWritable [#iswritable]

```text
isWritable?: boolean
```

类型成员，必填性和返回类型以声明为准。

<a id="aa3b1296eb68e10b87fa78efb803b45b4"></a>

### disableDeviceInputs [#disabledeviceinputs]

```text
disableDeviceInputs?: boolean
```

类型成员，必填性和返回类型以声明为准。

<a id="a4824d637f691522b1e8c2afa08aab768"></a>

### disableOperations [#disableoperations]

```text
disableOperations?: boolean
```

类型成员，必填性和返回类型以声明为准。

<a id="a75f7fae7a1582566d170d7af811b1cad"></a>

### floatBar [#floatbar]

```text
floatBar?: boolean
```

类型成员，必填性和返回类型以声明为准。

<a id="ab80b45140851b50a9ca1cda97a229c63"></a>

### disableCameraTransform [#disablecameratransform]

```text
disableCameraTransform?: boolean
```

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

<a id="ab6467e0e9d5848ba9d5ecfb7d3757865"></a>

### timeout [#timeout]

```text
timeout?: number
```

类型成员，必填性和返回类型以声明为准。

<a id="ad21ebe1fb1fc331cdbcb6a209e066be0"></a>

### undoCacheScenesCount [#undocachescenescount]

```text
undoCacheScenesCount?: number
```

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

<a id="ae0e7ceea676dd945847d394ec57111a8"></a>

### windowParams [#windowparams]

```text
windowParams?: WindowParams
```

类型成员，必填性和返回类型以声明为准。

<a id="a2b315d6a00747b070a1611288bbad5a4"></a>

### appliancePluginOptions [#appliancepluginoptions]

```text
appliancePluginOptions?: AppliancePluginOptions
```

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