云知声口语评测服务H5 SDK API文档

调用流程
可设参数
函数列表
回调函数
示例demo
错误码说明

response headers

调用流程

可设置参数（[]中是可选参数）

option 配置选项
option.userId 用户Id
[option.host] 评测服务器地址 default edu.hivoice.cn
[option.port] 评测服务器端口号 default ''
[opt.hostCn] 评测服务器地址 default cn-edu.hivoice.cn
[opt.portCn] 评测服务器端口号 default ''
[option.useFlash] 启用flash录音
[option.mode] 评测模式（包含A B C D E G H，A B D H 是常用模式） default E
[option.scoreCoefficient] 分数调整定制参数，可以对同样质量的语音调整得分高低，范围是0.6~1.9，默认情况下是1.0，设置越低，打分越严格，
[option.audioFormat] //上传的音频格式 16k16bit 32kpbs 单声道opus格式
[option.useSelfAudio] 如果设置为true, 将不使用内置录音(不加载录音相关组件), 调用evaluate接口进行文件评测
[option.autoStop] 根据文本长度自动停止可选值true/(1~6之间的整数或小数) 默认:false (true等价于3) 当文本长度小于60时autoStop秒后停止，大于60时根据文本长度计算停止时间，autoStop数字越大录音时间越长
[option.debug] 开启日志打印

函数列表

function EvalSDK(option)


说明	创建评测对象
参数addr	以上@param中可设置参数

function start(text, mode, language)


说明	开始录音方法
参数text	评测文本
参数mode	评测模式
参数language	语言种类有效值[en/cn]
说明：当使用中文模式[cn]时 text如果不是json则将强制转为json对象 {"DisplayText":"text"}

function stop()


说明	停止录音并开始评测
参数	---
返回值	Promise data //{text, mode, sessionId, mp3},函数返回可以忽略

function setServerAddr(host)


说明	设置评测服务器地址,setAudioFormat会将设置的地址重置
参数addr	评测服务器地址，如: http://edu.hivoice.cn:8085/eval/opus

function setAudioFormat(format)


说明	上传的音频格式,会将setServerAddr设置的地址重置
参数format	音频格式，可选值为: mp3 , opus , amrnb

function setScoreCoefficient(score)


说明	分数调整定制参数，可以对同样质量的语音调整得分高低
参数score	范围是0.6~1.9，默认情况下是1.0,设置越低，打分越严格，设置系数越高

function setMode(mode)


说明	评测模式
参数mode	包含A B C D E G H，A B D H 是常用模式 A：最简单模式，结果只有单词打分没有音素信息； B：有音素信息，但是没有音素打分； C：跟A一样，区别是最外层有Score总分; D：在B的基础上，有音素打分; E：返回words字段里的值，有空格和标点符号，但是没有音素打分(针对个别客户需求); G：跟D一样; H：选择题打分模式

说明

评测模式

参数mode

包含A B C D E G H，A B D H 是常用模式
A：最简单模式，结果只有单词打分没有音素信息；
B：有音素信息，但是没有音素打分；
C：跟A一样，区别是最外层有Score总分;
D：在B的基础上，有音素打分;
E：返回words字段里的值，有空格和标点符号，但是没有音素打分(针对个别客户需求);
G：跟D一样;
H：选择题打分模式

function evaluate(text, voice, mode, language)


说明	进行评测
参数text	评测文本
参数voice	评测音频, SDK录音只支持opus,如果使用本地音频评测请注意设置setAudioFormat
参数mode	评测模式
参数language	语言种类有效值[en/cn] 说明：当使用中文模式[cn]时 text如果不是json则将强制转为json对象 {"DisplayText":"text"}
返回值	json格式评测结果

function getBlob()


说明	获取本地Mp3 (废弃)
参数	---
返回值	二进制mp3文件

function getSoundUrl()


说明	获取音频地址
参数	---
返回值	音频URL地址

function getResultUrl()


说明	获取评测结果地址
参数	---
返回值	评测结果地址

function playLocal()


说明	播放本地音频
参数	---
返回值	---

function stopPlayLocal()


说明	停止播放
参数	---
返回值	---

回调函数

function onReady()


说明	jsSDK 准备好后回调函数
参数	---
返回值	---

function onStart(sessionId)


说明	开始录音回调函数
参数sessionId	表示该次评测的唯一标识
返回值	---

function onStop(e)


说明	停止录音回调函数
参数e	回调事件
返回值	{"text":"评测文本", "mode": "评测模式", "sessionId": "sessionId"

function onError(err)


说明	错误回调
参数err	获取错误码
返回值	错误码

function onResult(result)


说明	评测成功返回
参数result	获取结果
返回值	result和url

function onPlayLocal()


说明	播放本地音频回调函数
参数	---

function onStopPlayLocal()


说明	本地音频播放结束回调函数
参数	---

示例demo

    var recorder    = new EvalSDK({
      userId          :  "AE8F62A7-DDAE-4FD3-ADD4-D0280CEA3EDE";
      scoreCoefficient:  "1.0";
      mode            :  "G";
      debug           :  true
    })

错误码说明


错误码	错误码描述
1001	传入的评测文本为空
1002	没有上传音频，是在文件评测的时候出现
1003	没有网络
1004	传入评测过程服务端返回的错误码
1005	没有录音
1006	文本过长，最长支持16000字符
1007	打分系数设置错误，可选范围0.6-1.9
1008	评测模式设置错误，可以设置的值A、B、C、E、G、H
1009	音频格式错误，可选值为: mp3 , opus , amrnb
1010	未设置评测服务地址或评测地址错误
1011	无法打开麦克风，请使用https协议。Only secure origins are allowed(see https://goo.gl/Y0ZkNV)
1012	用户拒绝访问麦克风
1013	浏览器不支持录音
1014	找不到麦克风设备
1015	无法打开麦克风
1016	获取音频失败
1017	解析失败

以上1004返回的服务端错误码可以参照 服务端错误码说明

ouxxyy/H5_SDK_DOC