RoomOptions interface 参考

适用版本：@shengwang/whiteboard 0.2.11。

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

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

类型结构（源码声明）

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

export interface RoomOptions

uuid	uuid: string
roomToken	roomToken: string
uid	uid: string
region	region: Region
userPayload	userPayload?: object
isWritable	isWritable?: boolean
disableDeviceInputs	disableDeviceInputs?: boolean
disableOperations	disableOperations?: boolean
floatBar	floatBar?: boolean
disableCameraTransform	disableCameraTransform?: boolean
timeout	timeout?: number
undoCacheScenesCount	undoCacheScenesCount?: number
windowParams	windowParams?: WindowParams
appliancePluginOptions	appliancePluginOptions?: AppliancePluginOptions

变量说明

uuid

uuid: string

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

roomToken

roomToken: string

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

uid

uid: string

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

region

region: Region

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

userPayload

userPayload?: object

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

isWritable

isWritable?: boolean

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

disableDeviceInputs

disableDeviceInputs?: boolean

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

disableOperations

disableOperations?: boolean

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

floatBar

floatBar?: boolean

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

disableCameraTransform

disableCameraTransform?: boolean

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

timeout

timeout?: number

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

undoCacheScenesCount

undoCacheScenesCount?: number

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

windowParams

windowParams?: WindowParams

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

appliancePluginOptions

appliancePluginOptions?: AppliancePluginOptions

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