Paraformer 的 Flutter SDK 接入指南,包含 Dart 呼叫流程、請求參數和事件。
Paraformer 將麥克風的即時音訊轉為文字。請依選用的模型設定輸入取樣率。
開啟行動裝置語音 SDK 選型與下載,在 Flutter 分頁下載並解壓縮整合包。
將解壓縮後的 SDK 目錄複製到 Flutter 專案中的
執行
整合包內的範例固定採集 16 kHz 音訊。直接執行範例時,請選擇支援 16 kHz 的模型。若使用
透過
下例使用整合包內的一個模型。其他設定請見整合包內的
將範例 JSON 當成字串傳入 Dart 方法。
將範例 JSON 當成字串傳入 Dart 方法。
下例使用
回傳
透過
先決條件
- 為目標平台設定 Flutter 開發環境。範例專案需要 Dart 3.4 以上、低於 4.0 的版本。
- 取得 API Key。選擇與 API Key 位於相同地區的服務端點。若使用工作空間專屬網域,請一併取得業務空間 ID。
安裝 SDK
開啟行動裝置語音 SDK 選型與下載,在 Flutter 分頁下載並解壓縮整合包。
將解壓縮後的 SDK 目錄複製到 Flutter 專案中的 packages/aliyun_neonui,並在 pubspec.yaml 中加入本機相依性。
flutter pub get,再於 Dart 檔案中匯入 SDK。
快速入門
執行範例應用程式
-
連接目標裝置,在解壓縮後的 SDK 目錄中執行下列命令。
- 在範例應用程式首頁開啟 百炼(DashScope)。選擇服務端點並填寫 API Key。若使用工作空間專屬網域,也請填寫 WorkspaceId。
- 開啟 Paraformer 实时语音识别 並執行範例。 執行收音範例時,請授予應用程式麥克風存取權限。
example/lib/pages/dashscope/dash_paraformer_speech_transcriber_page.dart。
整合包範例提供的模型
整合包內的範例固定採集 16 kHz 音訊。直接執行範例時,請選擇支援 16 kHz 的模型。若使用 paraformer-realtime-8k-v2,請將 example/lib/audio_input.dart 中的錄音取樣率改為 8 kHz,並將請求參數 nls_config.sample_rate 設為 8000。
paraformer-realtime-v2paraformer-realtime-8k-v2
呼叫步驟
透過 NativeNui() 取得執行個體後,即可呼叫下列方法。
下方的 initJson 和 sessionJson 分別使用「請求參數」中的連線 JSON 和任務 JSON。每次呼叫成功後再執行下一步。
-
先訂閱
eventStream,再呼叫下列方法。 -
設定連線和任務參數後啟動工作階段。
-
工作階段啟動後擷取音訊,並透過
sendAudio持續傳送 PCM 資料。 -
停止擷取後呼叫
dialogStop。處理完最後的事件後,呼叫nuiRelease並取消訂閱。
請求參數
下例使用整合包內的一個模型。其他設定請見整合包內的 example/lib/dashscope_params.dart。更多參數說明請參閱HarmonyOS SDK。
將 YOUR_WS_HOST 取代為所在區域的 WebSocket 主機名稱、YOUR_DEVICE_ID 取代為裝置識別碼,並填寫該區域的 YOUR_API_KEY。
連線參數
將範例 JSON 當成字串傳入 Dart 方法。
任務參數
將範例 JSON 當成字串傳入 Dart 方法。
paraformer-realtime-v2 和 16 kHz PCM。使用 paraformer-realtime-8k-v2 時,請將音訊擷取與請求取樣率都設為 8 kHz。
API 參考
方法
回傳 Future<int> 的方法以結果碼 0 表示成功。sendAudio 的回傳類型為 Future<Object?>。
| 方法簽名 | 用途 |
|---|---|
Future<int> nuiInitialize({required String params, int logLevel = 0, bool saveLog = false}) | 以 JSON 字串傳入連線參數並初始化 SDK。 |
Future<int> dialogSetParams(String params) | 設定目前工作階段的 JSON 參數。 |
Future<int> dialogStart({required int vadMode, String dialogParams = "{}"}) | 啟動工作階段。vadMode 選擇斷句模式,dialogParams 可傳入本次工作階段的 JSON 參數。 |
Future<Object?> sendAudio(Uint8List data) | 傳送一段 PCM 音訊。 |
Future<int> dialogStop() | 結束目前的音訊擷取工作階段並保留連線。 |
Future<int> dialogCancel() | 取消目前的工作階段或合成。 |
Future<int> nuiRelease() | 釋放 SDK 資源。 |
Future<String?> getAllResponse() | 讀取最新的完整辨識回應。 |
事件與音訊串流
透過 eventStream 接收事件。事件以 Dart Map 傳回時,使用 event 判斷事件名稱,並透過 resultCode 查看任務錯誤。
讀取辨識結果時可參考範例對 asrResult 和 asrAllResponse 的處理。
| 事件 | 用途 |
|---|---|
EVENT_ASR_PARTIAL_RESULT | 暫時辨識結果 |
EVENT_SENTENCE_END | 目前句子的最終辨識結果 |
EVENT_TRANSCRIBER_COMPLETE | 任務或目前音訊輸出完成 |
EVENT_ASR_ERROR | 任務失敗 |