Integrate Qwen-Livetranslate-Realtime with the Flutter SDK. See the Dart call sequence, request parameters, and events.
Qwen-Livetranslate-Realtime takes live audio and returns translations. Your app can receive translated text or both text and speech.
Prerequisites
- Set up Flutter development for your target platform. The example app requires Dart 3.4 or later, below 4.0.
- Get an API key. Choose a service endpoint in the same region as the API key. If you use a workspace-specific domain, also get your workspace ID.
Do not hardcode a long-lived API key in a mobile app. For models that accept temporary API keys, have your application server generate a temporary API key and send it to the client.
Install the SDK
Open Mobile speech SDK selection and download, select Flutter, and download and extract the package.
Copy the extracted SDK directory to packages/aliyun_neonui in your Flutter project and add the local dependency to pubspec.yaml.
dependencies:
aliyun_neonui:
path: packages/aliyun_neonui
Run flutter pub get, then import the SDK in your Dart file.
import 'package:aliyun_neonui/neonui.dart';
Quick start
Run the example app
-
Connect your target device. Run these commands from the extracted SDK directory.
cd example flutter pub get flutter run -
In the example app, open 百炼(DashScope) from the home screen. Select a service endpoint and enter your API Key. If you use a workspace-specific domain, enter your WorkspaceId as well.
-
Open Qwen-LiveTranslate 实时音视频翻译 and run the example.
Allow microphone access when running an audio capture example.
The complete example is in example/lib/pages/dashscope/dash_live_translate_page.dart in the SDK package.
Models in the included example
qwen3.5-livetranslate-flash-realtime
Call procedure
Call these methods on the instance returned by NativeNui().
Use the connection JSON and task JSON under Request parameters as initJson and sessionJson. Check the result of each call before continuing.
-
Subscribe to
eventStreamandttsAudioStreambefore calling these methods. -
Set the connection and task parameters, then start the session.
await nui.nuiInitialize(params: initJson); await nui.dialogSetParams(sessionJson); await nui.dialogStart(vadMode: VadMode.p2t.code, dialogParams: sessionJson); -
Once the session starts, capture audio and send PCM chunks with
sendAudio. The included recording example captures 16 kHz, 16-bit, mono PCM.On iOS, start the microphone before starting the audio player. If the player is already running, restart it after the microphone starts so the response audio can play.
-
Stop capturing audio and call
dialogStop. After handling the last events, callnuiReleaseand cancel your subscriptions.
Request parameters
The following example uses a model from the package. For additional settings, see example/lib/dashscope_params.dart in the package. For additional parameter details, see WebSocket integration guide.
Replace YOUR_WS_HOST with the WebSocket host for your region, YOUR_DEVICE_ID with a device identifier, and YOUR_API_KEY with an API key for that region.
Connection parameters
Pass the example JSON as a string to the Dart method.
{
"device_id": "YOUR_DEVICE_ID",
"url": "wss://YOUR_WS_HOST/api-ws/v1/realtime?model=qwen3.5-livetranslate-flash-realtime",
"service_mode": "1",
"audio_update_manually": "false"
}
Task parameters
Pass the example JSON as a string to the Dart method.
{
"apikey": "YOUR_API_KEY",
"nls_config": {
"sample_rate": 16000,
"sr_format": "pcm",
"modalities": "[\"text\",\"audio\"]",
"source_language": "zh",
"translation": "{\"language\":\"en\"}",
"turn_detection": "{\"type\":\"server_vad\",\"threshold\":0.2,\"silence_duration_ms\":1000}"
},
"service_type": 4
}
The URL query parameter model selects the translation model. nls_config.model is for optional source-language recognition. translation is a JSON string containing the target language. Omit source_language for automatic detection.
API reference
Methods
For methods returning Future<int>, result code 0 indicates success. The return type of sendAudio is Future<Object?>.
| Method signature | Purpose |
|---|---|
Future<int> nuiInitialize({required String params, int logLevel = 0, bool saveLog = false}) | Initialize the SDK with connection parameters as a JSON string. |
Future<int> dialogSetParams(String params) | Set the JSON parameters for the current session. |
Future<int> dialogStart({required int vadMode, String dialogParams = "{}"}) | Start the session. vadMode selects the segmentation mode, and dialogParams accepts a JSON string with per-session parameters. |
Future<Object?> sendAudio(Uint8List data) | Send a chunk of PCM audio. |
Future<int> dialogStop() | End the current capture session and keep the connection open. |
Future<int> dialogCancel() | Cancel the current session or synthesis task. |
Future<int> nuiRelease() | Release SDK resources. |
Events and audio streams
Read events from eventStream. For events delivered as Dart maps, read the event name from event and use resultCode to inspect task errors.
The ttsAudioStream stream emits audio chunks for the app to play.
| Event | Purpose |
|---|---|
EVENT_ASR_PARTIAL_RESULT | Partial recognition result |
EVENT_RESULT_TRANSLATED | Translation result |
EVENT_RESULT_TRANSLATED_END | Final translation for the current sentence |
EVENT_TRANSCRIBER_COMPLETE | Task or current audio output complete |
EVENT_ASR_ERROR | Task failed |