语音合成CosyVoice Android SDK

• 汉字（包括简/繁体汉字、日文汉字和韩文汉字）按2个字符计算，其他所有字符（如标点符号、字母、数字、日韩文假名/谚文等）均按 1个字符计算

• 计算文本长度时，不包含SSML 标签内容

• 示例：

  • "你好" → 2(你)+2(好)=4字符

  • "中A文123" → 2(中)+1(A)+2(文)+1(1)+1(2)+1(3)=8字符

  • "中文。" → 2(中)+2(文)+1(。)=5字符

  • "中 文。" → 2(中)+1(空格)+2(文)+1(。)=6字符

  • "<speak>你好</speak>" → 2(你)+2(好)=4字符

文本编码格式

需采用UTF-8编码。

startStreamInputTts

启动双向流式语音合成，建立与服务端的连接，并注册回调以接收事件和音频数据。

此接口可能会引起阻塞，应在非UI线程调用。

• 方法签名

  public synchronized int startStreamInputTts(INativeStreamInputTtsCallback callback,
                                              String ticket,
                                              String parameters,
                                              String session_id,
                                              int log_level,
                                              boolean save_log)

• 参数说明

  参数	类型	说明
  callback	INativeStreamInputTtsCallback	事件和数据回调接口的实现。
  ticket	String	JSON字符串，包含鉴权、连接和调试参数。参见连接与控制参数。
  parameters	String	JSON字符串，包含语音合成的具体效果参数。参见语音合成效果参数。
  session_id	String	客户端指定的会话ID。若不传入，服务端将自动生成。
  log_level	int	控制SDK自身日志的打印级别。 取值范围： 0：LOG_LEVEL_VERBOSE 1：LOG_LEVEL_DEBUG 2：LOG_LEVEL_INFO 3：LOG_LEVEL_WARNING 4：LOG_LEVEL_ERROR 5：LOG_LEVEL_NONE（表示关闭此功能）
  save_log	boolean	是否保存本地日志。若为true，须在连接与控制参数中通过debug_path指定路径，并可通过max_log_file_size设置文件大小。

• 返回值说明

  返回错误码，参见错误码查询。

sendStreamInputTts

发送待合成的文本，与 startStreamInputTts 搭配使用。

在调用 startStreamInputTts 后，使用此接口持续发送文本。

所有文本发送完毕后，需调用stopStreamInputTts或asyncStopStreamInputTts来结束发送。

• 方法签名

  public synchronized int sendStreamInputTts(String text)

• 参数说明

  参数	类型	说明
  text	String	待合成文本。不支持SSML。如果传入的文本包含SSML标签，这些标签将被当作普通文本读出，不会被解析。

• 返回值说明

  返回错误码，参见错误码查询。

stopStreamInputTts

同步接口，通知服务端文本已全部发送，并阻塞等待所有音频数据合成并收到 STREAM_INPUT_TTS_EVENT_SYNTHESIS_COMPLETE。

阻塞等待的超时时间由参数 complete_waiting_ms 控制。

• 方法签名

  public synchronized int stopStreamInputTts()

• 返回值说明

  返回错误码，参见错误码查询。

asyncStopStreamInputTts

异步接口，通知服务端文本已全部发送。调用后立即返回，合成在后台继续进行。

通过 STREAM_INPUT_TTS_EVENT_SYNTHESIS_COMPLETE 事件判断合成是否完成。

• 方法签名

  public synchronized int asyncStopStreamInputTts()

• 返回值说明

  返回错误码，参见错误码查询。

cancelStreamInputTts

立即中断与服务端的连接并终止当前合成任务。调用后不会再收到任何音频数据回调。

• 方法签名

  public synchronized int cancelStreamInputTts()

• 返回值说明

  返回错误码，参见错误码查询。

playStreamInputTts

同步执行的一次性合成接口。该接口会发送文本、阻塞并等待接收所有音频数据，直到合成完成后才返回。无需再调用stop接口。

该接口默认启用SSML。如果在语音合成效果参数中显式设置enable_ssml，则以用户设置为准。

此接口应在非UI线程调用。

• 方法签名

  public synchronized int playStreamInputTts(INativeStreamInputTtsCallback callback,
                                             String ticket,
                                             String parameters,
                                             String text,
                                             String session_id,
                                             int log_level,
                                             boolean save_log)

• 参数说明

  callback、ticket等参数与startStreamInputTts接口中的定义相同。

  参数	类型	说明
  text	String	待合成文本。支持SSML。

• 返回值说明

  返回错误码，参见错误码查询。

asyncPlayStreamInputTts

异步执行的一次性合成接口。调用后立即返回，合成任务在后台进行，结果通过回调返回。无需再调用stop接口。

该接口默认启用SSML。如果在语音合成效果参数中显式设置enable_ssml，则以用户设置为准。

• 方法签名

  public synchronized int asyncPlayStreamInputTts(INativeStreamInputTtsCallback callback,
                                             String ticket,
                                             String parameters,
                                             String text,
                                             String session_id,
                                             int log_level,
                                             boolean save_log)

• 参数说明

  callback、ticket等参数与startStreamInputTts接口中的定义相同。

  参数	类型	说明
  text	String	待合成文本。支持SSML。

• 返回值说明

  返回错误码，参见错误码查询。

onStreamInputTtsEventCallback：监听事件

• 方法签名

  void onStreamInputTtsEventCallback(StreamInputTtsEvent event,
                                     String task_id,
                                     String session_id,
                                     int ret_code,
                                     String error_msg,
                                     String timestamp,
                                     String all_response);

• 参数说明

  参数	类型	说明
  event	StreamInputTtsEvent	回调事件。
  task_id	String	语音合成任务ID。
  session_id	String	会话ID。客户端传入则原样返回；未传入时由服务端生成。
  ret_code	int	错误码，仅在事件 STREAM_INPUT_TTS_EVENT_TASK_FAILED 中有效。参见错误码查询。
  error_msg	String	错误信息，仅在事件 STREAM_INPUT_TTS_EVENT_TASK_FAILED 中有效。
  timestamp	String	合成结果的时间戳信息。
  all_response	String	完整的 JSON 字符串响应。可解析以获取所需数据。

onStreamInputTtsDataCallback：监听音频数据

合成过程中，SDK 会连续触发此回调，需在回调中获取音频数据。

• 方法签名

  void onStreamInputTtsDataCallback(byte[] data);

• 参数说明

  参数	类型	说明
  data	byte[]	返回当前片段的音频数据，可用于： 合成完整的音频文件并播放。 通过支持流式播放的播放器实时播放。 注意： 对 mp3/opus 压缩格式，分段传输必须使用流式播放器，不能逐帧播放，否则可能解码失败。 组装完整文件时需采用追加模式写入同一文件。 对于 wav 和 mp3 格式，仅在第一次 onStreamInputTtsDataCallback 回调的数据中包含文件头，后续回调均为纯音频数据。处理时需将所有回调的 buffer 按顺序拼接。opus 格式的每一帧都是独立的 Ogg page，可直接拼接。

onStreamInputTtsLogTrackCallback：监听追踪日志

此回调用于接收 SDK 内部的详细日志，方便进行问题定位和调试。

default void onStreamInputTtsLogTrackCallback(Constants.LogLevel level, String log)