txOneSentenceRecognize

立即使用

概述

本模块封装了腾讯云一句话识别的SDK

注意:本模块 iOS 平台上最低适配系统版本为 iOS 9.0

模块接口

init

初始化

init({params})

params

appid:

  • 类型:字符串
  • 描述:腾讯云 ID,即 AppID,腾讯云获取

secretId:

  • 类型:字符串
  • 描述:腾讯云安全凭证,腾讯云获取

secretKey:

  • 类型:字符串
  • 描述:腾讯云安全凭证,腾讯云获取

示例代码

var txOneSentenceRecognize = api.require('txOneSentenceRecognize');
txOneSentenceRecognize.init({
  appid:'',
  secretId:'',
  secretKey:''
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

recognizeWithUrl

通过语音url进行一句话识别

recognizeWithUrl({params},callback(ret))

params

url:

voiceFormat:

  • 类型:数字
  • 描述:(可选项)语音数据格式;0:mp3,1:wav
  • 默认:0

engSerViceType:

  • 类型:数字
  • 描述:(可选项)语音数据采样率;0:16k,1:8k
  • 默认:0

callback(ret)

ret:

  • 类型:JSON对象
  • 内部字段:
{
     status:true //布尔类型;true 本地参数校验通过,成功发起请求 false:参数校验不通过、
 }

示例代码

var txOneSentenceRecognize = api.require('txOneSentenceRecognize');
txOneSentenceRecognize.recognizeWithUrl({
  url:''
},function(ret) {
    api.alert({ msg:JSON.stringify(ret)});
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

recognizeWithData

通过语音数据进行一句话识别

recognizeWithData({params},callback(ret))

params

path:

  • 类型:字符串
  • 描述:语音数据本地路径,支持fs、widget

voiceFormat:

  • 类型:数字
  • 描述:(可选项)语音数据格式;0:mp3,1:wav
  • 默认:0

engSerViceType:

  • 类型:数字
  • 描述:(可选项)语音数据采样率;0:16k,1:8k
  • 默认:0

callback(ret)

ret:

  • 类型:JSON对象
  • 内部字段:
{
     status:true //布尔类型;true 本地参数校验通过,成功发起请求 false:参数校验不通过
 }

示例代码

var txOneSentenceRecognize = api.require('txOneSentenceRecognize');
txOneSentenceRecognize.recognizeWithData({
  path:''
},function(ret) {
    api.alert({ msg:JSON.stringify(ret)});
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

recognizeWithParams

通过通用参数调用一句话识别

recognizeWithParams({params},callback(ret))

params

url:

path:

  • 类型:字符串
  • 描述:(可选项)语音数据本地路径,支持fs、widget,sourceType为1生效

sourceType:

  • 类型:数字
  • 描述:(可选项)语音数据来源。;0:URL,1:本地数据
  • 默认:0

voiceFormat:

  • 类型:数字
  • 描述:(可选项)语音数据格式;0:mp3,1:wav
  • 默认:0

engSerViceType:

  • 类型:数字
  • 描述:(可选项)语音数据采样率;0:16k,1:8k
  • 默认:0

usrAudioKey:

  • 类型:字符串
  • 描述:(可选项)用户端对此任务的唯一标识,用户自助生成,用于用户查找识别结果

filterDirty:

  • 类型:数字
  • 描述:(可选项)是否过滤脏词(目前支持中文普通话引擎)。0:不过滤脏词;1:过滤脏词;2:将脏词替换为 *
  • 默认:0

filterModal:

  • 类型:数字
  • 描述:(可选项)是否过语气词(目前支持中文普通话引擎)。0:不过滤语气词;1:部分过滤;2:严格过滤
  • 默认:0

filterPunc:

  • 类型:数字
  • 描述:(可选项)是否过滤标点符号(目前支持中文普通话引擎)。 0:不过滤,1:过滤句末标点,2:过滤所有标点
  • 默认:0

convertNumMode:

  • 类型:数字
  • 描述:(可选项)是否进行阿拉伯数字智能转换。0:不转换,直接输出中文数字,1:根据场景智能转换为阿拉伯数字
  • 默认:0

hotwordId:

  • 类型:字符串
  • 描述:(可选项)热词id

callback(ret)

ret:

  • 类型:JSON对象
  • 内部字段:
{
     status:true //布尔类型;true 本地参数校验通过,成功发起请求 false:参数校验不通过
}

示例代码

var txOneSentenceRecognize = api.require('txOneSentenceRecognize');
txOneSentenceRecognize.recognizeWithParams({
  sourceType:0,
  url:''
},function(ret) {
    api.alert({ msg:JSON.stringify(ret)});
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

startRecognizeWithRecorder

通过sdk内置录音器开始一句话识别,录音时长超过60秒或音频数据超过3m,服务器会返回识别失败,开始录音后,可以直接调用stopRecognizeWithRecorder结束录音, SDK会回调识别结果

startRecognizeWithRecorder()

示例代码

var txOneSentenceRecognize = api.require('txOneSentenceRecognize');
txOneSentenceRecognize.startRecognizeWithRecorder();

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

stopRecognizeWithRecorder

主动停止录音,SDK会自动上报录音语音数据进行识别

stopRecognizeWithRecorder()

示例代码

var txOneSentenceRecognize = api.require('txOneSentenceRecognize');
txOneSentenceRecognize.stopRecognizeWithRecorder();

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

addEventListener

添加监听

addEventListener(callback(ret))

callback(ret)

ret:

  • 类型:JSON对象
  • 内部字段:
{
     eventType:'', //字符串类型;事件回调,取值范围如下:
                    //didRecognizeSuccess:一句话识别成功
                    //didRecognizeError:一一句话识别失败 (android不支持)
                    //didStartRecordSuccess:开始录音成功
                   //didStartRecordError:开始录音失败  (android不支持)
                  //didEndRecord:结束录音回调, SDK通过此方法回调后内部开始上报语音数据进行识别
                  //didUpdateVolume:录音音量实时回调用 (android不支持)
      text:'',     //字符串类型;识别结果文本; didRecognizeSuccess返回
        resultData:'',     //字符串类型;识别原始数据; didRecognizeSuccess、didRecognizeError返回 (android不支持)
      msg:'',      //字符串类型;错误信息;didRecognizeError、didStartRecordError返回
      audioFilePath:''//字符串类型;音频文件路径;didEndRecord返回 (android不支持)
     volume:0      //数字类型;声音音量,取值范围(-40-0);didUpdateVolume返回 (android不支持)

}

示例代码

var txOneSentenceRecognize = api.require('txOneSentenceRecognize');
txOneSentenceRecognize.addEventListener(function(ret) {
    api.alert({ msg:JSON.stringify(ret)});
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

removeEventListener

移除监听

removeEventListener()

示例代码

var txOneSentenceRecognize = api.require('txOneSentenceRecognize');
txOneSentenceRecognize.removeEventListener();

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本