chivoxLongman

来自于:官方

概述

chivoxLongman 是一个语音在线评测的模块,能够对英文单词,句子以及段落,进行评测

initEngine

初始化引擎

initEngine(callback(ret))

params

appKey:

  • 类型:字符串
  • 描述:在驰声申请的appKey

secretKey:

  • 类型:字符串
  • 描述:在驰声平台申请的 secretKey

provisionPath:

  • 类型:字符串
  • 描述:开发证书存放的路径

serverPath:

  • 类型:字符串
  • 描述:服务器地址,如:wss://cloud.chivox.com:443

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status:true ,             //布尔类型;引擎初始化是否成功
}

示例代码

var chivoxLongman = api.require('chivoxLongman');
chivoxLongman.initEngine({
    appKey:'',
    secretKey:'',
    provisionPath:'',
    serverPath:''
},function(ret){
    if(ret.status){
        alert('引擎初始化成功');
    }
});

可用性

iOS 系统,Android 系统

可提供的 1.0.0 及更高版本

destroyEngine

销毁引擎

destroyEngine()

示例代码

     var chivoxLongman = api.require('chivoxLongman');
    chivoxLongman.destroyEngine();

可用性

iOS 系统,Android 系统

可提供的 1.0.0 及更高版本

startRecord

开始录音

startRecord(callback(ret))

params

savePath:

  • 类型:字符串
  • 描述:录音的保存途径(支持fs://),如fs://chivox(仅iOS支持)

androidSavePath:

  • 类型:字符串
  • 描述:录音的保存路径(支持fs://),例:fs://chivox/first.wav(仅andndroid支持)

userId:

  • 类型:字符串
  • 描述:(可选)应用中的用户标识

coreProvideType:

  • 类型:字符串
  • 描述:(可选)在线离线参数配置(cloud/native)
  • 默认:cloud

audioType:

  • 类型:字符串
  • 描述:(可选)应用中的用户标识,取值范围如下:(wav,mp3,flv,ogg)
  • 默认值:wav

sampleBytes:

  • 类型:数字
  • 描述:(可选)采样字节数
  • 默认:2
  • 取值范围:
    • 1 (单字节,8位)
    • 2 (双字节,16位)

sampleRate:

  • 类型:数字
  • 描述:(可选)采样率(要与实际音频一致)
  • 默认:16000
  • 备注:wav格式支持16kHZ mp3/flv/ogg格式支持 16kHZ 22kHZ 44kHZ

coreType:

  • 类型:字符串
  • 描述:(可选)请求内核的类型(仅iOS支持)
  • 默认:en.sent.score
  • 取值范围:
    • cn.word.raw
    • cn.sent.raw
    • cn.pred.raw
    • en.sent.score

rank:

  • 类型:数字
  • 描述:(可选)分制(仅iOS支持)
  • 默认:100
  • 取值范围:
    • 100 (百分制)
    • 4 (四分制)

refText:

  • 类型:字符串
  • 描述:待评测的文本 (仅iOS支持)

attachAudioUrl:

  • 类型:数字类型
  • 描述:音频下载路径,取值范围0和1,默认为0(0代表不开启音频下载功能,1代表开启音频下载功能。为减小体积,用户音频进行了格式压缩,默认格式为 ogg; 如果需要下载 MP3 格式的音频,需设置音频格式为mp3)(仅iOS支持)
  • 默认:1

channel:

  • 类型:数字类型
  • 描述:声道,目前只支持单声道,只能填1

request:

  • 类型:JSON对象类型
  • 描述:内核参数,参考内核说明文档(仅android支持)

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
   status:,              //布尔类型;是否成功
   realPath: ''          // 字符串类型; 语音保存路径(仅iOS支持)
   responseData: ''          // 字符串类型; 评测返回数据
}

err:

  • 类型:JSON对象
  • 内部字段:
{
    code:60010            //数字类型;错误码
}

示例代码

var chivoxLongman = api.require('chivoxLongman');
chivoxLongman.startRecord({ 
    savePath: 'fs://chivox',
    userId:'test',
    coreProvideType:'cloud',
    audioType:'wav',
    sampleRate:16000,
    sampleBytes:2,
    refText:'This is a test message',
    coreType:'en.sent.score',
    rank:100,
    attachAudioUrl:1,
    channel:1,
    request:{},
}, function(ret,err){
    if (ret.status) {
       api.alert({msg:JSON.stringify(ret)});
    } else {
       api.alert({msg:JSON.stringify(err)});
    }
});

可用性

iOS 系统,Android 系统

可提供的 1.0.0 及更高版本

stopRecord

停止录音

stopRecord()

示例代码

     var chivoxLongman = api.require('chivoxLongman');
    chivoxLongman.stopRecord();

可用性

iOS 系统,Android 系统

可提供的 1.0.0 及更高版本