WhiteCommonCallbackDelegate Protocol Reference

Conforms to NSObject
Declared in WhiteCommonCallbacks.h

Overview

白板通用回调。

– throwError:

SDK 出现未捕获的全局错误回调。

- (void)throwError:(NSError *)error

Parameters

error

错误信息。

Declared In

WhiteCommonCallbacks.h

– urlInterrupter:

图片拦截回调。

- (NSString *)urlInterrupter:(NSString *)url

Parameters

url

图片原地址。

Return Value

替换后的图片地址。

Discussion

Note:

  • 要触发该回调,必须在初始化白板 SDK 时,设置 enableInterrupterAPI(YES) 开启图片拦截替换功能。详见 WhiteSdkConfiguration
  • 开启图片拦截替换功能后,在白板中插入图片或场景时,会触发该回调。

Declared In

WhiteCommonCallbacks.h

– pptMediaPlay

播放动态 PPT 中的音视频回调。

- (void)pptMediaPlay

Declared In

WhiteCommonCallbacks.h

– pptMediaPause

暂停播放动态 PPT 中的音视频回调。

- (void)pptMediaPause

Declared In

WhiteCommonCallbacks.h

– sdkSetupFail:

SDK 初始化失败回调。

- (void)sdkSetupFail:(NSError *)error

Parameters

error

错误信息。

Availability

2.9.13

如果 SDK 初始化失败,调用加入实时房间或回放房间时会处于一直无响应状态,需要重新初始化 SDK。

SDK 初始化失败可能由以下原因导致:

  • 初始化 SDK 时候,网络异常,导致获取配置信息失败。
  • 传入了不合法的 App Identifier。

Declared In

WhiteCommonCallbacks.h

– customMessage:

接收到网页发送的消息回调。

- (void)customMessage:(NSDictionary *)dict

Parameters

dict

字典格式的消息。只有当消息为字典格式时,本地用户才能收到。

Discussion

消息回调包括:

  • 字典格式的 iframe 数据
  • 图片加载失败信息
  • ppt 播放/暂停回调信息

当本地用户收到了网页(如 iframe 插件、动态 PPT)发送的消息时会触发该回调。

Declared In

WhiteCommonCallbacks.h

– logger:

获取 SDK 输出的本地调试日志。

- (void)logger:(NSDictionary *)dict

Parameters

dict

字典结构的日志消息,每条日志消息包含以下 key:

  • funName:功能名称。
  • params:具体的参数设置。

例如,{"funName": "joinRoom", "params": {"isWritable": 1, "region": "cn-hz"}}

Availability

v2.13.19

WhiteSdkConfiguration 类中 log 设为 YES 后,SDK 会触发该回调,返回 SDK 输出的本地调试日志。

如果你需要关闭该回调,可以将 log 设为 NO

Note:

即使将 log 设为 NO,SDK 会停止通过 logger 回调返回本地调试日志,但仍然会通过该回调返回 video-js-plugin 插件的日志信息。

Declared In

WhiteCommonCallbacks.h