txFlashFileRecognize
概述
本模块封装了腾讯云录音文件识别极速版的SDK
注意:本模块 iOS 平台上最低适配系统版本为 iOS 9.0
模块接口
init
初始化,直接
init({params})
params
appid:
- 类型:字符串
- 描述:腾讯云 ID,即 AppID,腾讯云获取
secretId:
- 类型:字符串
- 描述:腾讯云安全凭证,腾讯云获取
secretKey:
- 类型:字符串
- 描述:腾讯云安全凭证,腾讯云获取
示例代码
var txFlashFileRecognize = api.require('txFlashFileRecognize');
txFlashFileRecognize.init({
appid:'',
secretId:'',
secretKey:''
});
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
initWithToken
初始化, 临时鉴权
initWithToken({params})
params
appid:
- 类型:字符串
- 描述:腾讯云 ID,即 AppID,腾讯云获取
secretId:
- 类型:字符串
- 描述:腾讯云安全凭证,腾讯云获取
secretKey:
- 类型:字符串
- 描述:腾讯云安全凭证,腾讯云获取
token:
- 类型:字符串
- 描述:token,腾讯云获取
示例代码
var txFlashFileRecognize = api.require('txFlashFileRecognize');
txFlashFileRecognize.initWithToken({
appid:'',
secretId:'',
secretKey:'',
token:''
});
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
recognize
文件识别
recognize({params},callback(ret))
params
path:
- 类型:字符串
- 描述:(可选项)语音数据本地路径,支持fs、widget
voiceFormat:
- 类型:字符串
- 描述:(可选项)音频格式。支持 wav、pcm、ogg-opus、speex、silk、mp3、m4a、aac
- 默认:'mp3'
engineModelType:
- 类型:字符串
- 描述:(可选项)引擎模型类型,默认16k_zh。8k_zh:8k 中文普通话通用;16k_zh:16k 中文普通话通用;16k_zh_video:16k音视频领域
- 默认:'16k_zh'
filterDirty:
- 类型:数字
- 描述:(可选项)是否过滤脏话;0:不过滤脏话;1:过滤脏话
- 默认:0
filterModal:
- 类型:数字
- 描述:(可选项)是否过滤语气词;0:不过滤语气词 1:过滤部分语气词 2:严格过滤
- 默认:0
filterPunc:
- 类型:数字
- 描述:(可选项)是否过滤句末的句号 ;0:默认状态 不过滤句末的句号 1:滤句末的句号
- 默认:0
convertNumMode:
- 类型:数字
- 描述:(可选项)是否进行阿拉伯数字智能转换。0:全部转为中文数字,1:根据场景智能转换为阿拉伯数字
- 默认:1
speakerDiarization:
- 类型:数字
- 描述:(可选项)是否开启说话人分离(目前支持中文普通话引擎),默认为0,0:不开启,1:开启
- 默认:0
firstChannelOnly:
- 类型:数字
- 描述:(可选项)是否只识别首个声道,默认为1。0:识别所有声道;1:识别首个声道
- 默认:0
wordInfo:
- 类型:数字
- 描述:(可选项)是否显示词级别时间戳,默认为0。0:不显示;1:显示,不包含标点时间戳,2:显示,包含标点时间戳
- 默认:0
callback(ret)
ret:
- 类型:JSON对象
- 内部字段:
{
requestId: //数字类型;返回请求唯一标识requestId,iOS端1.0.2版本以后不再支持
}
示例代码
var txFlashFileRecognize = api.require('txFlashFileRecognize');
txFlashFileRecognize.recognize({
path:''
},function(ret) {
api.alert({ msg:JSON.stringify(ret)});
});
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
addEventListener
添加监听
addEventListener(callback(ret))
callback(ret)
ret:
- 类型:JSON对象
- 内部字段:
{
eventType:'', //字符串类型;事件回调,取值范围如下:
//didRecognizeSuccess:录音文件识别成功
//didRecognizeError:录音文件识别失败
text:'', //字符串类型;识别结果文本; didRecognizeSuccess返回
resultData:'',//字符串类型;识别原始数据; didRecognizeSuccess、didRecognizeError返回
msg:'' //字符串类型;错误信息;didRecognizeError返回
}
注意:resultData字段仅ios支持
示例代码
var txFlashFileRecognize = api.require('txFlashFileRecognize');
txFlashFileRecognize.addEventListener(function(ret) {
api.alert({ msg:JSON.stringify(ret)});
});
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
removeEventListener
移除监听
removeEventListener()
示例代码
var txFlashFileRecognize = api.require('txFlashFileRecognize');
txFlashFileRecognize.removeEventListener();
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本