跳转到主要内容
Flutter SDK

Sambert Flutter SDK

使用 Flutter SDK 接入 Sambert 单向流式语音合成,包含 Dart 调用流程、请求参数和事件。

Sambert 使用单向流式接口。应用一次提交完整文本,并分片接收合成音频。

前提条件

移动端应用请勿硬编码长期 API Key。调用支持临时 API Key 的模型时,由应用服务端生成临时 API Key并下发给客户端。

安装 SDK

在 SDK 下载页面获取移动端语音 SDK 整合包。解压后将 Flutter SDK 目录复制到项目的 packages/aliyun_neonui,并在 pubspec.yaml 中添加本地依赖。
dependencies:
  aliyun_neonui:
    path: packages/aliyun_neonui
运行 flutter pub get,然后在 Dart 文件中导入 SDK。
import 'package:aliyun_neonui/neonui.dart';

快速开始

  1. 连接目标设备,在解压后的 SDK 目录中运行示例。
cd example
flutter pub get
flutter run
  1. 打开示例应用,选择服务地址并填写 API Key。
  2. 打开 Sambert 单向流式语音合成示例并运行。
完整示例见整合包中的 example/lib/pages/dashscope/dash_sambert_tts_page.dart。 包内示例包含模型 sambert-zhinan-v1。

调用步骤

通过 NativeNui() 获取实例后调用以下方法。
  1. 先订阅 ttsEventStream 和 ttsAudioStream,再初始化并合成。下文的 initJson 对应「请求参数」中的连接参数,任务参数按键值逐项传给 ttsSetParam。
await nui.ttsInitialize(params: initJson);
for (final entry in taskParams.entries) {
  await nui.ttsSetParam(entry.key, entry.value);
}
await nui.ttsStart(priority: '1', taskId: '', text: '你好,欢迎使用语音合成。');
  1. 初始化后逐个设置任务参数。调用 ttsStart 发送完整文本,应用从音频流读取返回音频。
  2. 收到 TTS_EVENT_END 后可继续处理已收到的音频。任务用完后调用 ttsRelease。

请求参数

以下示例使用包内示例的模型。需要调整其他字段时,可参考整合包中的 example/lib/dashscope_params.dart。更多参数说明见 Android SDK、iOS SDK、HarmonyOS SDK。

连接参数

示例中的 JSON 作为字符串传入 Dart 方法。
{
  "url": "wss://maas.qianwenaiapi.com/api-ws/v1/inference",
  "device_id": "YOUR_DEVICE_ID",
  "mode_type": "2"
}

任务参数

通过 ttsSetParam(key, value) 逐项设置任务参数,以下数值也以字符串传入。
{
  "apikey": "YOUR_API_KEY",
  "model": "sambert-zhinan-v1",
  "format": "pcm",
  "enable_audio_decoder": "0",
  "sample_rate": "48000",
  "volume": "50",
  "rate": "1.0",
  "pitch": "1.0"
}
Sambert 用 model 设置音色对应的模型 ID。示例与包内 48 kHz 音色一致,应用按相同采样率播放。

接口参考

方法

返回 Future<int> 的方法中,结果码 0 表示成功。
方法签名用途
Future<int> ttsInitialize({required String params, int logLevel = 0, bool saveLog = false})初始化 SDK。params 为连接参数 JSON 字符串。
Future<int> ttsSetParam(String key, String value)逐项设置字符串参数。
Future<int> ttsStart({required String priority, required String taskId, required String text})提交完整待合成文本,示例使用 priority: '1'、taskId: ''。
Future<int> ttsPause()暂停合成。
Future<int> ttsResume()继续合成。
Future<int> ttsCancel(String taskId)按任务 ID 取消合成。
Future<String?> ttsGetParam(String key)读取指定参数,可用 error_msg 查看错误详情。
Future<int> ttsRelease()释放 SDK 资源。

事件与音频流

事件从 ttsEventStream 读取。收到 Dart Map 时,以 event 识别事件名,任务类事件的 resultCode 可用于判断错误。 音频流 ttsAudioStream 返回音频分片。应用负责播放音频。
事件用途
TTS_EVENT_START合成或回复音频开始
TTS_EVENT_END任务或当前音频输出完成
TTS_EVENT_CANCEL任务已取消
TTS_EVENT_ERROR任务失败
Sambert Flutter SDK - 千问AI平台