Qwen-Audio-3.0-ASR-Flash/Fun-ASR-Flash non-real-time speech recognition Android SDK converts speech to text.
User guide: Non-real-time speech recognition. For supported audio formats, file size limits, duration limits, and other input requirements, see Audio specifications.
Quick start
- Get an API key: Get an API key. For security, we recommend that you configure the API key in an environment variable.
- Download the SDK and run the sample code:
- Download the latest SDK bundle.
- Extract the ZIP archive. Obtain the SDK in AAR format from
app/libsand add it to your project dependencies. For Android CPP integration, useandroid_libsandandroid_includein the ZIP archive to obtain the dynamic libraries and header files. - Open the project in Android Studio. The sample code is in
DashFunAsrFlashFileTranscriberActivity.java. Replace the API key to try the feature.
Call procedure
Synchronous mode
-
Initialize the SDK
-
Configure the parameters based on your business requirements
-
Call
startFileTranscriberto send a non-real-time speech recognition request and wait for the result. -
Use
onFileTransEventCallbackto listen for theEVENT_FILE_TRANS_RESULTevent and obtain the final recognition result. -
Call
releaseto release SDK resources
Request parameters
Connection and control parameters
Pass a JSON string to the initialize method's parameters parameter to configure these settings.
Parameter example: The following JSON string is an example and does not list all parameters. Add parameters as needed in your code:
{
"url": "wss://dashscope.aliyuncs.com/api/v1/services/aigc/multimodal-generation/generation",
"apikey": "st-****",
"device_id": "my_device_id",
"service_mode": "1"
}
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
url | String | Yes | Service endpoints:
Replace {WorkspaceId} with your actual Workspace ID. |
apikey | String | Yes | API Key. |
service_mode | String | Yes | The operating mode. For non-real-time speech recognition, set this parameter to |
device_id | String | Yes | A unique string that identifies the end user. You can use an in-app user ID or a client-generated unique device identifier. This ID is mainly used for log tracing and troubleshooting. |
debug_path | String | No | The path for log files. This parameter takes effect only when you call initialize with |
max_log_file_size | int | No | The maximum log file size in bytes. This parameter takes effect only when you call initialize with |
log_track_level | int | No | The filtering level for logs sent through the logging callback ( |
Recognition parameters
Use startFileTranscriber to configure all recognition parameters.
Parameter example: The following JSON string is an example and does not list all parameters. Add parameters as needed in your code:
{
"apikey": "st-****",
"messages": [
{
"content": [
{
"input_audio": {
"data": "{YOUR_AUDIO_URL}"
},
"type": "input_audio"
}
],
"role": "user"
}
],
"nls_config": {
"format": "mp3",
"model": "qwen-audio-3.0-asr-flash"
}
}
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
apikey | string | No | If Connection and control parameters |
nls_config | object | Yes | The core speech recognition configuration object, including the model and parameters that control recognition. |
nls_config.model | string | Yes | The model name. Qwen-Audio-3.0-ASR-Flash and Fun-ASR-Flash models are supported. For details, see Supported models and regions. |
nls_config.format | string | Yes | The audio format. Set this parameter to the actual format. Supported formats include |
nls_config.sample_rate | string | No | The audio sample rate in Hz. For example, |
nls_config.vocabulary_id | string | No | The precompiled vocabulary ID. Create a vocabulary in advance and pass its ID during recognition to use its hotwords. Use this option when the vocabulary is known, relatively stable, and reused across requests. For usage instructions, see Precompiled hotwords. |
nls_config.instant_vocabulary | object | No | Instant hotwords. ImportantOnly |
nls_config.language_hints | array[string] | No | The language codes for recognition. If the language is unknown in advance, omit this parameter to let the model detect it automatically.
|
messages | array[object] | Yes | The list of messages. It contains the audio to recognize and optional conversation context to improve recognition. |
ImportantContext improves the recognition accuracy of specialized terms. For usage instructions, see Context enhancement.
Constraints: Context messages (input_text and text types) are limited to five each. If the limit is exceeded, only the five most recent messages are retained. The total context text length per turn (the sum of the user and assistant text field lengths) must not exceed 400 characters. Each character counts as one. Excess characters are truncated from the end.
ImportantWhen context is included, messages messages must follow a specific order. Arrange context messages by conversation turn. Within each turn, user (input_text type) must precede the corresponding assistant (text type). The input_audio user message containing input audio must be placed at the end of messages .
| Parameter | Type | Required | Description |
|---|---|---|---|
role | string | Yes | The message role. Valid values:
|
content | array[object] | Yes | The list of message content. See the following descriptions. |
| Parameter | Type | Required | Description |
|---|---|---|---|
type | string | Yes | The content type. Each request requires at least one
|
input_audio | object | No | Required when |
input_audio.data | string | Yes | The audio data to recognize. For supported audio formats, file size limits, duration limits, and other input requirements, see Audio specifications. The following two input methods are supported:
Example (URL): https://example.com/audio/sample.wavExample (Base64): data:audio/wav;base64,{BASE64_ENCODED_DATA} |
text | string | No | Required when |
Key interfaces
NativeNui
initialize
Initialize the speech recognition SDK instance. The SDK uses a singleton. Do not initialize it again before calling release.
This method blocks. Call it from a non-UI thread.
Method signaturepublic synchronized int initialize(final INativeFileTransCallback callback,
String parameters,
final Constants.LogLevel level,
final boolean save_log)
Parameters
| Parameter | Type | Description |
|---|---|---|
callback | INativeFileTransCallback | The implementation of the event and data callback interface. |
parameters | String | A JSON string containing authentication, connection, and debugging parameters. See Connection and control parameters. |
level | Constants.LogLevel | The level of logs printed by the SDK. |
save_log | boolean | Whether to save logs locally. If set to |
Returns an error code. See Error codes.
setParams
Use this method to set or update nls_config separately. You do not need to call this method if all parameters are provided in startFileTranscriber in a single call.
public synchronized int setParams(String params);
Parameters
| Parameter | Type | Description |
|---|---|---|
params | String | Recognition parameters in |
Returns an error code. See Error codes.
startFileTranscriber
Start recognition.
Method signaturepublic synchronized int startFileTranscriber(String params, byte[ ] task_id)
Parameters
| Parameter | Type | Description |
|---|---|---|
params | String | Recognition parameters. Example: |
task_id | byte[ ] | You can ignore this parameter and pass null. |
Returns an error code. See Error codes.
queryFileTranscriber
This non-real-time speech recognition feature only supports synchronous requests. You can ignore this method.
Return valueReturns an error code. See Error codes.
cancelFileTranscriber
Immediately cancel the current task.
Method signaturepublic synchronized int cancelFileTranscriber(String task_id)
Parameters
| Parameter | Type | Description |
|---|---|---|
task_id | String | The ID of the task to cancel, obtained from EVENT_FILE_TRANS_UPLOADED. |
Returns an error code. See Error codes.
release
Release all internal SDK resources. After this call, the SDK instance becomes unavailable. To use it again, call initialize to initialize it again.
Method signaturepublic synchronized int release();
Return value
Returns an error code. See Error codes.
GetVersion
Get the current SDK version.
Method signaturepublic synchronized String GetVersion();
Return value
The current SDK version.
INativeFileTransCallback: Callbacks
onFileTransEventCallback: Listen for events and recognition results
Method signaturevoid onFileTransEventCallback(NuiEvent event, final int resultCode, final int arg2, AsrResult asrResult, String taskId);
Parameters
| Parameter | Type | Description |
|---|---|---|
event | NuiEvent | The callback event. |
resultCode | int | Error code, valid when an EVENT_ASR_ERROR event occurs. |
asrResult | AsrResult | The speech recognition result. |
taskId | String | The task ID. |
arg2 | int | Reserved. |
onFileTransLogTrackCallback: Listen for tracing logs
This callback receives detailed internal SDK logs for troubleshooting and debugging.
default void onFileTransLogTrackCallback(Constants.LogLevel level, String log)
Event types
| Event | Description |
|---|---|
EVENT_FILE_TRANS_CONNECTED | Successfully connected to the service. |
EVENT_FILE_TRANS_UPLOADED | The audio file was uploaded successfully. You can obtain the current task_id at this point. |
EVENT_FILE_TRANS_RESULT | The final recognition result. |
EVENT_ASR_ERROR | An error occurred during speech recognition. |