应用内Web SDK
通信原理:应用内Web页面采用原生的WebView加载Web页面,SDK通信方式采用成熟的jsBridge框架。 应用内Web SDK对jsBridge进行了封装,并为集成方提供了两个接口,具体能力调用全部以这两个接口为入口:
接口名 | 接口含义 |
---|---|
H5_call_native | Web端调用iFLYHOME OS应用的接口,主要用于调用iFLYHOME OS的应用用于申请能力,更新参数,获取参数等能力 |
native_call_H5 | Web端注册iFLYHOME OS应用回调结果的监听接口,主要用于申请某项开发能力后,iFLYHOME OS应用触发后通过该接口回调给Web端 |
详细的通信协议见链接:Web与客户端通信消息协议
H5_call_native
说明:该接口为Web端调用客户端接口,主要用于Web调用客户端去申请和关闭能力、更新参数、以及获取参数等功能。
- H5_call_native参数说明
参数名 | 是否必选 | 参数类型 | 参数描述 | 示例 |
---|---|---|---|---|
name | 是 | String | h5调用客户端具体协议名称 | native_open_asr |
params | 是 | string | 当前协议对应入参 | {"appid" :"xxx","token":"xxxxxxx"} |
callback | 是 | function | 当前调用结果 | function(response){}) |
- callback参数说明
参数名 | 是否必选 | 参数类型 | 参数描述 | 示例 |
---|---|---|---|---|
response | 是 | String | 为客户端的返回参数json格式的字符串 | { “code”:200, “msg”: “成功” } |
使用样例
//申请开发识别文本接口
H5_call_native('native_open_asr',{"appid":"xxxx","token":"xxxx"},function(response){
console.log(response);
})
native_call_H5
说明:该部分接口主要是Web注册的监听接口,Web页面申请了一些能力,当用户触发后通过该接口回调
- native_call_H5参数说明
参数名 | 是否必选 | 参数类型 | 参数描述 | 示例 |
---|---|---|---|---|
name | 是 | String | 客户端具体协议名称 | h5_send_asr_result |
callback | 是 | function | 客户端入参回调接口 | function(data,responseCallback){} |
- callback参数说明
参数名 | 是否必选 | 参数类型 | 参数描述 | 示例 |
---|---|---|---|---|
data | 是 | JSON | iFLYHOME OS应用回传数据 | {"text":"语音识别结果,"token":"xxxx"} |
responseCallback | 是 | function | 用于调用客户端当前处理结果 | function(res){} |
- responseCallback参数说明
说明:当iFLYHOME OS应用将结果回调给Web页面的结果,我们需要知道Web页面收到后是否进行处理,当页面收到回传结果后,需要通过该接口回传给客户端当前Web页面的处理结果。
参数名 | 是否必选 | 参数类型 | 参数描述 | 示例 |
---|---|---|---|---|
response | 是 | JSON | 反馈给iFLYHOME OS应用当前处理结果 | { "code":200, "msg":"成功", “data”:{ "asrToken":"xxxx", "handled":false} } |
使用样例:
//注册监听识别文本接口能力
native_call_H5('h5_send_asr_result',function(data,responseCallback){
//处理识别文本结果
console.log(data.token);
console.log(data.text);
//反馈处理结果给TVPS应用
var resObj={};
resObj.code=200;
resObj.msg='success';
var result = {"asrToken": data.token,"handled": handleResult};
resObj.data=result;
responseCallback(JSON.stringify(resObj));
})
response数据格式
主要是指H5_call_native接口中callback中调用结果response;以及native_call_H5中responseCallback中反馈结果response。
参数名 | 是否必选 | 参数类型 | 说明 |
---|---|---|---|
code | 是 | int | "返回结果值"状态码 200:success -1000:API不支持 -1001:REQUEST参数异常 -1002:构建Response结果异常 |
msg | 是 | string | 描述信息 |
data | 否 | json | 通信数据,json格式,具体值参见语点开放的能力 |