类型列表

Whiteboard HarmonyOS SDK 0.2.11 公共 API 参考。

内嵌运行时：white-web-sdk 2.16.59、window-manager 1.0.25、appliance-plugin 1.1.45、app-slide 0.2.108。

通过 ohpm install @shengwang/whiteboard@0.2.11 集成；组件入房成功后使用 WhiteboardController。

**导入类型名与使用配置是两件事：**包入口导出类型可从包名直接 import；未单独导出的嵌套配置仍可通过公开配置字段填写。接口和类型别名用于描述结构，不能 new；未导出的枚举对象需另行注意调用限制。

类型/入口	用途与使用位置	导入方式
WhiteboardController 类	房间操作控制器；由 Whiteboard 组件绑定，在 onRoomReady 后调用房间方法。	可从 @shengwang/whiteboard 直接导入 WhiteboardController。
BackgroundImageSource 类型别名	背景图来源的字符串联合类型：appliance。	可从 @shengwang/whiteboard 直接导入 BackgroundImageSource。仅用于类型声明，不能作为构造函数调用 new。
BackgroundImageLoadEvent 接口	背景图加载结果事件数据。	可从 @shengwang/whiteboard 直接导入 BackgroundImageLoadEvent。仅用于类型声明，不能作为构造函数调用 new。
ApplianceInitLoadingChangeEvent 接口	教具初始化进度事件数据，status 为 start/success/timeout/error。	可从 @shengwang/whiteboard 直接导入 ApplianceInitLoadingChangeEvent。仅用于类型声明，不能作为构造函数调用 new。
WhiteboardCallbacks 类	房间、课件、日志及初始化事件回调；实际传给 Whiteboard 组件的 callbacks 参数。	可从 @shengwang/whiteboard 直接导入 WhiteboardCallbacks。
Region 枚举	白板服务数据中心；初始化和入房时与房间所在区域一致。	可从 @shengwang/whiteboard 直接导入 Region。导入后可访问枚举成员。
MemberState 接口	白板工具状态，包含当前教具、颜色、线宽和文本等属性。	可从 @shengwang/whiteboard 直接导入 MemberState。仅用于类型声明，不能作为构造函数调用 new。
RoomMember 接口	房间互动用户及其工具状态、用户信息结构。	可从 @shengwang/whiteboard 直接导入 RoomMember。仅用于类型声明，不能作为构造函数调用 new。
Appliance 枚举	白板工具枚举，用于 MemberState.currentApplianceName 和 Controller 工具设置。	可从 @shengwang/whiteboard 直接导入 Appliance。导入后可访问枚举成员。
ShapeType 枚举	几何图形类型枚举，用于形状工具配置。	可从 @shengwang/whiteboard 直接导入 ShapeType。导入后可访问枚举成员。
EventEntry 接口	自定义事件回调的数据结构。	可从 @shengwang/whiteboard 直接导入 EventEntry。仅用于类型声明，不能作为构造函数调用 new。
RoomDisconnectError 接口	房间断开错误回调的数据结构。	可从 @shengwang/whiteboard 直接导入 RoomDisconnectError。仅用于类型声明，不能作为构造函数调用 new。
RoomKickedReason 类型别名	房间被踢原因的字符串类型。	可从 @shengwang/whiteboard 直接导入 RoomKickedReason。仅用于类型声明，不能作为构造函数调用 new。
RoomPhase 枚举	房间连接阶段枚举。	可从 @shengwang/whiteboard 直接导入 RoomPhase。导入后可访问枚举成员。
BroadcastState 接口	房间视角模式及主播状态。	可从 @shengwang/whiteboard 直接导入 BroadcastState。仅用于类型声明，不能作为构造函数调用 new。
CameraState 接口	白板相机状态，通过 RoomState.cameraState 读取。	当前版本未从 SDK 包入口单独导出此类型名；通过所述配置、参数或返回值使用其结构。
RoomState 接口	房间状态，继承 SharedState 的共享状态字段；状态回调通常只含变化字段。	可从 @shengwang/whiteboard 直接导入 RoomState。仅用于类型声明，不能作为构造函数调用 new。
SharedState 接口	RoomState 的继承结构；roomMembers、sceneState、windowBoxState、pageState、cameraState 均可通过 RoomState 读取。	当前版本未从 SDK 包入口单独导出此类型名；通过所述配置、参数或返回值使用其结构。
GlobalState 类	房间公共全局状态。	可从 @shengwang/whiteboard 直接导入 GlobalState。
PageState 接口	MainView 页面状态，通过 RoomState.pageState 读取；index 从 0 开始。	当前版本未从 SDK 包入口单独导出此类型名；通过所述配置、参数或返回值使用其结构。
ViewMode 枚举	WhiteboardController.setViewMode(...) 和 BroadcastState.mode 引用的视角模式枚举。	当前版本未从 SDK 包入口导出此枚举对象；不能从包名导入或直接取得其枚举成员。
ImageInformation 接口	插入图片时的资源地址、唯一标识和位置信息。	可从 @shengwang/whiteboard 直接导入 ImageInformation。仅用于类型声明，不能作为构造函数调用 new。
SceneState 接口	场景状态，由 controller.getSceneState() 返回，也可通过 RoomState.sceneState 读取。	当前版本未从 SDK 包入口单独导出此类型名；通过所述配置、参数或返回值使用其结构。
Scene 接口	白板场景结构，用于场景插入及场景状态。	可从 @shengwang/whiteboard 直接导入 Scene。仅用于类型声明，不能作为构造函数调用 new。
PptPage 接口	场景中的 PPT 背景资源与尺寸。	可从 @shengwang/whiteboard 直接导入 PptPage。仅用于类型声明，不能作为构造函数调用 new。
AnimationMode 枚举	WhiteboardController.scalePptToFit(...) 引用的动画模式枚举。	当前版本未从 SDK 包入口导出此枚举对象；不能从包名导入或直接取得其枚举成员。
PresentationViewport 接口	Presentation 的本地视口配置。	可从 @shengwang/whiteboard 直接导入 PresentationViewport。仅用于类型声明，不能作为构造函数调用 new。
PresentationAppOptions 接口	内置 Presentation 的本地初始化配置。	可从 @shengwang/whiteboard 直接导入 PresentationAppOptions。仅用于类型声明，不能作为构造函数调用 new。
BuiltinAppOptions 接口	WindowParams.builtinAppOptions 的内置 App 选项。	可从 @shengwang/whiteboard 直接导入 BuiltinAppOptions。仅用于类型声明，不能作为构造函数调用 new。
WindowOriginSize 接口	MainView 或 App 的归一化参考尺寸。	可从 @shengwang/whiteboard 直接导入 WindowOriginSize。仅用于类型声明，不能作为构造函数调用 new。
PageScaleRange 接口	页面相对适配尺寸的缩放范围。	可从 @shengwang/whiteboard 直接导入 PageScaleRange。仅用于类型声明，不能作为构造函数调用 new。
WindowParams 类	多窗口入房配置；支持属性和链式 setter。	可从 @shengwang/whiteboard 直接导入 WindowParams。
WindowPrefersColorScheme 枚举	WindowParams.prefersColorScheme 及 Controller/WindowParams 的 setPrefersColorScheme(...) 引用的颜色模式枚举。	当前版本未从 SDK 包入口导出此枚举对象；不能从包名导入或直接取得其枚举成员。
WindowAppParam 接口	controller.addApp(...) 的参数结构，用于指定 App 类型、初始化选项和同步属性。	可从 @shengwang/whiteboard 直接导入 WindowAppParam。仅用于类型声明，不能作为构造函数调用 new。
WindowAppSyncAttrs 接口	queryApp/queryAllApps 返回的 App 同步属性。	可从 @shengwang/whiteboard 直接导入 WindowAppSyncAttrs。仅用于类型声明，不能作为构造函数调用 new。
CameraBound 接口	白板相机视角边界参数结构。	可从 @shengwang/whiteboard 直接导入 CameraBound。仅用于类型声明，不能作为构造函数调用 new。
AddPageParam 接口	添加多窗口 MainView 页面的参数。	可从 @shengwang/whiteboard 直接导入 AddPageParam。仅用于类型声明，不能作为构造函数调用 new。
RemovePageParam 接口	移除多窗口 MainView 页面的参数。	可从 @shengwang/whiteboard 直接导入 RemovePageParam。仅用于类型声明，不能作为构造函数调用 new。
WindowDocsEventType 类型别名	统一课件命令的字符串联合类型。	可从 @shengwang/whiteboard 直接导入 WindowDocsEventType。仅用于类型声明，不能作为构造函数调用 new。
WindowDocsEventOptions 接口	统一课件命令的目标、页码和缩放参数。	可从 @shengwang/whiteboard 直接导入 WindowDocsEventOptions。仅用于类型声明，不能作为构造函数调用 new。
WindowDocsEvent 接口	controller.dispatchDocsEvent(...) 的命令结构。	可从 @shengwang/whiteboard 直接导入 WindowDocsEvent。仅用于类型声明，不能作为构造函数调用 new。
DispatchDocsEventFailureReason 类型别名	统一课件命令被拒绝的原因字符串联合类型。	可从 @shengwang/whiteboard 直接导入 DispatchDocsEventFailureReason。仅用于类型声明，不能作为构造函数调用 new。
DispatchDocsEventAcceptedResult 接口	统一课件命令接收结果，accepted 固定为 true。	可从 @shengwang/whiteboard 直接导入 DispatchDocsEventAcceptedResult。仅用于类型声明，不能作为构造函数调用 new。
DispatchDocsEventRejectedResult 接口	统一课件命令拒绝结果，包含 accepted=false、reason 和 message。	可从 @shengwang/whiteboard 直接导入 DispatchDocsEventRejectedResult。仅用于类型声明，不能作为构造函数调用 new。
DispatchDocsEventResult 类型别名	统一课件命令接收/拒绝结果的联合类型。	可从 @shengwang/whiteboard 直接导入 DispatchDocsEventResult。仅用于类型声明，不能作为构造函数调用 new。
WindowPageStateOptions 接口	controller.getPageState(...) 的查询目标配置。	可从 @shengwang/whiteboard 直接导入 WindowPageStateOptions。仅用于类型声明，不能作为构造函数调用 new。
UnifiedPageState 接口	统一页状态；page 从 1 开始，scale 为相对适配尺寸的倍率。	可从 @shengwang/whiteboard 直接导入 UnifiedPageState。仅用于类型声明，不能作为构造函数调用 new。
UnifiedPageStateObservation 接口	统一页状态观察事件，status 为 pending 或 success。	可从 @shengwang/whiteboard 直接导入 UnifiedPageStateObservation。仅用于类型声明，不能作为构造函数调用 new。
UnifiedPageStateFailure 接口	统一课件命令异步失败事件，status 固定为 failure。	可从 @shengwang/whiteboard 直接导入 UnifiedPageStateFailure。仅用于类型声明，不能作为构造函数调用 new。
UnifiedPageStateChange 类型别名	统一页状态观察/异步失败事件的联合类型。	可从 @shengwang/whiteboard 直接导入 UnifiedPageStateChange。仅用于类型声明，不能作为构造函数调用 new。
SlideListener 接口	Slide 资源、错误和页状态回调结构；公开类型本身不代表 Controller 提供监听器注册方法。	可从 @shengwang/whiteboard 直接导入 SlideListener。仅用于类型声明，不能作为构造函数调用 new。
SlideErrorType 枚举	Slide 加载错误分类枚举。	可从 @shengwang/whiteboard 直接导入 SlideErrorType。导入后可访问枚举成员。
SDKErrorPayload 接口	SDKError.parseError(...) 的参数结构，包含 message 和可选 jsStack。	当前版本未从 SDK 包入口单独导出此类型名；通过所述配置、参数或返回值使用其结构。
JsResponse 类	SDKError.promiseErrorFromJson(...) 引用的错误包装结构，含可选 __error；业务通常直接处理 SDKError 回调或异常。	当前版本未从 SDK 包入口单独导出此类型名；通过所述配置、参数或返回值使用其结构。
SDKError 类	SDK 初始化或接口错误，继承 Error；包含 jsStack 和静态错误解析辅助方法。	可从 @shengwang/whiteboard 直接导入 SDKError。
SlideSyncEventQueuePolicy 类型别名	Slide 同步事件队列策略的字符串联合类型。	可从 @shengwang/whiteboard 直接导入 SlideSyncEventQueuePolicy。仅用于类型声明，不能作为构造函数调用 new。
SlideNavigationButtonMode 类型别名	Slide 底部导航按钮行为的字符串联合类型。	可从 @shengwang/whiteboard 直接导入 SlideNavigationButtonMode。仅用于类型声明，不能作为构造函数调用 new。
SlideAppOptions 接口	WhiteboardOptions.slideAppOptions 的本地 Slide 配置。	可从 @shengwang/whiteboard 直接导入 SlideAppOptions。仅用于类型声明，不能作为构造函数调用 new。
LocalLogOptions 接口	WhiteboardOptions.localLogOptions 的本地日志开关。	可从 @shengwang/whiteboard 直接导入 LocalLogOptions。仅用于类型声明，不能作为构造函数调用 new。
BackgroundImageLoadOptions 接口	WhiteboardOptions.backgroundImageLoadOptions 的加载重试和超时配置。	可从 @shengwang/whiteboard 直接导入 BackgroundImageLoadOptions。仅用于类型声明，不能作为构造函数调用 new。
ReloadBackgroundImageParams 接口	controller.reloadBackgroundImage(...) 的目标与可选替换地址。	可从 @shengwang/whiteboard 直接导入 ReloadBackgroundImageParams。仅用于类型声明，不能作为构造函数调用 new。
ReloadBackgroundImageResult 接口	背景图重载请求接收结果，含 accepted/reloadedCount/可选 reason。	可从 @shengwang/whiteboard 直接导入 ReloadBackgroundImageResult。仅用于类型声明，不能作为构造函数调用 new。
HasBackgroundImageParams 接口	controller.hasBackgroundImage(...) 的匹配参数。	可从 @shengwang/whiteboard 直接导入 HasBackgroundImageParams。仅用于类型声明，不能作为构造函数调用 new。
ApplianceCursorOptions 接口	光标配置，通过 WhiteboardOptions.appliancePluginOptions.extras.cursor 使用。	当前版本未从 SDK 包入口单独导出此类型名；通过所述配置、参数或返回值使用其结构。
ApplianceCursorSyncedLabelOptions 接口	光标标签配置，通过 appliancePluginOptions.extras.cursor.syncedLabel 使用。	当前版本未从 SDK 包入口单独导出此类型名；通过所述配置、参数或返回值使用其结构。
ApplianceCursorAppearanceOptions 接口	单个教具的光标外观，通过 cursor.appearance.pencil 或 cursor.appearance.clicker 使用。	当前版本未从 SDK 包入口单独导出此类型名；通过所述配置、参数或返回值使用其结构。
ApplianceCursorAppearanceMap 接口	按教具组织的光标外观，通过 appliancePluginOptions.extras.cursor.appearance 使用。	当前版本未从 SDK 包入口单独导出此类型名；通过所述配置、参数或返回值使用其结构。
ApplianceCursorSyncedAppearanceOptions 接口	远端同步光标外观，通过 cursor.appearance.pencil.synced 或 cursor.appearance.clicker.synced 使用。	当前版本未从 SDK 包入口单独导出此类型名；通过所述配置、参数或返回值使用其结构。
ApplianceCursorImagesOptions 接口	远端同步光标图片，通过 cursor.appearance.pencil.synced.images 或 cursor.appearance.clicker.synced.images 使用。	当前版本未从 SDK 包入口单独导出此类型名；通过所述配置、参数或返回值使用其结构。
ApplianceSyncOptions 接口	教具同步参数，通过 appliancePluginOptions.extras.syncOpt 使用。	当前版本未从 SDK 包入口单独导出此类型名；通过所述配置、参数或返回值使用其结构。
ApplianceBezierOptions 接口	贝塞尔绘制参数，通过 appliancePluginOptions.extras.bezier 使用。	当前版本未从 SDK 包入口单独导出此类型名；通过所述配置、参数或返回值使用其结构。
ApplianceTextEditorOptions 接口	文本编辑参数，通过 appliancePluginOptions.extras.textEditor 使用。	当前版本未从 SDK 包入口单独导出此类型名；通过所述配置、参数或返回值使用其结构。
VersionWorkerBlacklist 类型别名	运行时版本上限到降级等级的黑名单映射；例如版本键 89 表示匹配不高于该版本的运行时。	可从 @shengwang/whiteboard 直接导入 VersionWorkerBlacklist。仅用于类型声明，不能作为构造函数调用 new。
WorkerBlacklistByRuntime 接口	按 Android WebView、iOS WebView、Harmony ArkWeb 和 Web 分类的 Worker 黑名单。	可从 @shengwang/whiteboard 直接导入 WorkerBlacklistByRuntime。仅用于类型声明，不能作为构造函数调用 new。
ApplianceCanvasOptions 接口	画布参数，通过 appliancePluginOptions.extras.canvasOpt 使用。	当前版本未从 SDK 包入口单独导出此类型名；通过所述配置、参数或返回值使用其结构。
AppliancePluginExtrasOptions 接口	appliancePluginOptions.extras 的扩展配置，包含 cursor、同步、绘制和 Worker 选项。	可从 @shengwang/whiteboard 直接导入 AppliancePluginExtrasOptions。仅用于类型声明，不能作为构造函数调用 new。
AppliancePluginOptions 接口	WhiteboardOptions.appliancePluginOptions 的本地教具配置。	可从 @shengwang/whiteboard 直接导入 AppliancePluginOptions。仅用于类型声明，不能作为构造函数调用 new。
WhiteboardOptions 接口	Whiteboard 组件的初始化和入房配置。	可从 @shengwang/whiteboard 直接导入 WhiteboardOptions。仅用于类型声明，不能作为构造函数调用 new。
RoomOptions 接口	buildRoomOptions(options) 的返回结构，包含 uuid/isWritable 等 Bridge 入房字段；可接收函数返回值，不是业务 joinRoom() 入口。	当前版本未从 SDK 包入口单独导出此类型名；通过所述配置、参数或返回值使用其结构。
Whiteboard ArkUI 组件	ArkUI 白板组件；根据 options 初始化并自动入房，接收 controller 和 callbacks。	可从 @shengwang/whiteboard 直接导入 Whiteboard。作为 ArkUI 组件使用。
buildRoomOptions 辅助函数	将 WhiteboardOptions 映射为 Bridge 入房参数的辅助函数；本身不发起入房。	可从 @shengwang/whiteboard 直接导入 buildRoomOptions。导入后作为函数调用。
VERSION 常量	Harmony Native 包版本常量 0.2.11；不是内嵌 Web SDK 版本。	可从 @shengwang/whiteboard 直接导入 VERSION。导入后读取常量值。
DynamicConfigOptions	region 到当前平台配置 JSON URL 的映射。	可从包入口导入，类型别名不可 new。
buildSdkOptions	从 WhiteboardOptions 构造 SDK 参数，本身不入房。	可从包入口导入并作为函数调用。
SdkOptions	buildSdkOptions 的完整返回结构；可选开关保留未显式配置语义。	仅在公开返回签名中引用，包入口未单独导出类型名。

DynamicConfigOptions：动态配置地址映射；buildSdkOptions：构造 SDK 参数。

咨询电话

咨询电话