2026/10/27 17:43:29
扩展 API 与配置
适用于 Whiteboard iOS SDK 2.16.145。使用 Objective-C 或 Swift Native 接口。
WhiteSDK
Objective-C
- (void)reloadBackgroundImage:(WhiteReloadBackgroundImageParams *)params completionHandler:(WhiteReloadBackgroundImageCompletionHandler)completionHandler;
- (void)hasBackgroundImage:(WhiteHasBackgroundImageParams *)params completionHandler:(WhiteHasBackgroundImageCompletionHandler)completionHandler;
WhiteRoom
Objective-C
- (void)addApp:(WhiteAppParam *)appParams completionHandler:(void (^)(NSString * _Nullable appId))completionHandler;
- (void)fitOriginSizeAndCamera;
- (void)focusApp:(NSString *)appId;
- (void)focusApp:(NSString *)appId completionHandler:(void (^ _Nullable)(BOOL committed))completionHandler;
- (void)dispatchDocsEvent:(WhiteWindowDocsEventKey)docsEvent options:(WhiteWindowDocsEventOptions * _Nullable)options completionHandler:(void (^)(WhiteDispatchDocsEventResult *result))completionHandler;
- (void)querySlidePageState:(NSString * _Nullable)appId completionHandler:(void (^)(WhiteSlidePageState * _Nullable pageState, NSError * _Nullable error))completionHandler;
- (void)getPageState:(WhiteWindowPageStateOptions * _Nullable)options completionHandler:(void (^)(WhiteUnifiedPageState * _Nullable pageState, NSError * _Nullable error))completionHandler;
统一页面控制
MainView、DocsViewer、Slide、Presentation 的 page 从 1 开始;target 输入可为 mainView 或 appId,省略时跟随焦点。查询输出的 target 为 mainView/DocsViewer/Slide/Presentation。scale 为相对适配尺寸倍率,1 表示适配尺寸,DocsViewer 不支持 scalePage。
accepted=true 表示命令接收;accepted=false 包含 reason/message。通过统一页事件或查询观察实际状态,不能把命令回调作为首帧完成信号。
窗口与课件配置
| 参数 | 行为 |
|---|---|
| originSize | 正数 width/height 参考尺寸;MainView 与各 App 分别设置 |
| pageScaleRange | 相对适配尺寸的 minScale/maxScale,均为有限正数 |
| forceMaximized | 房间级强制最大化,与 useBoxesStatus 不兼容 |
| lazySetupInMaximizedMode | 本端按焦点初始化,默认关闭 |
| maxCachedAppsInMaximizedMode | 本端 LRU runtime 缓存,默认 4 |
| navigationButtonMode | Slide 底部按钮:page 默认按页,step 按动画步骤 |
| syncEventQueuePolicy | fifo 默认;latest-pending-render 仅合并待执行渲染页 |
focusApp 的布尔值表示焦点提交完成;不能用它判断 setup 或全部资源就绪。插入课件需先转换,普通图片页可以创建 Presentation;原有静态文档 API 保持 DocsViewer 行为。
插件背景与本端回调
背景配置与查询/恢复见背景图加载与恢复。WhiteCommonCallbackDelegate 的背景图与初始化回调使用 WhiteBackgroundImageLoadEvent、WhiteApplianceInitLoadingChangeEvent;统一页事件通过 WhiteRoomCallbackDelegate.onUnifiedPageStateChange 接收。