APICloud 自定义模块文档
网络监测工具 modulePing
两种检测形式
-
检测数据包成功次数 (详细版)
功能说明:ping测试可只传入ip数据使用默认参数测试 默认:发送数据包3次 发送数据包32(byte) 发送时间隔0.5s 测试超时时间5s(在不传入测试参数的情况下) 也可以传入完整(或部分)测试参数和ip数据,参数具体参考下1,2 1. 只检测ip数据,其他参数默认: ip var param = {ip:"172.20.170.242"} 2. 录入完整参数 var param = {ip:ip,countCmd:countCmd,sizeCmd:sizeCmd,timeCmd:timeCmd}; 3. 参数解释: { ip:"10.1.1.157", // 测试ip countCmd:'6', // 发送数据包6个,可自定义发包个数 sizeCmd:"256", // 发送数据包大小(byte),可不传 timeCmd:"0.2", // 发送下一个数据包时间隔0.2s,最小为0.2s既为200ms timeOut:"3", // 测试请求超时时间,单位秒,建议设置不低于3s } 4. 返回数据: ret:{ msg:"", // ping测试详细输出结果 okNum:"", // ping测试成功次数 faileNum:"", // ping测试失败次数 TotalNum:"" // ping测试总次数 } 示例方法: function pingtest(){ let uzmoduledemo = api.require('modulePing'); let param = { ip:"10.1.1.157", // 测试ip countCmd:"6", // 发送数据包6个 sizeCmd:"256", // 发送数据包大小(byte) timeCmd:"0.2", // 发送时间隔,最小为0.2s既为200 timeOut:"3" // 测试请求超时时间,单位秒,建议设置不低于3s }; uzmoduledemo.pingtest(param, function(ret,error){ if(ret){ alert(ret.TotalNum+"TotalNum次数"); alert(ret.okNum+"ok次数"); alert(ret.faileNum+"失败次数"); alert(ret.msg); }else{ alert(JSON.stringify(error)); } } ); }
-
网络是否通畅
功能说明:网络是否通畅测试ping一次 响应期限为2秒 1. 检测IP参数: var param = {ip:"172.20.170.242"} 2. 返回数据: ret:{ state:"" // 0:网络通畅 | 1:网络不通 | 2:捕获io异常 | 3:捕获网络中断异常 } 示例方法: function pingtest(){ let uzmoduledemo = api.require('modulePing'); let param = {ip:"172.20.170.242"}; // 测试ip uzmoduledemo.pingtest(param, function(ret,error){ if(ret){ alert(ret.state); }else{ alert(JSON.stringify(error)); } } ); }
语音播报
参考文档:科大讯飞语音 https://docs.apicloud.com/Client-API/Open-SDK/iflyRecognition
注意:需要添加 iflyRecognition
模块和 https://docs.apicloud.com/img/docImage/iflyRecognition/iflyRecognitionAppendix.zip
功能说明:封装了科大讯飞的SDK 的语音听写、语音在线合成功能。
使用步骤:
1. 创建科大讯飞引擎
var iflyRecognition = api.require('iflyRecognition');
iflyRecognition.createUtility({
android_appid: '5bd7b19a'
}, function(ret, err) {
if (ret.status) {
api.alert({ msg: '创建成功'});
} else {
api.alert({ msg: "创建失败" });
}
});
2.用语音读取文字信息,最大的字节数为1k
a. 参数:
params:{
readStr:"", // 要读取的文字信息 字符串
speed:"", // 朗读的语速,范围是0-100 数字 默认值:60
volume:"", // 朗读的声音大小,范围是0-100 数字 默认值:60
voice:"", // 朗读人(兼容旧版本:0-xiaoyan;1-xiaoyu;)
}
b. 返回参数:
ret:{
status: // 布尔类型;操作成功状态值,true|false
speakProgress: // 数字类型;朗读的进度
}
err:{
msg: //字符串类型;返回错误信息
}
c. 示例方法:
var iflyRecognition = api.require('iflyRecognition');
iflyRecognition.read({
readStr: 'APICloud平台',
speed: 60,
volume: 60,
voice: 1,
}, function(ret, err) {
if (ret.status) {
console.log(ret.speakProgress)
} else {
api.alert({ msg: err.msg });
}
});
3.停止朗读:stopRead
var iflyRecognition = api.require('iflyRecognition');
iflyRecognition.stopRead();
示例方法:
function pingtest(){
// 创建科大讯飞引擎
let iflyRecognition = api.require('iflyRecognition');
iflyRecognition.createUtility({
android_appid: '5bd7b19a'
}, function(ret, err) {
if (ret.status) {
api.alert({ msg: '创建成功'});
} else {
api.alert({ msg: "创建失败" });
}
});
// 使用科大讯飞引擎语音播报
iflyRecognition.read({
readStr: 'APICloud平台',
speed: 60,
volume: 60,
voice: 1,
}, function(ret, err) {
if (ret.status) {
console.log(ret.speakProgress)
} else {
api.alert({ msg: err.msg });
}
});
}
附件:iflyRecognitionAppendix.zip
消息提示模块 moduleNotification
达摩院文章: apicloud 自定义模块 - 分享录屏、笔记合辑
附件:
安卓 8 以下:
moduleNotification.zip
安卓 8 以上:
moduleNotification_2022.zip
后台进程守护模块 moduleProcessAlive
达摩院文章: apicloud 自定义模块 - 分享录屏、笔记合辑
附件:moduleProcessAlive_2022.zip
扫码模块 EHScanner
功能描述:支持反白功能使用附件
使用方法:同https://docs.apicloud.com/Client-API/Func-Ext/FNScanner
注意:引入模块名称为 EHScanner
APICloud 自定义模块:下载地址 https://note.youdao.com/s/PaKyPMok