下载文档

uexXunfei
更新时间:2016-08-08

1、简介

科大讯飞语音插件

1.1、说明

封装了科大讯飞语音识别和语音合成的相关功能,两个功能都需要在线合成

插件为单例插件,所有的回调函数将会回调到调用init()所在的Window
如:在root页面调用uexXunfei.init(),则回调都会发送到root window

1.2、开源源码及自定义插件下载

点击至插件详情页(插件测试用例与插件包已经提供)
(自定义beta版插件下载上传到我的插件勾选使用)

2、 API预览

2.1、 方法

init 初始化

uexXunfei.init(param)

说明

初始化

回调 cbInit

参数

参数名称 参数类型 是否必选 说明
param String param是json字符串,详情见下
  1. var param = {
  2. appID;//(必选,String)讯飞APPID
  3. }

平台支持

Android 2.2+
iOS 6.0+

版本支持

Android 3.0.0+
iOS 3.0.0+

示例

  1. function init(){
  2. var params = {
  3. appID:"56710b9c"
  4. };
  5. var data = JSON.stringify(params);
  6. uexXunfei.init(data);
  7. }

initSpeaker 初始化语音合成

uexXunfei.initSpeaker(param)

说明

初始化语音合成接口,只需要调用一次。不使用语音合成相关功能则不需要调用

参数

参数名称 参数类型 是否必选 说明
param String param是json字符串,详情见下
  1. var param={
  2. voiceName;//设置发音人,默认是"xiaoyan" String类型 可以不传
  3. speed;//设置语速,默认是"50" String类型 可以不传
  4. volume;//设置音量,默认是"80" String类型 可以不传
  5. }

发音人的可选列表见链接的附录栏

平台支持

Android 2.2+
iOS 6.0+

版本支持

Android 3.0.0+
iOS 3.0.0+

示例

  1. function initSpeaker(){
  2. var params = {
  3. };
  4. var data = JSON.stringify(params);
  5. uexXunfei.initSpeaker(data);
  6. }

startSpeaking 开始语音合成

uexXunfei.startSpeaking(param)

参数

参数名称 参数类型 是否必选 说明
param String param是json字符串,详情见下
  1. var param={
  2. text;//要合成语音的文字(String类型,必选)
  3. }

平台支持

Android 2.2+
iOS 6.0+

版本支持

Android 3.0.0+
iOS 3.0.0+

示例

  1. function startSpeaking(){
  2. var params = {
  3. text:"测试讯飞"
  4. };
  5. var data = JSON.stringify(params);
  6. uexXunfei.startSpeaking(data);
  7. }

stopSpeaking 停止语音合成

uexXunfei.stopSpeaking()

参数

平台支持

Android 2.2+
iOS 6.0+

版本支持

Android 3.0.0+
iOS 3.0.0+

示例

  1. uexXunfei.stopSpeaking();

pauseSpeaking 暂停语音合成

uexXunfei.pauseSpeaking()

参数

平台支持

Android 2.2+
iOS 6.0+

版本支持

Android 3.0.0+
iOS 3.0.0+

示例

  1. uexXunfei.pauseSpeaking();

resumeSpeaking 继续语音合成

uexXunfei.resumeSpeaking()

参数

平台支持

Android 2.2+
iOS 6.0+

版本支持

Android 3.0.0+
iOS 3.0.0+

示例

  1. uexXunfei.resumeSpeaking();

initRecognizer 初始化语音识别

uexXunfei.initRecognizer()

说明

初始化语音识别,该接口只需要调用一次。如果不需要用到语音识别的功能,则不需要调用

参数

参数名称 参数类型 是否必选 说明
param String param是json字符串,详情见下
  1. var param={
  2. domain;//设置应用领域 (String类型,可选)
  3. //短信和日常用语:iat (默认)
  4. //视频:video
  5. //地图:poi
  6. //音乐:music(String类型,必选)
  7. language;//设置语言 默认"zh_cn"(String类型。可选)
  8. //当前支持:
  9. //简体中文:zh_cn(默认)
  10. //美式英文:en_us
  11. accent;//设置方言,默认"mandarin" (String类型,可选)
  12. //当前支持的中文方言有:
  13. //普通话:mandarin(默认)
  14. //粤 语:cantonese
  15. //四川话:lmz
  16. //河南话:henanese
  17. }

平台支持

Android 2.2+
iOS 6.0+

版本支持

Android 3.0.0+
iOS 3.0.0+

示例

  1. function initRecognizer(){
  2. var params = {
  3. };
  4. var data = JSON.stringify(params);
  5. uexXunfei.initRecognizer(data);
  6. }

startListening 开始语音识别

uexXunfei.startListening(param)

平台支持

iOS 6.0+

版本支持

iOS 3.0.0+

示例

  1. function startListening(){
  2. var params = {
  3. };
  4. var data = JSON.stringify(params);
  5. uexXunfei.startListening(data);
  6. }

stopListening 停止语音识别

uexXunfei.stopListening()

参数

平台支持

Android 2.2+
iOS 6.0+

版本支持

Android 3.0.0+
iOS 3.0.0+

示例

  1. uexXunfei.stopListening();

cancelListening 取消语音识别

uexXunfei.cancelListening()

参数

平台支持

Android 2.2+
iOS 6.0+

版本支持

Android 3.0.0+
iOS 3.0.0+

示例

  1. uexXunfei.cancelListening();

2.2、 回调方法

cbInit 初始化完成的回调方法

uexXunfei.cbInit(param)

说明

初始化完成之后会触发此回调

参数

参数名称 参数类型 是否必选 说明
param String param是json字符串,详情见下
  1. var param={
  2. result:,// true/false 插件初始化是否成功
  3. }

示例

  1. function cbInit(info){
  2. alert('cbInit: '+info);
  3. }

2.3、 监听方法

onSpeakBegin 语音合成开始

uexXunfei.onSpeakBegin()

参数

平台支持

Android 2.2+
iOS 6.0+

版本支持

Android 3.0.0+
iOS 3.0.0+

示例

  1. function onSpeakBegin(info){
  2. alert('onSpeakBegin: '+info);
  3. }

onSpeakPaused 语音合成暂停

uexXunfei.onSpeakPaused()

参数

平台支持

Android 2.2+
iOS 6.0+

版本支持

Android 3.0.0+
iOS 3.0.0+

示例

  1. function onSpeakPaused(info){
  2. alert('onSpeakPaused: '+info);
  3. }

onSpeakResumed 语音合成继续

uexXunfei.onSpeakResumed()

参数

平台支持

Android 2.2+
iOS 6.0+

版本支持

Android 3.0.0+
iOS 3.0.0+

示例

  1. function onSpeakResumed(info){
  2. alert('onSpeakResumed: '+info);
  3. }

onSpeakComplete 语音合成完成

uexXunfei.onSpeakComplete()

参数

平台支持

Android 2.2+
iOS 6.0+

版本支持

Android 3.0.0+
iOS 3.0.0+

示例

  1. function onSpeakComplete(info){
  2. alert('onSpeakComplete: '+info);
  3. }

onRecognizeError 语音识别出错

uexXunfei.onRecognizeError()

参数

参数名称 参数类型 是否必选 说明
param String param是json字符串,详情见下
  1. var param={
  2. errorCode:,// 错误码
  3. errorDesc:,// 错误描述
  4. errorType:,// 错误码类型
  5. }

平台支持

Android 2.2+
iOS 6.0+

版本支持

Android 3.0.0+
iOS 3.0.0+

示例

  1. function onRecognizeError(info){
  2. alert('onRecognizeError: '+info);
  3. }

onBeginOfSpeech 开始语音识别

uexXunfei.onBeginOfSpeech()

参数

平台支持

Android 2.2+
iOS 6.0+

版本支持

Android 3.0.0+
iOS 3.0.0+

示例

  1. function onBeginOfSpeech(info){
  2. alert('onBeginOfSpeech: '+info);
  3. }

onEndOfSpeech 语音识别完成

uexXunfei.onEndOfSpeech()

参数

平台支持

Android 2.2+
iOS 6.0+

版本支持

Android 3.0.0+
iOS 3.0.0+

示例

  1. function onEndOfSpeech(info){
  2. alert('onEndOfSpeech: '+info);
  3. }

onRecognizeResult 语音识别的结果(可能会多次回调)

uexXunfei.onRecognizeResult()

参数

参数名称 参数类型 是否必选 说明
json String param是json字符串,详情见下
  1. var json = {"sn":1,"ls":true,"bg":0,"ed":0,"ws":[{"bg":0,"cw":[{"w":" 今天 ","sc":0}]},{"bg":0,"cw":[{"w":" 的","sc":0}]},{"bg":0,"cw":[{"w":" 天气 ","sc":0}]},{"bg":0,"cw":[{"w":" 怎么样 ","sc":0}]},{"bg":0,"cw":[{"w":" 。","sc":0}]}]};

各字段含义如下

JSON字段 英文全称 类型 说明
sn sentence number 第几句
ls last sentence bool 是否最后一句
bg begin number 开始
ed end number 结束
ws words array
cw chinese word array 中文分词
w word String 单字
sc score number 分数

平台支持

Android 2.2+
iOS 6.0+

版本支持

Android 3.0.0+
iOS 3.0.0+

示例

  1. function onRecognizeResult(info){
  2. alert('onRecognizeResult: '+info);
  3. }

3、 附录

AppID申请

AppID申请需要在讯飞官网申请完成。创建应用之后需要开通语音听写 在线语音合成。 创建一个应用时,会自动关联一个Appid,Appid和对应的SDK具有一致性,故iOS插件建议在讯飞开放平台创建应用,生成Appid,并选中组合服务SDK下载,勾选语音听写 在线语音合成,下载自定义sdk,用下载的sdk中的iflyMSC.framework替换掉插件包中的framework,作为自定义插件包使用。对于Android插件,开发者需要从讯飞官网下载应用对应的sdk,下载完成后,用sdk中的libs目录下的Msc.jar, Sunflower.jar替换插件包中的jar目录下的这两个文件,将sdk中的libs/armeabilibmsc.so替换插件包中的so目录下的文件。

4、更新历史

iOS

API版本:uexXunfei-3.0.2

最近更新时间:2016-7-8

历史发布版本 更新内容
3.0.2 添加语音识别功能
3.0.1 添加iflyMSC.framework
3.0.0 新增uexXunfei插件

Android

API版本:uexXunfei-3.0.1

最近更新时间:2016-7-8

历史发布版本 更新内容
3.0.1 添加语音识别功能
3.0.0 初始化版本