WhiteCommonCallbackDelegate Protocol Reference
- iOS
更新时间不可用
Whiteboard iOS SDK 2.16.147 公开接口。
@protocol WhiteCommonCallbackDelegate <NSObject>
成员
- throwError:
- urlInterrupter:
- pptMediaPlay
- pptMediaPause
- sdkSetupFail:
- customMessage:
- onBackgroundImageLoad:
- onApplianceInitLoadingChange:
- logger:
- localLogStateChange:
- startRecoveringFromMemoryIssues
- endRecoveringFromMemoryIssues:
– throwError:
- (void)throwError:(NSError *)error;SDK 出现未捕获的全局错误回调。
@param error 错误信息。Declared in Displayer/WhiteCommonCallbacks.h
– urlInterrupter:
- (NSString *)urlInterrupter:(NSString *)url;图片拦截回调。
*Note:**
- 要触发该回调,必须在初始化白板 SDK 时,设置 `enableInterrupterAPI(YES)` 开启图片拦截替换功能。详见 [WhiteSdkConfiguration](/zh-CN/api-reference/whiteboard/whiteboard-sdk/ios/classes/white-sdk-configuration)。
- 开启图片拦截替换功能后,在白板中插入图片或场景时,会触发该回调。
@param url 图片原地址。
@return 替换后的图片地址。Declared in Displayer/WhiteCommonCallbacks.h
– pptMediaPlay
- (void)pptMediaPlay;播放动态 PPT 中的音视频回调。Declared in Displayer/WhiteCommonCallbacks.h
– pptMediaPause
- (void)pptMediaPause;暂停播放动态 PPT 中的音视频回调。Declared in Displayer/WhiteCommonCallbacks.h
– sdkSetupFail:
- (void)sdkSetupFail:(NSError *)error;SDK 初始化失败回调。
@since 2.9.13
如果 SDK 初始化失败,调用加入实时房间或回放房间时会处于一直无响应状态,需要重新初始化 SDK。
SDK 初始化失败可能由以下原因导致:
- 初始化 SDK 时候,网络异常,导致获取配置信息失败。
- 传入了不合法的 App Identifier。
@param error 错误信息。Declared in Displayer/WhiteCommonCallbacks.h
– customMessage:
- (void)customMessage:(NSDictionary *)dict;接收到网页发送的消息回调。
消息回调包括:
- 字典格式的 iframe 数据
- 图片加载失败信息
- ppt 播放/暂停回调信息
当本地用户收到了网页(如 iframe 插件、动态 PPT)发送的消息时会触发该回调。
@param dict 字典格式的消息。只有当消息为字典格式时,本地用户才能收到。Declared in Displayer/WhiteCommonCallbacks.h
– onBackgroundImageLoad:
- (void)onBackgroundImageLoad:(WhiteBackgroundImageLoadEvent *)event;可见背景图片加载状态回调。Declared in Displayer/WhiteCommonCallbacks.h
– onApplianceInitLoadingChange:
- (void)onApplianceInitLoadingChange:(WhiteApplianceInitLoadingChangeEvent *)event;Appliance 插件初始化进度回调。Declared in Displayer/WhiteCommonCallbacks.h
– logger:
- (void)logger:(NSDictionary *)dict;@param dict
目前有两种日志:
1. SDK 的调用日志,{funName: string, params: id} funName 为对应 API 的名称
2. WebView 的 Console 日志, {[WhiteWKConsole]: string},该日志只有在设置 `loggerOptions.printLevelMask` 为 `WhiteSDKLoggerOptionLevelDebug` 时才会打印Declared in Displayer/WhiteCommonCallbacks.h
– localLogStateChange:
- (void)localLogStateChange:(NSDictionary *)state;WebView 内本地日志状态变化回调。
@param state 本地日志运行状态。Declared in Displayer/WhiteCommonCallbacks.h
– startRecoveringFromMemoryIssues
- (void)startRecoveringFromMemoryIssues;发生了内存不足问题,SDK 即将开始恢复白板
目前只有实时房间有可能触发该回调
该回调最多会触发三次
超过三次Declared in Displayer/WhiteCommonCallbacks.h
– endRecoveringFromMemoryIssues:
-(void)endRecoveringFromMemoryIssues:(BOOL)success;发生了内存不足问题,SDK 结束了一次恢复白板。
如果恢复失败,sdk 不会主动继续重连。
@param success 本次恢复是否成功Declared in Displayer/WhiteCommonCallbacks.h