com.herewhite.sdk.CommonCallback接口 参考
成员函数说明
throwError()
default void com.herewhite.sdk.CommonCallback.throwError | ( | Object | args | ) |
SDK 出现未捕获的全局错误回调。
参数
参数名 | 描述 |
---|---|
args | 错误信息。 |
urlInterrupter()
default String com.herewhite.sdk.CommonCallback.urlInterrupter | ( | String | sourceUrl | ) |
图片拦截回调。
自从
2.9.14
该回调默认禁用。你可以在初始化白板 SDK 时,通过 setEnableInterrupterAPI
(true) 方法开启。
开启后,在白板中插入图片时,SDK 会触发该回调,报告图片的原 URL 地址。你可以在该回调中将原 URL 地址替换成指定的 URL 地址。
注解
开启后,SDK 会频繁触发该回调,因此 Agora 不推荐开启该回调;在 Android 平台,你可以使用 WebView 的拦截功能进行图片拦截。
参数
参数名 | 描述 |
---|---|
sourceUrl | 原 URL 地址。 |
返回值
替换后的图片地址。请确保在返回值中进行传参。
onPPTMediaPlay()
default void com.herewhite.sdk.CommonCallback.onPPTMediaPlay | ( | ) |
onPPTMediaPause()
default void com.herewhite.sdk.CommonCallback.onPPTMediaPause | ( | ) |
onMessage()
default void com.herewhite.sdk.CommonCallback.onMessage | ( | JSONObject | object | ) |
接收到网页发送的消息回调。
自从
2.11.4
当本地用户收到了网页(如 iframe 插件、动态 PPT)发送的消息时会触发该回调。
注解
不保证所有用户都能接收到该回调。
参数
参数名 | 描述 |
---|---|
object | JSON 格式的消息。只有当消息为 JSON 格式时,本地用户才能收到。 |
sdkSetupFail()
default void com.herewhite.sdk.CommonCallback.sdkSetupFail | ( | SDKError | error | ) |
SDK 初始化失败回调。
自从
2.9.14
如果 SDK 初始化失败,调用加入实时房间或回放房间时会处于一直无响应状态,需要重新初始化 SDK。 SDK 初始化失败可能由以下原因导致:
- 初始化 SDK 时候,网络异常,导致获取配置信息失败。
- 传入了不合法的 App Identifier。
参数
参数名 | 描述 |
---|---|
error | 错误信息。 |
onLogger()
default void com.herewhite.sdk.CommonCallback.onLogger | ( | JSONObject | object | ) |
获取 SDK 输出的本地调试日志。
自从
2.13.22
成功调用 setLog
(true) 后,SDK 会触发该回调,向你发送本地调试日志。
如果你需要关闭该回调,可以设置 setLog(false)
。
注解
例如,{"funName": "joinRoom", "params": {"isWritable": 1, "region": "cn-hz"}}
。
参数
参数名 | 描述 |
---|---|
object | JSON 对象格式的日志消息,每条日志消息包含以下 key:
|