Skip to main content

Sambert Flutter SDK

Panduan integrasi Sambert dengan Flutter SDK, mencakup urutan panggilan Dart, parameter permintaan, dan peristiwa.

Sambert menggunakan streaming satu arah. Aplikasi mengirim semua teks sekaligus dan menerima audio hasil sintesis secara bertahap.

Prasyarat

  • Siapkan lingkungan pengembangan Flutter untuk platform target. Aplikasi contoh memerlukan Dart versi 3.4 atau yang lebih baru, di bawah 4.0.
  • Dapatkan kunci API. Pilih endpoint layanan di region yang sama dengan kunci API. Jika menggunakan domain khusus ruang kerja, dapatkan juga ID ruang kerja.
Jangan tanamkan kunci API jangka panjang di kode aplikasi seluler. Untuk model yang mendukung kunci API sementara, gunakan server aplikasi untuk membuat kunci API sementara dan mengirimkannya ke klien.

Instal SDK

Buka Pemilihan dan pengunduhan SDK ucapan seluler, pilih tab Flutter, lalu unduh dan ekstrak paket. Salin direktori SDK yang telah diekstrak ke packages/aliyun_neonui di proyek Flutter, lalu tambahkan dependensi lokal ke pubspec.yaml.
dependencies:
  aliyun_neonui:
    path: packages/aliyun_neonui
Jalankan flutter pub get, lalu impor SDK di file Dart.
import 'package:aliyun_neonui/neonui.dart';

Mulai cepat

Jalankan aplikasi contoh

  1. Hubungkan perangkat target. Jalankan perintah berikut dari direktori SDK yang telah diekstrak.
    cd example
    flutter pub get
    flutter run
    
  2. Pada layar utama aplikasi contoh, buka 百炼(DashScope). Pilih endpoint layanan dan masukkan API Key. Jika menggunakan domain khusus ruang kerja, masukkan juga WorkspaceId.
  3. Buka Sambert 单向流式语音合成 dan jalankan contoh.
Contoh lengkap ada di example/lib/pages/dashscope/dash_sambert_tts_page.dart dalam paket SDK.

Model dalam contoh yang disertakan

  • sambert-zhinan-v1

Urutan pemanggilan

Panggil metode berikut pada instance yang diperoleh dari NativeNui().
  1. Berlangganan ttsEventStream dan ttsAudioStream sebelum memanggil metode berikut.
  2. Gunakan JSON koneksi di bawah sebagai initJson. Teruskan parameter tugas sebagai pasangan kunci dan nilai ke 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: '你好,欢迎使用语音合成。');
    
    Setelah inisialisasi, atur parameter tugas satu per satu. Kirim teks lengkap dengan ttsStart dan baca audio yang diterima dari stream.
  3. TTS_EVENT_END menandakan SDK telah mengembalikan audio. Panggil ttsRelease setelah selesai.

Parameter permintaan

Contoh ini menggunakan salah satu model dalam paket. Untuk pengaturan tambahan, lihat example/lib/dashscope_params.dart di dalam paket. Ganti YOUR_WS_HOST dengan host WebSocket untuk region Anda, YOUR_DEVICE_ID dengan ID perangkat, dan YOUR_API_KEY dengan kunci API untuk region tersebut.

Parameter koneksi

Teruskan JSON contoh sebagai string ke metode Dart.
{
  "url": "wss://YOUR_WS_HOST/api-ws/v1/inference",
  "device_id": "YOUR_DEVICE_ID",
  "mode_type": "2"
}

Parameter tugas

Atur setiap parameter tugas dengan ttsSetParam(key, value). Teruskan nilai numerik sebagai string sesuai contoh.
{
  "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"
}
Untuk Sambert, model memilih ID model yang terkait dengan suara. Contoh ini menggunakan suara 48 kHz dari paket. Putar audio pada laju sampel yang sama.

Referensi API

Metode

Untuk metode yang mengembalikan Future<int>, kode 0 menandakan keberhasilan.
Tanda tangan metodeKegunaan
Future<int> ttsInitialize({required String params, int logLevel = 0, bool saveLog = false})Inisialisasi SDK dengan parameter koneksi sebagai string JSON.
Future<int> ttsSetParam(String key, String value)Atur satu parameter tugas bertipe string.
Future<int> ttsStart({required String priority, required String taskId, required String text})Kirim teks lengkap. Contoh menggunakan priority: '1' dan taskId: ''.
Future<int> ttsPause()Jeda sintesis.
Future<int> ttsResume()Lanjutkan sintesis.
Future<int> ttsCancel(String taskId)Batalkan sintesis berdasarkan ID tugas.
Future<String?> ttsGetParam(String key)Baca parameter. Gunakan error_msg untuk melihat detail kesalahan.
Future<int> ttsRelease()Lepaskan sumber daya SDK.

Peristiwa dan stream audio

Baca peristiwa dari ttsEventStream. Jika peristiwa dikirim sebagai map Dart, gunakan event untuk membaca nama peristiwa dan resultCode untuk memeriksa kegagalan tugas. Stream ttsAudioStream mengirim potongan audio untuk diputar oleh aplikasi.
PeristiwaKegunaan
TTS_EVENT_STARTSintesis atau keluaran suara dimulai
TTS_EVENT_ENDTugas atau keluaran audio saat ini selesai
TTS_EVENT_CANCELTugas dibatalkan
TTS_EVENT_ERRORTugas gagal