本文介绍 Qwen-Audio-TTS 实时语音合成服务通过 WebSocket 推送给客户端的服务端事件,包括 task-started、result-generated、task-finished、task-failed 四类事件的数据结构与字段含义。
事件交互流程
- 发送 run-task 启动并配置任务,等待 task-started。
- 收到
task-started后,通过 continue-task 发送文本,同时接收 result-generated 和合成音频。 - 文本全部发送完毕后,发送 finish-task,继续接收剩余结果和音频,直到收到 task-finished;任务失败时返回 task-failed。
result-generated 返回句子元信息,音频数据通过独立通道传输:WebSocket 使用二进制帧,AOQ 使用 Audio Track。连接、鉴权和音频传输方式请参见 WebSocket API 或 AOQ 接入。
task-started
任务启动成功,是客户端开始发送待合成文本的信号。
收到
task-started 后才能发送 continue-task。 run-task 只用于启动和配置任务,待合成文本通过 continue-task 发送。| 参数 | 类型 | 说明 |
|---|---|---|
| header.task_id | string | 客户端生成的任务 ID。 |
| header.event | string | 事件类型,固定为 task-started。 |
| payload | object | 无内容,为空对象。 |
result-generated
返回句子元信息,包括句子开始、音频数据块标记和句子结束。
sentence-end 只表示当前句子合成结束,不表示整个任务结束。 任务结束以 task-finished 为准。音频通过 WebSocket 二进制帧或 AOQ Audio Track 返回。word_timestamp_enabled=true。
task-finished
服务端返回 task-finished 事件,标志任务已结束。客户端可以关闭 WebSocket 连接或复用连接开启新任务。
| 参数 | 类型 | 说明 |
|---|---|---|
| header.task_id | string | 客户端生成的任务 ID。 |
| header.event | string | 事件类型,固定为 task-finished。 |
| payload.usage | object | 字段含义与 result-generated 的 usage 相同。 |
task-failed
当任务失败时,服务端返回 task-failed 事件。客户端需要关闭 WebSocket 连接并处理错误。
以下示例使用不支持的音频格式;任务启动后发送文本,服务端随后返回错误。错误码和错误信息随失败原因而变化。
| 参数 | 类型 | 说明 |
|---|---|---|
| header.task_id | string | 客户端生成的任务 ID。 |
| header.event | string | 事件类型,固定为 task-failed。 |
| header.error_code | string | 错误码。 |
| header.error_message | string | 具体错误信息。 |