aliyunTTS

init

setParam

getParam

play

cancel

pause

resume

release

addEventListener

removeEventListener

getToken

概述

本原生插件封装了阿里云智能语音语音合成SDK

注意：本原生插件 iOS 平台上最低适配系统版本为 iOS 11.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:'',  //字符串类型；设备标识，唯一表示一台设备
       url:'',  //（可选项）字符串类型；url；默认：'wss://nls-gateway.cn-shanghai.aliyuncs.com:443/ws/v1'

}

callback(ret)

ret：

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

示例代码

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

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

setParam

设置语音合成参数

setParam({params},callback(ret))

params

key：

  • 类型：字符串
  • 描述：参数名，参考接口说明

value：

  • 类型：字符串
  • 描述：参数值，参考接口说明

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
{
   code: 0        //数字类型；调用结果，参考接口说明文档
}

示例代码

var aliyunTTS = api.require('aliyunTTS');
aliyunTTS.setParam({
    key:'',
    value:'',
},function(ret){		
    api.alert({
            msg: JSON.stringify(ret)
        })
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本 注意：setParam()在开始播放之前调用有效

getParam

获取语音合成参数

getParam({params},callback(ret))

params

key：

  • 类型：字符串
  • 描述：参数名，参考接口说明

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
{
   code: 0        //数字类型；调用结果，参考接口说明文档
}

示例代码

var aliyunTTS = api.require('aliyunTTS');
aliyunTTS.getParam({
    key:''
},function(ret){		
    api.alert({
            msg: JSON.stringify(ret)
        })
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

play

开始播放

play({params},callback(ret))

params

text：

  • 类型：字符串
  • 描述：要播放的文本内容

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
{
   code: 0        //数字类型；调用结果，参考接口说明文档
}

示例代码

var aliyunTTS = api.require('aliyunTTS');
aliyunTTS.play({
    text:''
},function(ret){		
    api.alert({
            msg: JSON.stringify(ret)
        })
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

cancel

取消播放

cancel(callback(ret))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
{
   code: 0        //数字类型；调用结果，参考接口说明文档
}

示例代码

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

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

pause

暂停播放

pause(callback(ret))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
{
   code: 0        //数字类型；调用结果，参考接口说明文档
}

示例代码

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

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

resume

恢复播放

resume(callback(ret))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
{
   code: 0        //数字类型；调用结果，参考接口说明文档
}

示例代码

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

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

release

释放SDK资源

release(callback(ret))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
{
   code: 0        //数字类型；调用结果，参考接口说明文档
}

示例代码

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

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

addEventListener

添加监听

addEventListener(callback(ret))

callback(ret)

ret:

  • 类型：JSON对象
  • 内部字段：
{
     eventType:'',      //字符串类型；事件回调，取值范围如下：
                        //onNuiTtsEventCallback:SDK事件回调
                        //onNuiTtsVolumeCallback:合成数据音量回调
                        //playerDidFinish:数据完成播放回调
    nuiEvent:'',       //字符串类型；回调事件，；onNuiTtsEventCallback返回;取值如下：
                           //start:语音合成开始，准备播放
                           //end:语音合成播放结束
                           //cancel:取消语音合成
                           //pause:语音合成暂停
                           //resume:语音合成恢复
                           //error:语音合成发生错误 
    code:0,             //数字类型；错误码；onNuiTtsEventCallback返回                        
    volume:0,              //数字类型；合成的语音的能量；onNuiTtsVolumeCallback返回                                  

}

示例代码

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

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

removeEventListener

移除监听

removeEventListener()

示例代码

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

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

getToken

获取token

getToken({params},callback(ret))

params

accessKey：

accessSecret：

callback(ret)

ret：

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

示例代码

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

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

是否仍需要帮助？ 请保持联络！
最后更新于 2024/07/31