com.herewhite.sdk.CommonCallback interface 参考
- Android
更新时间不可用
详细描述
适用版本:Whiteboard Android SDK 2.16.134。
CommonCallback,用于 SDK 向 app 发送回调事件通知。
<p>
实时房间和回放房间都可以继承该接口下的回调方法。
@since 2.9.13
| 公开成员签名 | |
|---|---|
| void | throwError (Object args) |
| String | urlInterrupter (String sourceUrl) |
| void | onPPTMediaPlay () |
| void | onPPTMediaPause () |
| void | onMessage (JSONObject object) |
| void | onBackgroundImageLoad (BackgroundImageLoadEvent event) |
| void | onApplianceInitLoadingChange (ApplianceInitLoadingChangeEvent event) |
| void | sdkSetupFail (SDKError error) |
| void | onLogger (JSONObject object) |
| void | onLocalLogStateChange (JSONObject state) |
函数说明
throwError()
void throwError(Object args)SDK 出现未捕获的全局错误回调。
| 参数名 | 描述 |
|---|---|
args | 错误信息。 |
在 com.herewhite.sdk.AbstractCommonCallbacks 内被实现.
urlInterrupter()
String urlInterrupter(String sourceUrl)图片拦截回调。
自从
2.9.14
该回调默认禁用。你可以在初始化白板 SDK 时,通过 setEnableInterrupterAPI(true) 方法开启。
开启后,在白板中插入图片时,SDK 会触发该回调,报告图片的原 URL 地址。你可以在该回调中将原 URL 地址替换成指定的 URL 地址。
注解
开启后,SDK 会频繁触发该回调,因此 Agora 不推荐开启该回调;在 Android 平台,你可以使用 WebView 的拦截功能进行图片拦截。
| 参数名 | 描述 |
|---|---|
sourceUrl | 原 URL 地址。 |
返回值
替换后的图片地址。请确保在返回值中进行传参。
在 com.herewhite.sdk.AbstractCommonCallbacks 内被实现.
onPPTMediaPlay()
void onPPTMediaPlay()播放动态 PPT 中的音视频回调。
自从
2.9.13
在 com.herewhite.sdk.AbstractCommonCallbacks 内被实现.
onPPTMediaPause()
void onPPTMediaPause()暂停播放动态 PPT 中的音视频回调。
自从
2.9.13
在 com.herewhite.sdk.AbstractCommonCallbacks 内被实现.
onMessage()
void onMessage(JSONObject object)接收到网页发送的消息回调。
自从
2.11.4
当本地用户收到了网页(如 iframe 插件、动态 PPT)发送的消息时会触发该回调。
注解
不保证所有用户都能接收到该回调。
| 参数名 | 描述 |
|---|---|
object | JSON 格式的消息。只有当消息为 JSON 格式时,本地用户才能收到。 |
在 com.herewhite.sdk.AbstractCommonCallbacks 内被实现.
onBackgroundImageLoad()
void onBackgroundImageLoad(BackgroundImageLoadEvent event)背景图加载事件:name、state(success/failed/cancelled)、source(appliance)、resourceId、resourceUrl、viewId、scenePath。
onApplianceInitLoadingChange()
void onApplianceInitLoadingChange(ApplianceInitLoadingChangeEvent event)教具初始化进度事件:name、loading、phase(plugin/worker/scene/ready)、status(start/success/timeout/error)。loading=false、phase=ready、status=success 表示就绪。
sdkSetupFail()
void sdkSetupFail(SDKError error)SDK 初始化失败。收到错误后重新创建/初始化 SDK,再重新入房;这不是普通房间断线重连事件。
onLogger()
void onLogger(JSONObject object)获取 SDK 输出的本地调试日志。
自从
2.13.22
成功调用 setLog(true) 后,SDK 会触发该回调,向你发送本地调试日志。
如果你需要关闭该回调,可以设置 setLog(false)。
注解
设置 setLog(false) 后,SDK 会停止通过 onLogger 回调发送本地调试日志,但仍然会通过该回调发送 video-js-plugin 插件的日志信息。
| 参数名 | 描述 |
|---|---|
object | JSON 对象格式的日志消息,每条日志消息包含以下 key:
|
例如,{"funName": "joinRoom", "params": {"isWritable": 1, "region": "cn-hz"}}。
onLocalLogStateChange()
void onLocalLogStateChange(JSONObject state)WebView 内本地日志状态变更,回调参数为 JSON 状态对象。