rsRecognition

立即使用

概述

本模块封装了阿里云智能语音实时语音识别SDK

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

模块接口

init

初始化

init({params},callback(ret))

params

initParams:

  • 类型:JSON对象
  • 描述:初始化参数
  • 内部字段:
{
    app_key:'',   //字符串类型;控制台(https://homenew.console.aliyun.com/home/dashboard/ProductAndService)创建项目的appkey
    token:'',   //字符串类型;token,请确保该token可以使用并在有效期内
    device_id:''  //字符串类型;设备标识,唯一表示一台设备
}

params:

  • 类型:JSON对象
  • 描述:(可选项)设置SDK参数,参见接口说明文档,其中service_type已设置为0,不可修改

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
   code: 0        //数字类型;初始化结果,参考接口说明文档
}

示例代码

var rsRecognition = api.require('rsRecognition');
rsRecognition.init({
  initParams:{
    appKey:'',
    token:'',
    deviceId:''
  }
},function(ret){        
    alert(JSON.stringify(ret));
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

start

开始识别

start()

示例代码

var rsRecognition = api.require('rsRecognition');
rsRecognition.start();

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

cancel

结束识别,调用该接口后,服务端将返回最终识别结果并结束任务

cancel({params})

params

force:

  • 类型:布尔
  • 描述:(可选项)是否强制结束而忽略最终结果,false表示停止但是等待完整结果返回
  • 默认:false

示例代码

var rsRecognition = api.require('rsRecognition');
rsRecognition.cancel({
    force: false 
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

release

释放SDK

release()

示例代码

var rsRecognition = api.require('rsRecognition');
rsRecognition.release();

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

addEventListener

添加监听

addEventListener(callback(ret))

callback(ret)

ret:

  • 类型:JSON对象
  • 内部字段:
{
     eventType:'',      //字符串类型;事件回调,取值范围如下:
                        //onNuiEventCallback:SDK事件回调
                        //onNuiRmsChanged:音频能量事件
                        //recorderDidStart:录音启动
                        //recorderDidStop:录音停止
                        //voiceDidFail:录音失败
    result    :'',            //字符串类型;语音识别结果;onNuiEventCallback返回
    finish    :true,        //布尔类型;本轮识别是否结束标志;onNuiEventCallback返回
    code:0,             //数字类型;错误码;onNuiEventCallback返回
    nuiEvent:'',       //字符串类型;回调事件,;onNuiEventCallback返回;取值如下:
                           //vadStart:检测到人声起点
                           //vadEnd:检测到人声尾点
                           //partialResult:语音识别中间结果
                           //    asrResult:语音识别最终结果
                           //    asrError:识别出错
                           //micError:录音错误  
                           //sentenceStart:实时语音识别事件,检测到一句话开始
                           //sentenceEnd:实时语音识别事件,检测一句话结束,返回一句的完整结果
                           //transcriberComplete:停止语音识别后上报
    rms:0,              //数字类型;语音能量值,范围为-160至0;onNuiRmsChanged返回                                  

}

示例代码

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

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

removeEventListener

移除监听

removeEventListener()

示例代码

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

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

getToken

获取token

getToken({params},callback(ret))

params

accessKey:

accessSecret:

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
   token: ''        //字符串类型类型;token
}

示例代码

var rsRecognition = api.require('rsRecognition');
rsRecognition.getToken({
  accessKey:'',
  accessSecret:''
},function(ret){        
    alert(JSON.stringify(ret));
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本