全部产品
云市场

Java SDK 2.0

更新时间:2019-10-12 13:50:40

提示:

下载安装

可从maven 服务器下载最新版本SDK:

  1. <dependency>
  2. <groupId>com.alibaba.nls</groupId>
  3. <artifactId>nls-sdk-tts</artifactId>
  4. <version>2.1.0</version>
  5. </dependency>

使用方式参见下面代码示例。Demo 源码下载链接

demo 解压后,在pom 目录运行mvn package ,会在target目录生成可执行jarnls-example-tts-2.0.0-jar-with-dependencies.jar将此jar拷贝到目标服务器,可用于快速验证及压测服务。

服务验证

java -cp nls-example-tts-2.0.0-jar-with-dependencies.jar com.alibaba.nls.client.SpeechSynthesizerDemo并按提示提供相应参数,运行后在命令执行目录生成logs/nls.log

服务压测

java -jar nls-example-tts-2.0.0-jar-with-dependencies.jar并按提示提供相应参数,其中阿里云服务url参数为: wss://nls-gateway.cn-shanghai.aliyuncs.com/ws/v1 ,并发数根据用户已购买并发谨慎选择。

温馨提示:自行压测超过2并发会产生费用。

关键接口

  • NlsClient:语音处理client,相当于所有语音相关处理类的factory,全局创建一个实例即可。线程安全。
  • SpeechSynthesizer:语音合成处理类,设置请求参数,发送请求。非线程安全。
  • SpeechSynthesizerListener:语音合成监听类,监听返回结果。非线程安全。有如下两个抽象方法需要实现:
    1. /**
    2. * 接收语音合成二进制数据
    3. */
    4. abstract public void onMessage(ByteBuffer message);
    5. /**
    6. * 语音合成结束事件通知
    7. *
    8. * @param response
    9. */
    10. abstract public void onComplete(SpeechSynthesizerResponse response);

更多介绍参见API文档链接: Java API接口说明

SDK 调用注意事项

  1. NlsClient对象创建一次可以重复使用,每次创建消耗性能。NlsClient使用了netty的框架,创建时比较消耗时间和资源,但创建之后可以重复利用。建议调用程序将NlsClient的创建和关闭与程序本身的生命周期结合。
  2. SpeechSynthesizer对象不能重复使用,一个语音合成任务对应一个SpeechSynthesizer对象。例如有N个文本需要语音合成,则要进行N次语音合成任务,创建N个SpeechSynthesizer对象。
  3. 实现的SpeechSynthesizerListener对象和SpeechSynthesizer对象是一一对应的,不能将一个SpeechSynthesizerListener对象设置到多个SpeechSynthesizer对象中,否则不能区分是哪个语音合成任务。
  4. Java SDK依赖了Netty网络库,版本需设置为4.1.17.Final及以上。如果您的应用中依赖了Netty,请确保版本符合要求。

代码示例

说明1:Demo中使用了SDK内置的默认语音合成服务的外网访问URL,如果您使用阿里云上海ECS并想使用内网访问URL,则在创建NlsClient对象时,设置内网访问的URL:

  1. client = new NlsClient("ws://nls-gateway.cn-shanghai-internal.aliyuncs.com/ws/v1", accessToken);

说明2:Demo中将合成的音频保存在了文件中,如果您需要播放音频且对实时性要求较高,建议使用流式播放,即边接收语音数据边播放,减少延时。

示例:

  1. import java.io.File;
  2. import java.io.FileOutputStream;
  3. import java.io.IOException;
  4. import java.nio.ByteBuffer;
  5. import com.alibaba.nls.client.protocol.NlsClient;
  6. import com.alibaba.nls.client.protocol.OutputFormatEnum;
  7. import com.alibaba.nls.client.protocol.SampleRateEnum;
  8. import com.alibaba.nls.client.protocol.tts.SpeechSynthesizer;
  9. import com.alibaba.nls.client.protocol.tts.SpeechSynthesizerListener;
  10. import com.alibaba.nls.client.protocol.tts.SpeechSynthesizerResponse;
  11. import org.slf4j.Logger;
  12. import org.slf4j.LoggerFactory;
  13. /**
  14. * 此示例演示了
  15. * 语音合成API调用
  16. * 动态获取token
  17. * 流式合成TTS
  18. * 首包延迟计算
  19. * (仅作演示,需用户根据实际情况实现)
  20. */
  21. public class SpeechSynthesizerDemo {
  22. private static final Logger logger = LoggerFactory.getLogger(SpeechSynthesizerDemo.class);
  23. private static long startTime;
  24. private String appKey;
  25. NlsClient client;
  26. public SpeechSynthesizerDemo(String appKey, String accessKeyId, String accessKeySecret) {
  27. this.appKey = appKey;
  28. //TODO 重要提示 创建NlsClient实例,应用全局创建一个即可,生命周期可和整个应用保持一致,默认服务地址为阿里云线上服务地址
  29. //TODO 这里简单演示了获取token 的代码,该token会过期,实际使用时注意在accessToken.getExpireTime()过期前再次获取token
  30. AccessToken accessToken = new AccessToken(accessKeyId, accessKeySecret);
  31. try {
  32. accessToken.apply();
  33. System.out.println("get token: " + accessToken.getToken() + ", expire time: " + accessToken.getExpireTime());
  34. client = new NlsClient(accessToken.getToken());
  35. } catch (IOException e) {
  36. e.printStackTrace();
  37. }
  38. }
  39. public SpeechSynthesizerDemo(String appKey, String accessKeyId, String accessKeySecret, String url) {
  40. this.appKey = appKey;
  41. //TODO 重要提示 创建NlsClient实例,应用全局创建一个即可,生命周期可和整个应用保持一致,默认服务地址为阿里云线上服务地址
  42. //TODO 这里简单演示了获取token 的代码,该token会过期,实际使用时注意在accessToken.getExpireTime()过期前再次获取token
  43. AccessToken accessToken = new AccessToken(accessKeyId, accessKeySecret);
  44. try {
  45. accessToken.apply();
  46. System.out.println("get token: " + accessToken.getToken() + ", expire time: " + accessToken.getExpireTime());
  47. if(url.isEmpty()) {
  48. client = new NlsClient(accessToken.getToken());
  49. }else {
  50. client = new NlsClient(url, accessToken.getToken());
  51. }
  52. } catch (IOException e) {
  53. e.printStackTrace();
  54. }
  55. }
  56. private static SpeechSynthesizerListener getSynthesizerListener() {
  57. SpeechSynthesizerListener listener = null;
  58. try {
  59. listener = new SpeechSynthesizerListener() {
  60. File f=new File("tts_test.wav");
  61. FileOutputStream fout = new FileOutputStream(f);
  62. private boolean firstRecvBinary = true;
  63. //语音合成结束
  64. @Override
  65. public void onComplete(SpeechSynthesizerResponse response) {
  66. // TODO 当onComplete时表示所有TTS数据已经接收完成,因此这个是整个合成延迟,该延迟可能较大,未必满足实时场景
  67. System.out.println("name: " + response.getName() +
  68. ", status: " + response.getStatus()+
  69. ", output file :"+f.getAbsolutePath()
  70. );
  71. }
  72. //语音合成的语音二进制数据
  73. @Override
  74. public void onMessage(ByteBuffer message) {
  75. try {
  76. if(firstRecvBinary) {
  77. // TODO 此处是计算首包语音流的延迟,收到第一包语音流时,即可以进行语音播放,以提升响应速度(特别是实时交互场景下)
  78. firstRecvBinary = false;
  79. long now = System.currentTimeMillis();
  80. logger.info("tts first latency : " + (now - SpeechSynthesizerDemo.startTime) + " ms");
  81. }
  82. byte[] bytesArray = new byte[message.remaining()];
  83. message.get(bytesArray, 0, bytesArray.length);
  84. fout.write(bytesArray);
  85. } catch (IOException e) {
  86. e.printStackTrace();
  87. }
  88. }
  89. @Override
  90. public void onFail(SpeechSynthesizerResponse response){
  91. // TODO 重要提示: task_id很重要,是调用方和服务端通信的唯一ID标识,当遇到问题时,需要提供此task_id以便排查
  92. System.out.println(
  93. "task_id: " + response.getTaskId() +
  94. //状态码 20000000 表示识别成功
  95. ", status: " + response.getStatus() +
  96. //错误信息
  97. ", status_text: " + response.getStatusText());
  98. }
  99. };
  100. } catch (Exception e) {
  101. e.printStackTrace();
  102. }
  103. return listener;
  104. }
  105. public void process() {
  106. SpeechSynthesizer synthesizer = null;
  107. try {
  108. //创建实例,建立连接
  109. synthesizer = new SpeechSynthesizer(client, getSynthesizerListener());
  110. synthesizer.setAppKey(appKey);
  111. //设置返回音频的编码格式
  112. synthesizer.setFormat(OutputFormatEnum.WAV);
  113. //设置返回音频的采样率
  114. synthesizer.setSampleRate(SampleRateEnum.SAMPLE_RATE_16K);
  115. //发音人
  116. synthesizer.setVoice("siyue");
  117. //语调,范围是-500~500,可选,默认是0
  118. synthesizer.setPitchRate(100);
  119. //语速,范围是-500~500,默认是0
  120. synthesizer.setSpeechRate(100);
  121. //设置用于语音合成的文本
  122. synthesizer.setText("欢迎使用阿里巴巴智能语音合成服务,您可以说北京明天天气怎么样啊");
  123. //此方法将以上参数设置序列化为json发送给服务端,并等待服务端确认
  124. long start = System.currentTimeMillis();
  125. synthesizer.start();
  126. logger.info("tts start latency " + (System.currentTimeMillis() - start) + " ms");
  127. SpeechSynthesizerDemo.startTime = System.currentTimeMillis();
  128. //等待语音合成结束
  129. synthesizer.waitForComplete();
  130. logger.info("tts stop latency " + (System.currentTimeMillis() - start) + " ms");
  131. } catch (Exception e) {
  132. e.printStackTrace();
  133. } finally {
  134. //关闭连接
  135. if (null != synthesizer) {
  136. synthesizer.close();
  137. }
  138. }
  139. }
  140. public void shutdown() {
  141. client.shutdown();
  142. }
  143. public static void main(String[] args) throws Exception {
  144. String appKey = "填写你的appkey";
  145. String id = "填写你在阿里云网站上的AccessKeyId";
  146. String secret = "填写你在阿里云网站上的AccessKeySecret";
  147. String url = ""; // 默认即可,默认值:wss://nls-gateway.cn-shanghai.aliyuncs.com/ws/v1
  148. if (args.length == 3) {
  149. appKey = args[0];
  150. id = args[1];
  151. secret = args[2];
  152. } else if (args.length == 4) {
  153. appKey = args[0];
  154. id = args[1];
  155. secret = args[2];
  156. url = args[3];
  157. } else {
  158. System.err.println("run error, need params(url is optional): " + "<app-key> <AccessKeyId> <AccessKeySecret> [url]");
  159. System.exit(-1);
  160. }
  161. SpeechSynthesizerDemo demo = new SpeechSynthesizerDemo(appKey, id, secret, url);
  162. demo.process();
  163. demo.shutdown();
  164. }
  165. }