WhiteboardOptions interface 参考
- HarmonyOS
更新时间不可用
详细描述
适用版本：@shengwang/whiteboard 0.2.11。
Whiteboard 组件的初始化和入房配置。
可从 @shengwang/whiteboard 直接导入 WhiteboardOptions。仅用于类型声明，不能作为构造函数调用 new。
类型结构（源码声明）
下方源码文件的 export 声明不等同于 SDK 包入口导出；业务导入方式以上方说明为准。
export interface WhiteboardOptions| appIdentifier | appIdentifier: string |
|---|---|
| userCursor | userCursor?: boolean |
| userPayload | userPayload?: object |
| useMultiViews | useMultiViews?: boolean |
| enableAppliancePlugin | enableAppliancePlugin?: boolean |
| appliancePluginOptions | appliancePluginOptions?: AppliancePluginOptions |
| presentationAppOptions | presentationAppOptions?: PresentationAppOptions |
| slideAppOptions | slideAppOptions?: SlideAppOptions |
| localLogOptions | localLogOptions?: LocalLogOptions |
| windowParams | windowParams?: WindowParams |
| roomUuid | roomUuid: string |
| roomToken | roomToken: string |
| uid | uid: string |
| region | region: Region |
| writable | writable?: boolean |
| disableCameraTransform | disableCameraTransform?: boolean |
| disableDeviceInputs | disableDeviceInputs?: boolean |
| disableOperations | disableOperations?: boolean |
| floatBar | floatBar?: boolean |
| timeout | timeout?: number |
| undoCacheScenesCount | undoCacheScenesCount?: number |
| callbacks | callbacks?: WhiteboardCallbacks |
| backgroundImageLoadOptions | backgroundImageLoadOptions?: BackgroundImageLoadOptions |
| dynamicConfig | dynamicConfig?: DynamicConfigOptions |
变量说明
appIdentifier
appIdentifier: string类型成员，必填性和返回类型以声明为准。
userCursor
userCursor?: boolean类型成员，必填性和返回类型以声明为准。
userPayload
userPayload?: object类型成员，必填性和返回类型以声明为准。
useMultiViews
useMultiViews?: boolean类型成员，必填性和返回类型以声明为准。
enableAppliancePlugin
enableAppliancePlugin?: boolean启用内嵌高性能绘制插件，默认 false；无需单独安装 npm 插件，同房间各端应一致开启。
appliancePluginOptions
appliancePluginOptions?: AppliancePluginOptions本地绘制插件参数，extras 为配置嵌套层；与启用开关配合使用。
presentationAppOptions
presentationAppOptions?: PresentationAppOptions本地内置 Presentation 配置，初始化 SDK 前传入。
slideAppOptions
slideAppOptions?: SlideAppOptions类型成员，必填性和返回类型以声明为准。
localLogOptions
localLogOptions?: LocalLogOptions本地日志配置；显式开启 enabled 才生效，enabledUpload 只控制上传。
windowParams
windowParams?: WindowParams类型成员，必填性和返回类型以声明为准。
roomUuid
roomUuid: string类型成员，必填性和返回类型以声明为准。
roomToken
roomToken: string类型成员，必填性和返回类型以声明为准。
uid
uid: string类型成员，必填性和返回类型以声明为准。
region
region: Region类型成员，必填性和返回类型以声明为准。
writable
writable?: boolean类型成员，必填性和返回类型以声明为准。
disableCameraTransform
disableCameraTransform?: boolean禁止设备输入引发的视角变化；不会禁止程序调用支持的视角接口。
disableDeviceInputs
disableDeviceInputs?: boolean类型成员，必填性和返回类型以声明为准。
disableOperations
disableOperations?: boolean类型成员，必填性和返回类型以声明为准。
floatBar
floatBar?: boolean类型成员，必填性和返回类型以声明为准。
timeout
timeout?: number类型成员，必填性和返回类型以声明为准。
undoCacheScenesCount
undoCacheScenesCount?: number撤销/重做保留的场景缓存数量；在入房前配置，未设置时交由内嵌 Web SDK 决定。
callbacks
callbacks?: WhiteboardCallbacks类型成员，必填性和返回类型以声明为准。
backgroundImageLoadOptions
backgroundImageLoadOptions?: BackgroundImageLoadOptions背景图片加载重试和超时配置，见 BackgroundImageLoadOptions。
公开变量
dynamicConfig
dynamicConfig?: DynamicConfigOptionsregion → 当前平台配置 URL 映射。未映射 region 或读取失败使用本地参数。不要传配置平台网页地址；详见动态配置接入文档。