Flutter SDK を使用して Sambert に接続するためのガイドです。Dart の呼び出し順序、リクエストパラメーター、イベントを説明します。
Sambert は単方向ストリーミングを使用します。テキスト全体を一度に送信し、合成音声を分割して受信します。
前提条件
- 対象プラットフォームの Flutter 開発環境を用意します。サンプルアプリには Dart 3.4 以上、4.0 未満が必要です。
- API キーを取得します。API キーと同じリージョンのサービスエンドポイントを選択します。ワークスペース専用ドメインを使用する場合は、ワークスペース ID も取得します。
モバイルアプリに有効期間の長い API キーをハードコードしないでください。一時 API キーに対応するモデルを使用する場合は、アプリケーションサーバーで一時 API キーを生成し、クライアントに送信します。
SDK のインストール
モバイル音声 SDK の選択とダウンロードを開き、Flutter タブからパッケージをダウンロードして展開します。
展開した SDK ディレクトリを Flutter プロジェクトの packages/aliyun_neonui にコピーし、pubspec.yaml にローカル依存関係を追加します。
dependencies:
aliyun_neonui:
path: packages/aliyun_neonui
flutter pub get を実行し、Dart ファイルで SDK をインポートします。
import 'package:aliyun_neonui/neonui.dart';
クイックスタート
サンプルアプリを実行する
-
対象のデバイスを接続し、展開した SDK ディレクトリで次のコマンドを実行します。
cd example flutter pub get flutter run -
サンプルアプリのホーム画面で 百炼(DashScope) を開き、サービスエンドポイントを選択して API Key を入力します。ワークスペース専用ドメインを使用する場合は、WorkspaceId も入力します。
-
Sambert 单向流式语音合成 を開き、サンプルを実行します。
完全なサンプルは SDK パッケージの example/lib/pages/dashscope/dash_sambert_tts_page.dart にあります。
同梱サンプルで選択できるモデル
sambert-zhinan-v1
呼び出し手順
NativeNui() で取得したインスタンスで、以下のメソッドを呼び出します。
-
メソッドを呼び出す前に
ttsEventStreamとttsAudioStreamを購読します。 -
下記の接続用 JSON を
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: '你好,欢迎使用语音合成。');初期化後にタスクパラメーターを個別に設定します。
ttsStartでテキスト全体を送信し、ストリームから音声を取得します。 -
TTS_EVENT_ENDは SDK からの音声の返却が完了したことを示します。使用後はttsReleaseを呼び出します。
リクエストパラメーター
以下はパッケージに同梱するモデルのサンプルです。その他の設定については、パッケージ内の example/lib/dashscope_params.dart を参照してください。
YOUR_WS_HOST を対象リージョンの WebSocket ホスト名、YOUR_DEVICE_ID をデバイス識別子、YOUR_API_KEY をそのリージョンの API キーに置き換えます。
接続パラメーター
次の JSON は、文字列として Dart メソッドに渡します。
{
"url": "wss://YOUR_WS_HOST/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 音声に合わせています。再生にも同じサンプリングレートを使います。
API リファレンス
メソッド
戻り値が Future<int> のメソッドでは、結果コード 0 が成功を表します。
| メソッドのシグネチャ | 用途 |
|---|---|
Future<int> ttsInitialize({required String params, int logLevel = 0, bool saveLog = false}) | 接続パラメーターを JSON 文字列で渡して SDK を初期化します。 |
Future<int> ttsSetParam(String key, String value) | 文字列のタスクパラメーターを 1 つ設定します。 |
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 | タスクの失敗 |