Skip to main content

Qwen-Audio-ASR / Fun-ASR Android SDK

Prerequisites

  1. Obtain and configure an API key. Do not hardcode a long-lived API key in a mobile app. We recommend generating a temporary API key on your application server and sending it to the client.

Install the SDK

  • Download the latest SDK package.
  • Extract the ZIP package. The AAR-format SDK is in the app/libs directory. Add it to your project dependencies. For Android C++ integration, use android_libs and android_include from the ZIP package to get the dynamic libraries and header files.

Quick start

Open the project in Android Studio. The sample code is in DashFunAsrSpeechTranscriberActivity.java. Replace the API key to try out the feature.

Call procedure

  1. Initialize the SDK.
  2. Set the parameters for your use case. Use the parameters argument of the initialize method to set the Connection and control parameters, and use the setParams method to set the Speech recognition parameters.
  3. Call startDialog to start recognition.
  4. In the onNuiAudioStateChanged callback, start the recording device based on the audio state.
  5. Continuously supply recording data in the onNuiNeedAudioData callback, or actively push recording data by calling updateAudio.
  6. In the onNuiEventCallback callback, listen for events and get the speech recognition results.
  7. Call stopDialog to stop recognition, and listen for the EVENT_TRANSCRIBER_COMPLETE event to confirm that recognition has ended.
  8. When you no longer need recognition, call release to release the SDK resources.
Qwen-Audio-ASR-Message · API reference initialize, Connection and control parameters, setParams, Speech recognition parameters, startDialog, onNuiAudioStateChanged, onNuiNeedAudioData, updateAudio, onNuiEventCallback, stopDialog, release

Request parameters

Qwen-Audio-ASR-Streaming

Shared reference

Connection and control parameters

To configure these parameters, pass a JSON string in the parameters argument of the initialize method. Example: The following is a JSON string example. Not all parameters are listed. Add others as needed when you write your code:
{
    "url": "wss://dashscope.aliyuncs.com/api-ws/v1/inference",
    "apikey": "st-****",
    "device_id": "my_device_id",
    "service_mode": "1"
}
Parameters
ParameterTypeRequiredDescription
urlStringYesService address:
  • wss://dashscope.aliyuncs.com/api-ws/v1/inference
  • China (Beijing): wss://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/api-ws/v1/inference
  • Singapore: wss://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api-ws/v1/inference
Replace {WorkspaceId} with your actual Workspace ID.
apikeyStringYesThe API key.
service_modeStringYesThe run mode. Fixed to "1" for real-time speech recognition.
device_idStringYesA unique string that identifies the end user. You can set it to an in-app user ID or a client-generated unique device identifier. This ID is mainly used for log tracing and troubleshooting.
audio_update_manuallyStringNoWhether to enable active audio data pushing. Default: "false".If set to "true" and the SDK version supports on-device audio processing capabilities such as AEC and VAD, those capabilities are enabled by default.
workspaceStringNoThe path where on-device resource files are stored. This parameter is required when audio_update_manually is set to "true" and an on-device audio processing capability such as AEC or VAD is enabled.
debug_pathStringNoThe storage path for log files.This parameter takes effect only when save_log is set to true in the initialize method. In this case, you must set the log file path, or an error occurs.A maximum of two log files are kept locally.
save_wavStringNoWhether to save the debug audio file. The audio file is saved under debug_path.Default: "false".Valid values:
  • "true": save the file.
  • "false": do not save the file.
This parameter takes effect only when save_log is set to true in the initialize method. In addition, debug_path must also be set.
max_log_file_sizeintNoThe maximum size of a log file, in bytes.This parameter takes effect only when save_log is set to true in the initialize method.Default: 104857600 (100 * 1024 * 1024 bytes, that is, 100 MiB).
log_track_levelintNoThe filter level for the log content sent through the log callback (onNuiLogTrackCallback).Default: 2.Valid values:
  • 0: LOG_LEVEL_VERBOSE
  • 1: LOG_LEVEL_DEBUG
  • 2: LOG_LEVEL_INFO
  • 3: LOG_LEVEL_WARNING
  • 4: LOG_LEVEL_ERROR
  • 5: LOG_LEVEL_NONE (disables this feature)
Note: log_track_level and level (set through the initialize method) together determine which logs are ultimately sent to the callback. A log is sent to the callback only when its level value is greater than or equal to both log_track_level and level. For example, if log_track_level is set to 2 (INFO) and level is set to 3 (WARNING), then only logs of WARNING level or higher (value >= 3) are sent to the callback.
enable_reconnectionStringNoWhether to resume transmission after the network reconnects. Default: "false".
aec_paramsobjectNoThe advanced configuration object for on-device acoustic echo cancellation (AEC). This object takes effect only when audio_update_manually is set to "true".
aec_params.enable_aecbooleanNoWhether to enable on-device AEC. If audio_update_manually is set to "true" and the SDK version supports on-device AEC, this capability is enabled by default.
aec_params.save_audiobooleanNoWhether to save audio processed by the on-device AEC module. If save_wav is set to "true" and debug_path is specified, this feature is enabled by default and the AEC audio data is saved to debug_path.
aec_params.enable_aec_data_callbackbooleanNoWhether to return the AEC-processed data to your application. Default: false. If enabled, receive the data from the EVENT_AEC_DATA event in onNuiAssistEventCallback.
vad_paramsobjectNoThe advanced configuration object for on-device voice activity detection (VAD). This object takes effect only when audio_update_manually is set to "true".
vad_params.enable_aecbooleanNoWhether to enable on-device VAD. If audio_update_manually is set to "true" and the SDK version supports on-device VAD, this capability is enabled by default.
vad_params.save_audiobooleanNoWhether to save audio processed by the on-device VAD module. If save_wav is set to "true" and debug_path is specified, this feature is enabled by default and the VAD audio data is saved to debug_path.

Speech recognition parameters

To configure these parameters, pass a JSON string in the params argument of the setParams method. Example: The following is a JSON string example. Not all parameters are listed. Add others as needed when you write your code:
{
    "service_type": 4,
    "nls_config": {
        "model": "qwen-audio-3.0-asr-flash-streaming",
        "sr_format": "pcm",
        "sample_rate": "16000"
    }
}
Parameters
Top-level parameterTypeRequiredDescription
service_typeintYesThe speech service type. Fixed to 4 for real-time speech recognition.
nls_configobjectYesThe core configuration object for speech recognition. It contains key parameters such as model selection and recognition-quality controls.
nls_config.modelstringYesThe model name.
nls_config.sr_formatstringYesThe audio format.Valid values:
  • pcm
  • opus
For Opus audio, pass PCM audio to the SDK. The SDK encodes it as Opus internally.
nls_config.sample_rateintYesThe sample rate in Hz. Any sample rate is supported.
8000 Hz is not supported when an on-device audio processing capability such as AEC or VAD is enabled.
nls_config.keep_dialectbooleanNoSpecifies whether to preserve dialect expressions. Default: false. Set to false to transcribe dialect speech as standard Mandarin text, or true to preserve dialect expressions.
Applies to qwen-audio-3.1-asr-flash-streaming.
nls_config.vad_modelstringNoThe VAD model. Default: far_field_meeting_16k.
  • near_meeting_16k: near-field scenarios.
  • far_field_meeting_16k: far-field scenarios.
Applies to qwen-audio-3.1-asr-flash-streaming.
nls_config.max_sentence_silenceintNoThe VAD silence threshold for segmentation, in ms. When the silence after a segment of speech exceeds this threshold, the system determines that the sentence has ended.Default value: 800.Valid values: [200, 6000].
nls_config.multi_threshold_mode_enabledbooleanNoWhether to enable multi-threshold mode. When enabled, this prevents VAD segments from becoming too long.Default value: false.
nls_config.heartbeatbooleanNoWhether to enable heartbeat packets.Default value: false.
  • true: Keeps the connection to the server alive even when silent audio is sent continuously.
  • false (default): Even when silent audio is continuously sent, the connection times out and closes after a period of time.
Silent audio refers to content in an audio file or data stream that contains no sound signal. You can generate silent audio in several ways, such as using audio editing software like Audacity or Adobe Audition, or using a command-line tool like FFmpeg.
nls_config.vocabulary_idstringNoThe ID of a precompiled hot word list.Generate this ID in advance by calling the create hot word list API. Pass the ID during recognition to use the hot words in the list.Suitable for scenarios where the vocabulary is known and relatively stable, and where you need to reuse the same word list across requests.For usage details, see Precompiled hotwords.
nls_config.instant_vocabularyobjectNoInstant hot words.Passed as key-value pairs, where the key is the hot word text (string) and the value is the hot word weight (integer). No hot word list needs to be created in advance. The weight ranges from [1, 5] or is set to 50: a value in [1, 5] makes the model more likely to output the word as the value increases; a value of 50 designates a super hot word, which greatly improves recall, but the number of super hot words cannot exceed 50.Suitable for temporary, session-level hot word optimization.When instant and precompiled hotwords are configured together, the system merges both sets. If the merged set contains more than 2000 hotwords, the system randomly selects 2000 to use. For usage, supported models, and limits, see Instant hotwords.
nls_config.language_hintsarray[string]NoThe language of the audio to recognize. There is no default value; if not set, the model detects the language automatically.You can set up to 4 values. If you set more, only the first 4 take effect.
  • zh: Chinese
  • en: English
  • ja: Japanese
  • ko: Korean
  • vi: Vietnamese
  • th: Thai
  • id: Indonesian
  • ms: Malay
  • tl: Filipino
  • hi: Hindi
  • ar: Arabic
  • fr: French
  • de: German
  • es: Spanish
  • pt: Portuguese
  • ru: Russian
  • it: Italian
  • nl: Dutch
  • sv: Swedish
  • da: Danish
  • fi: Finnish
  • no: Norwegian
  • el: Greek
  • pl: Polish
  • cs: Czech
  • hu: Hungarian
  • ro: Romanian
  • bg: Bulgarian
  • hr: Croatian
  • sk: Slovak
nls_config.speech_noise_thresholdfloatNoThe threshold for distinguishing speech from noise, used to adjust the sensitivity of Voice Activity Detection (VAD).Valid values: [-1.0, 1.0].Value descriptions:
  • The closer the value is to -1: The noise threshold decreases, so noise is more likely to be recognized as speech, which may cause more noise to be transcribed.
  • The closer the value is to +1: The noise threshold increases, so speech is more likely to be misjudged as noise, which may cause some speech to be filtered out.
This is an advanced configuration parameter. Adjusting it can significantly affect recognition results. Recommendations:
  • Thoroughly test and verify the results before adjusting.
  • Adjust in small increments based on the actual audio environment (a step of 0.1 is recommended).
nls_config.special_word_filterobjectNoSpecifies the sensitive words to process during speech recognition, and supports setting different processing methods for different sensitive words. For details, see Sensitive word filtering.
nls_config.enable_connection_fast_checkbooleanNoWhether to quickly detect network outages and report them as soon as possible. Default: false.

Qwen-Audio-ASR-Message

Shared reference

Connection and control parameters

To configure these parameters, pass a JSON string in the parameters argument of the initialize method. Example: The following is a JSON string example. Not all parameters are listed. Add others as needed when you write your code:
{
    "url": "wss://dashscope.aliyuncs.com/api-ws/v1/inference",
    "apikey": "st-****",
    "device_id": "my_device_id",
    "service_mode": "1"
}
Parameters
ParameterTypeRequiredDescription
urlStringYesService address:
  • wss://dashscope.aliyuncs.com/api-ws/v1/inference
  • China (Beijing): wss://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/api-ws/v1/inference
  • Singapore: wss://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api-ws/v1/inference
Replace {WorkspaceId} with your actual Workspace ID.
apikeyStringYesThe API key.
service_modeStringYesThe run mode. Fixed to "1" for real-time speech recognition.
device_idStringYesA unique string that identifies the end user. You can set it to an in-app user ID or a client-generated unique device identifier. This ID is mainly used for log tracing and troubleshooting.
audio_update_manuallyStringNoWhether to enable active audio data pushing. Default: "false".If set to "true" and the SDK version supports on-device audio processing capabilities such as AEC and VAD, those capabilities are enabled by default.
workspaceStringNoThe path where on-device resource files are stored. This parameter is required when audio_update_manually is set to "true" and an on-device audio processing capability such as AEC or VAD is enabled.
debug_pathStringNoThe storage path for log files.This parameter takes effect only when save_log is set to true in the initialize method. In this case, you must set the log file path, or an error occurs.A maximum of two log files are kept locally.
save_wavStringNoWhether to save the debug audio file. The audio file is saved under debug_path.Default: "false".Valid values:
  • "true": save the file.
  • "false": do not save the file.
This parameter takes effect only when save_log is set to true in the initialize method. In addition, debug_path must also be set.
max_log_file_sizeintNoThe maximum size of a log file, in bytes.This parameter takes effect only when save_log is set to true in the initialize method.Default: 104857600 (100 * 1024 * 1024 bytes, that is, 100 MiB).
log_track_levelintNoThe filter level for the log content sent through the log callback (onNuiLogTrackCallback).Default: 2.Valid values:
  • 0: LOG_LEVEL_VERBOSE
  • 1: LOG_LEVEL_DEBUG
  • 2: LOG_LEVEL_INFO
  • 3: LOG_LEVEL_WARNING
  • 4: LOG_LEVEL_ERROR
  • 5: LOG_LEVEL_NONE (disables this feature)
Note: log_track_level and level (set through the initialize method) together determine which logs are ultimately sent to the callback. A log is sent to the callback only when its level value is greater than or equal to both log_track_level and level. For example, if log_track_level is set to 2 (INFO) and level is set to 3 (WARNING), then only logs of WARNING level or higher (value >= 3) are sent to the callback.
enable_reconnectionStringNoWhether to resume transmission after the network reconnects. Default: "false".
aec_paramsobjectNoThe advanced configuration object for on-device acoustic echo cancellation (AEC). This object takes effect only when audio_update_manually is set to "true".
aec_params.enable_aecbooleanNoWhether to enable on-device AEC. If audio_update_manually is set to "true" and the SDK version supports on-device AEC, this capability is enabled by default.
aec_params.save_audiobooleanNoWhether to save audio processed by the on-device AEC module. If save_wav is set to "true" and debug_path is specified, this feature is enabled by default and the AEC audio data is saved to debug_path.
aec_params.enable_aec_data_callbackbooleanNoWhether to return the AEC-processed data to your application. Default: false. If enabled, receive the data from the EVENT_AEC_DATA event in onNuiAssistEventCallback.
vad_paramsobjectNoThe advanced configuration object for on-device voice activity detection (VAD). This object takes effect only when audio_update_manually is set to "true".
vad_params.enable_aecbooleanNoWhether to enable on-device VAD. If audio_update_manually is set to "true" and the SDK version supports on-device VAD, this capability is enabled by default.
vad_params.save_audiobooleanNoWhether to save audio processed by the on-device VAD module. If save_wav is set to "true" and debug_path is specified, this feature is enabled by default and the VAD audio data is saved to debug_path.

Speech recognition parameters

To configure these parameters, pass a JSON string in the params argument of the setParams method. Example: The following is a JSON string example. Not all parameters are listed. Add others as needed when you write your code:
{
    "service_type": 4,
    "nls_config": {
        "model": "qwen-audio-3.1-asr-flash-message",
        "sr_format": "pcm",
        "sample_rate": "16000"
    }
}
Parameters
Top-level parameterTypeRequiredDescription
service_typeintYesThe speech service type. Fixed to 4 for real-time speech recognition.
nls_configobjectYesThe core configuration object for speech recognition. It contains key parameters such as model selection and recognition-quality controls.
nls_config.modelstringYesThe model name. Set to qwen-audio-3.1-asr-flash-message.
nls_config.sr_formatstringYesThe audio format.Valid values:
  • pcm
  • opus
For Opus audio, pass PCM audio to the SDK. The SDK encodes it as Opus internally.
nls_config.sample_rateintYesThe sample rate, in Hz.Only 16000 Hz is supported.
nls_config.language_hintsarray[string]NoThe language of the audio to recognize. There is no default value; if not set, the model detects the language automatically.You can set up to 4 values. If you set more, only the first 4 take effect.
  • zh: Chinese
  • en: English
  • ja: Japanese
  • ko: Korean
  • vi: Vietnamese
  • th: Thai
  • id: Indonesian
  • ms: Malay
  • tl: Filipino
  • hi: Hindi
  • ar: Arabic
  • fr: French
  • de: German
  • es: Spanish
  • pt: Portuguese
  • ru: Russian
  • it: Italian
  • nl: Dutch
  • sv: Swedish
  • da: Danish
  • fi: Finnish
  • no: Norwegian
  • el: Greek
  • pl: Polish
  • cs: Czech
  • hu: Hungarian
  • ro: Romanian
  • bg: Bulgarian
  • hr: Croatian
  • sk: Slovak
This parameter applies only to final results (sentence_end=true) and is not supported for intermediate results (sentence_end=false).
nls_config.keep_dialectbooleanNoSpecifies whether to preserve dialect expressions. Default: false. Set to false to transcribe dialect speech as standard Mandarin text, or true to preserve dialect expressions.
This parameter applies only to final results (sentence_end=true) and is not supported for intermediate results (sentence_end=false).
nls_config.vad_modelstringNoThe VAD model. Default: far_field_meeting_16k.
  • near_meeting_16k: near-field scenarios.
  • far_field_meeting_16k: far-field scenarios.
nls_config.max_sentence_silenceintNoThe VAD silence threshold for segmentation, in ms. When the silence after a segment of speech exceeds this threshold, the system determines that the sentence has ended.Default value: 800.Valid values: [200, 6000].
nls_config.heartbeatbooleanNoWhether to enable heartbeat packets.Default value: false.
  • true: Keeps the connection to the server alive even when silent audio is sent continuously.
  • false (default): Even when silent audio is continuously sent, the connection times out and closes after a period of time.
Silent audio refers to content in an audio file or data stream that contains no sound signal. You can generate silent audio in several ways, such as using audio editing software like Audacity or Adobe Audition, or using a command-line tool like FFmpeg.
nls_config.disfluency_removal_enabledbooleanNoWhether to filter filler words and polish the output. Defaults to false. Set to true to enable this feature.
nls_config.intermediate_result_enabledbooleanNoWhether to return intermediate streaming results. Defaults to false. Set to true to return intermediate streaming results.
nls_config.vocabulary_idstringNoThe ID of a precompiled hot word list.Generate this ID in advance by calling the create hot word list API. Pass the ID during recognition to use the hot words in the list.Suitable for scenarios where the vocabulary is known and relatively stable, and where you need to reuse the same word list across requests.For usage details, see Precompiled hotwords.
nls_config.instant_vocabularyobjectNoInstant hot words.Passed as key-value pairs, where the key is the hot word text (string) and the value is the hot word weight (integer). No hot word list needs to be created in advance. The weight ranges from [1, 5] or is set to 50: a value in [1, 5] makes the model more likely to output the word as the value increases; a value of 50 designates a super hot word, which greatly improves recall, but the number of super hot words cannot exceed 50.Suitable for temporary, session-level hot word optimization.When instant and precompiled hotwords are configured together, the system merges both sets. If the merged set contains more than 2000 hotwords, the system randomly selects 2000 to use. For usage, supported models, and limits, see Instant hotwords.
nls_config.speech_noise_thresholdfloatNoThe threshold for distinguishing speech from noise, used to adjust the sensitivity of Voice Activity Detection (VAD).Valid values: [-1.0, 1.0].Value descriptions:
  • The closer the value is to -1: The noise threshold decreases, so noise is more likely to be recognized as speech, which may cause more noise to be transcribed.
  • The closer the value is to +1: The noise threshold increases, so speech is more likely to be misjudged as noise, which may cause some speech to be filtered out.
This is an advanced configuration parameter. Adjusting it can significantly affect recognition results. Recommendations:
  • Thoroughly test and verify the results before adjusting.
  • Adjust in small increments based on the actual audio environment (a step of 0.1 is recommended).
nls_config.enable_connection_fast_checkbooleanNoWhether to quickly detect network outages and report them as soon as possible. Default: false.

Fun-ASR-Realtime

Shared reference

Connection and control parameters

To configure these parameters, pass a JSON string in the parameters argument of the initialize method. Example: The following is a JSON string example. Not all parameters are listed. Add others as needed when you write your code:
{
    "url": "wss://dashscope.aliyuncs.com/api-ws/v1/inference",
    "apikey": "st-****",
    "device_id": "my_device_id",
    "service_mode": "1"
}
Parameters
ParameterTypeRequiredDescription
urlStringYesService address:
  • wss://dashscope.aliyuncs.com/api-ws/v1/inference
  • China (Beijing): wss://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/api-ws/v1/inference
  • Singapore: wss://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api-ws/v1/inference
Replace {WorkspaceId} with your actual Workspace ID.
apikeyStringYesThe API key.
service_modeStringYesThe run mode. Fixed to "1" for real-time speech recognition.
device_idStringYesA unique string that identifies the end user. You can set it to an in-app user ID or a client-generated unique device identifier. This ID is mainly used for log tracing and troubleshooting.
audio_update_manuallyStringNoWhether to enable active audio data pushing. Default: "false".If set to "true" and the SDK version supports on-device audio processing capabilities such as AEC and VAD, those capabilities are enabled by default.
workspaceStringNoThe path where on-device resource files are stored. This parameter is required when audio_update_manually is set to "true" and an on-device audio processing capability such as AEC or VAD is enabled.
debug_pathStringNoThe storage path for log files.This parameter takes effect only when save_log is set to true in the initialize method. In this case, you must set the log file path, or an error occurs.A maximum of two log files are kept locally.
save_wavStringNoWhether to save the debug audio file. The audio file is saved under debug_path.Default: "false".Valid values:
  • "true": save the file.
  • "false": do not save the file.
This parameter takes effect only when save_log is set to true in the initialize method. In addition, debug_path must also be set.
max_log_file_sizeintNoThe maximum size of a log file, in bytes.This parameter takes effect only when save_log is set to true in the initialize method.Default: 104857600 (100 * 1024 * 1024 bytes, that is, 100 MiB).
log_track_levelintNoThe filter level for the log content sent through the log callback (onNuiLogTrackCallback).Default: 2.Valid values:
  • 0: LOG_LEVEL_VERBOSE
  • 1: LOG_LEVEL_DEBUG
  • 2: LOG_LEVEL_INFO
  • 3: LOG_LEVEL_WARNING
  • 4: LOG_LEVEL_ERROR
  • 5: LOG_LEVEL_NONE (disables this feature)
Note: log_track_level and level (set through the initialize method) together determine which logs are ultimately sent to the callback. A log is sent to the callback only when its level value is greater than or equal to both log_track_level and level. For example, if log_track_level is set to 2 (INFO) and level is set to 3 (WARNING), then only logs of WARNING level or higher (value >= 3) are sent to the callback.
enable_reconnectionStringNoWhether to resume transmission after the network reconnects. Default: "false".
aec_paramsobjectNoThe advanced configuration object for on-device acoustic echo cancellation (AEC). This object takes effect only when audio_update_manually is set to "true".
aec_params.enable_aecbooleanNoWhether to enable on-device AEC. If audio_update_manually is set to "true" and the SDK version supports on-device AEC, this capability is enabled by default.
aec_params.save_audiobooleanNoWhether to save audio processed by the on-device AEC module. If save_wav is set to "true" and debug_path is specified, this feature is enabled by default and the AEC audio data is saved to debug_path.
aec_params.enable_aec_data_callbackbooleanNoWhether to return the AEC-processed data to your application. Default: false. If enabled, receive the data from the EVENT_AEC_DATA event in onNuiAssistEventCallback.
vad_paramsobjectNoThe advanced configuration object for on-device voice activity detection (VAD). This object takes effect only when audio_update_manually is set to "true".
vad_params.enable_aecbooleanNoWhether to enable on-device VAD. If audio_update_manually is set to "true" and the SDK version supports on-device VAD, this capability is enabled by default.
vad_params.save_audiobooleanNoWhether to save audio processed by the on-device VAD module. If save_wav is set to "true" and debug_path is specified, this feature is enabled by default and the VAD audio data is saved to debug_path.

Speech recognition parameters

To configure these parameters, pass a JSON string in the params argument of the setParams method. Example: The following is a JSON string example. Not all parameters are listed. Add others as needed when you write your code:
{
    "service_type": 4,
    "nls_config": {
        "model": "fun-asr-realtime",
        "sr_format": "pcm",
        "sample_rate": "16000"
    }
}
Parameters
Top-level parameterTypeRequiredDescription
service_typeintYesThe speech service type. Fixed to 4 for real-time speech recognition.
nls_configobjectYesThe core configuration object for speech recognition. It contains key parameters such as model selection and recognition-quality controls.
nls_config.modelstringYesThe model name.
nls_config.sr_formatstringYesThe audio format.Valid values:
  • pcm
  • opus
For Opus audio, pass PCM audio to the SDK. The SDK encodes it as Opus internally.
nls_config.sample_rateintYesThe sample rate, in Hz.Valid values: 8 kHz models support only 8000 Hz; other models support any sample rate.
8000 Hz is not supported when an on-device audio processing capability such as AEC or VAD is enabled.
nls_config.max_sentence_silenceintNoThe VAD silence threshold for segmentation, in ms. When the silence after a segment of speech exceeds this threshold, the system determines that the sentence has ended.Default value: 1300.Valid values: [200, 6000].
nls_config.multi_threshold_mode_enabledbooleanNoWhether to enable multi-threshold mode. When enabled, this prevents VAD segments from becoming too long.Default value: false.
nls_config.heartbeatbooleanNoWhether to enable heartbeat packets.Default value: false.
  • true: Keeps the connection to the server alive even when silent audio is sent continuously.
  • false (default): Even when silent audio is continuously sent, the connection times out and closes after a period of time.
Silent audio refers to content in an audio file or data stream that contains no sound signal. You can generate silent audio in several ways, such as using audio editing software like Audacity or Adobe Audition, or using a command-line tool like FFmpeg.
nls_config.vocabulary_idstringNoThe ID of a precompiled hot word list.Generate this ID in advance by calling the create hot word list API. Pass the ID during recognition to use the hot words in the list.Suitable for scenarios where the vocabulary is known and relatively stable, and where you need to reuse the same word list across requests.For usage details, see Precompiled hotwords.
nls_config.language_hintsarray[string]NoThe language of the audio to recognize. There is no default value; if not set, the model detects the language automatically.You can set 1 value. If you set more, only the first value takes effect.
  • fun-asr-realtime:
    • zh: Chinese
    • en: English
    • ja: Japanese
    • ko: Korean
    • vi: Vietnamese
    • th: Thai
    • id: Indonesian
    • ms: Malay
    • tl: Filipino
    • hi: Hindi
    • ar: Arabic
    • fr: French
    • de: German
    • es: Spanish
    • pt: Portuguese
    • ru: Russian
    • it: Italian
    • nl: Dutch
    • sv: Swedish
    • da: Danish
    • fi: Finnish
    • no: Norwegian
    • el: Greek
    • pl: Polish
    • cs: Czech
    • hu: Hungarian
    • ro: Romanian
    • bg: Bulgarian
    • hr: Croatian
    • sk: Slovak
  • fun-asr-realtime-2026-02-28:
    • zh: Chinese
    • en: English
    • ja: Japanese
  • fun-asr-flash-8k-realtime, fun-asr-flash-8k-realtime-2026-01-28:
    • zh: Chinese
  • fun-asr-mtl-realtime-2025-12-10:
    • zh: Chinese
    • en: English
    • ja: Japanese
    • ko: Korean
    • vi: Vietnamese
    • id: Indonesian
    • th: Thai
nls_config.speech_noise_thresholdfloatNoThe threshold for distinguishing speech from noise, used to adjust the sensitivity of Voice Activity Detection (VAD).Valid values: [-1.0, 1.0].Value descriptions:
  • The closer the value is to -1: The noise threshold decreases, so noise is more likely to be recognized as speech, which may cause more noise to be transcribed.
  • The closer the value is to +1: The noise threshold increases, so speech is more likely to be misjudged as noise, which may cause some speech to be filtered out.
This is an advanced configuration parameter. Adjusting it can significantly affect recognition results. Recommendations:
  • Thoroughly test and verify the results before adjusting.
  • Adjust in small increments based on the actual audio environment (a step of 0.1 is recommended).
nls_config.special_word_filterobjectNoSpecifies the sensitive words to process during speech recognition, and supports setting different processing methods for different sensitive words. For details, see Sensitive word filtering.
nls_config.enable_connection_fast_checkbooleanNoWhether to quickly detect network outages and report them as soon as possible. Default: false.

API reference

Shared interfaces

stopDialog

Ends recognition. After you call this method, the server returns the final recognition result and ends the task. Method signature
public synchronized int stopDialog();
Return value An error code.

cancelDialog

Ends recognition immediately. After you call this method, the task ends at once without waiting for the server to return the final recognition result. Method signature
public synchronized int cancelDialog();
Return value An error code.

GetVersion

Gets the current SDK version information. Method signature
public synchronized String GetVersion();
Return value The current SDK version information.

onNuiLogTrackCallback: listen for trace logs

This callback receives detailed internal logs from the SDK to help with troubleshooting and debugging.
default void onNuiLogTrackCallback(Constants.LogLevel level, String log)

Qwen-Audio-ASR-Streaming / Fun-ASR-Realtime

release

Releases all internal resources of the SDK. After you call this method, the SDK instance becomes unavailable. To use it again, you must reinitialize it by calling initialize. Method signature
public synchronized int release();
Return value An error code.

Qwen-Audio-ASR-Streaming

Key interfaces

NativeNui
initialize
Initializes a speech recognition SDK instance. The SDK is a singleton. Do not initialize it more than once before you call release. This method blocks, so call it on a non-UI thread. Method signature
public synchronized int initialize(final INativeNuiCallback callback,
                                   String parameters,
                                   final Constants.LogLevel level,
                                   final boolean save_log)
Parameters
ParameterTypeDescription
callbackINativeNuiCallbackThe implementation of the event and data callback interface.
parametersStringA JSON string that contains the authentication, connection, and debug parameters. See Connection and control parameters.
levelConstants.LogLevelControls the print level of the SDK's own logs.
save_logbooleanWhether to save local logs. If set to true, specify the path through debug_path in the Connection and control parameters, and optionally set the file size through max_log_file_size.
Return value An error code.
setParams
Sets the Speech recognition parameters in JSON format. Call this method before startDialog. Method signature
public synchronized int setParams(String params)
Parameters
ParameterTypeDescription
paramsStringSpeech recognition parameters.
Return value An error code.
startDialog
Starts recognition. Method signature
public synchronized int startDialog(VadMode vad_mode, String dialog_params)
Parameters
ParameterTypeDescription
vad_modeVadModeThe VAD mode. Fixed to VadMode.TYPE_P2T.
dialog_paramsStringIf the apikey parameter in Connection and control parameters uses a temporary API key, you can update it here when it expires.To improve recognition accuracy by using context, update the context here.The content is in JSON format:
{
  "apikey": "st-****",
  "input_context": [
    {
      "role": "user",
      "content": [
        {
          "text": "xxxxx",
          "type": "input_text"
        }
      ]
    }
  ]
}
Return value An error code.
updateAction
Sends a runtime action to notify on-device AEC of the playback state. Method signature
public synchronized int updateAction(String params);
Parameters
ParameterTypeDescription
paramsStringA JSON string that contains the runtime action.
params.typeStringSet to "action".
params.commandStringplay_start: When on-device AEC is used, notifies the SDK that the player has started playing audio.play_over: When on-device AEC is used, notifies the SDK that the player has finished playing audio.
Return value An error code.
updateAudio
When audio_update_manually is set to "true", call this method to actively push recording data instead of supplying the data through onNuiNeedAudioData. Method signature
public synchronized int updateAudio(byte[] data, int len,
                                    boolean first_pack);
Parameters
ParameterTypeDescription
databyte[]The audio data to push.
lenintThe number of bytes of audio data to push.
first_packbooleanIgnore this parameter.
Return value An error code.
updateRefAudio
When audio_update_manually is set to "true" and on-device AEC is enabled, call this method to push the audio played by the player as the reference signal. Method signature
public synchronized int updateRefAudio(byte[] data, int len,
                                       boolean first_pack);
Parameters
ParameterTypeDescription
databyte[]The audio data to push.
lenintThe number of bytes of audio data to push.
first_packbooleanIgnore this parameter.
Return value An error code.
INativeNuiCallback: listener callbacks
onNuiEventCallback: listen for events and speech recognition results
Method signature
void onNuiEventCallback(NuiEvent event, final int resultCode, final int arg2, KwsResult kwsResult, AsrResult asrResult);
Parameters
ParameterTypeDescription
eventNuiEventThe callback event.
resultCodeintThe error code. Valid when the EVENT_ASR_ERROR event occurs.
arg2intA reserved parameter.
asrResultAsrResultThe speech recognition result.
kwsResultKwsResultThe voice wake-up feature. You do not need to use this parameter.
onNuiAudioStateChanged: listen for the audio state
The SDK uses this callback to notify you when to start or stop recording. Method signature
void onNuiAudioStateChanged(AudioState state);
AudioState states
StateDescription
STATE_OPENThe interaction has started. You can open the recording device and start recording.
STATE_PAUSEThe interaction has stopped. You can stop recording.
STATE_CLOSEThe SDK instance has been released. You can fully close the recording device.
onNuiNeedAudioData: supply the audio data to recognize
After recognition starts, this callback is triggered continuously. Supply the audio data to recognize in this callback. Method signature
int onNuiNeedAudioData(byte[] buffer, int len);
Parameters
ParameterTypeDescription
bufferbyte[]The audio data to fill.
lenintThe number of bytes of audio data to fill.
Return value The number of bytes actually filled.
onNuiAssistEventCallback: receive auxiliary events and data
This callback receives auxiliary events and related data from the SDK. Method signature
void onNuiAssistEventCallback_(int event, byte[] info, int info_len,
                               byte[] data);
Parameters
ParameterTypeDescription
eventintA NuiEvent event.
infoStringIgnore this parameter.
info_lenintIgnore this parameter.
databyte[]Auxiliary data, such as audio data processed by AEC.
NuiEvent: event types
EventDescription
EVENT_TRANSCRIBER_STARTEDThe task started successfully.
EVENT_VAD_STARTTriggered right after the task starts. This does not mean that the start of speech is detected.
EVENT_VAD_ENDThe end of speech is detected.
EVENT_ASR_PARTIAL_RESULTAn intermediate speech recognition result.
EVENT_ASR_WARNA warning that does not interrupt speech recognition occurred, such as a network outage when reconnection is enabled.
EVENT_ASR_ERRORAn error occurred during speech recognition.
EVENT_MIC_ERRORTriggered when no audio data is received for 2 consecutive seconds.
EVENT_SENTENCE_ENDThe end of a sentence is detected. A complete recognition result for the sentence is returned.
EVENT_TRANSCRIBER_COMPLETESpeech recognition has ended.
EVENT_AEC_DATAAudio data processed by AEC.

Qwen-Audio-ASR-Message

Key interfaces

NativeNui
initialize
Initializes a speech recognition SDK instance. The SDK is a singleton. Do not initialize it more than once before you call release. This method blocks, so call it on a non-UI thread. Method signature
public synchronized int initialize(final INativeNuiCallback callback,
                                   String parameters,
                                   final Constants.LogLevel level,
                                   final boolean save_log)
Parameters
ParameterTypeDescription
callbackINativeNuiCallbackThe implementation of the event and data callback interface.
parametersStringA JSON string that contains the authentication, connection, and debug parameters. See Connection and control parameters.
levelConstants.LogLevelControls the print level of the SDK's own logs.
save_logbooleanWhether to save local logs. If set to true, specify the path through debug_path in the Connection and control parameters, and optionally set the file size through max_log_file_size.
Return value An error code.
setParams
Sets the Speech recognition parameters in JSON format. Call this method before startDialog. Method signature
public synchronized int setParams(String params)
Parameters
ParameterTypeDescription
paramsStringSpeech recognition parameters.
Return value An error code.
startDialog
Starts recognition. Method signature
public synchronized int startDialog(VadMode vad_mode, String dialog_params)
Parameters
ParameterTypeDescription
vad_modeVadModeThe VAD mode. Fixed to VadMode.TYPE_P2T.
dialog_paramsStringIf the apikey parameter in Connection and control parameters uses a temporary API key, you can update it here when it expires.To improve recognition accuracy by using context, update the context here.The content is in JSON format:
{
  "apikey": "st-****",
  "input_context": [
    {
      "role": "user",
      "content": [
        {
          "text": "xxxxx",
          "type": "input_text"
        }
      ]
    }
  ]
}
Return value An error code.
updateAction
Sends an action command during an interaction to update runtime behavior, such as recognition context. Method signature
public synchronized int updateAction(String params);
Parameters
ParameterTypeDescription
paramsStringA JSON string used to update runtime behavior, such as recognition context.
params.typeStringSet to "action".
params.commandStringThe runtime command. Valid values:
  • context: Immediately updates the context to improve recognition accuracy.
  • play_start: When on-device AEC is used, notifies the SDK that the player has started playing audio.
  • play_over: When on-device AEC is used, notifies the SDK that the player has finished playing audio.
params.contextStringWhen command is set to context, immediately updates the context to improve recognition accuracy. The value is a JSON string, as shown in the following example.
{
  "context": [
    {
      "role": "user",
      "content": [
        {
          "text": "xxx",
          "type": "input_text"
        }
      ]
    }
  ]
}
Return value An error code.
updateAudio
When audio_update_manually is set to "true", call this method to actively push recording data instead of supplying the data through onNuiNeedAudioData. Method signature
public synchronized int updateAudio(byte[] data, int len,
                                    boolean first_pack);
Parameters
ParameterTypeDescription
databyte[]The audio data to push.
lenintThe number of bytes of audio data to push.
first_packbooleanIgnore this parameter.
Return value An error code.
updateRefAudio
When audio_update_manually is set to "true" and on-device AEC is enabled, call this method to push the audio played by the player as the reference signal. Method signature
public synchronized int updateRefAudio(byte[] data, int len,
                                       boolean first_pack);
Parameters
ParameterTypeDescription
databyte[]The audio data to push.
lenintThe number of bytes of audio data to push.
first_packbooleanIgnore this parameter.
Return value An error code.
release
Releases all internal resources of the SDK. After you call this method, the SDK instance becomes unavailable. To use it again, you must reinitialize it by calling initialize. Method signature
public synchronized int release();
Return value An error code.
INativeNuiCallback: listener callbacks
onNuiEventCallback: listen for events and speech recognition results
Method signature
void onNuiEventCallback(NuiEvent event, final int resultCode, final int arg2, KwsResult kwsResult, AsrResult asrResult);
Parameters
ParameterTypeDescription
eventNuiEventThe callback event.
resultCodeintThe error code. Valid when the EVENT_ASR_ERROR event occurs.
arg2intA reserved parameter.
asrResultAsrResultThe speech recognition result.
kwsResultKwsResultThe voice wake-up feature. You do not need to use this parameter.
onNuiAudioStateChanged: listen for the audio state
The SDK uses this callback to notify you when to start or stop recording. Method signature
void onNuiAudioStateChanged(AudioState state);
AudioState states
StateDescription
STATE_OPENThe interaction has started. You can open the recording device and start recording.
STATE_PAUSEThe interaction has stopped. You can stop recording.
STATE_CLOSEThe SDK instance has been released. You can fully close the recording device.
onNuiNeedAudioData: supply the audio data to recognize
After recognition starts, this callback is triggered continuously. Supply the audio data to recognize in this callback. Method signature
int onNuiNeedAudioData(byte[] buffer, int len);
Parameters
ParameterTypeDescription
bufferbyte[]The audio data to fill.
lenintThe number of bytes of audio data to fill.
Return value The number of bytes actually filled.
onNuiAssistEventCallback: receive auxiliary events and data
This callback receives auxiliary events and related data from the SDK. Method signature
void onNuiAssistEventCallback_(int event, byte[] info, int info_len,
                               byte[] data);
Parameters
ParameterTypeDescription
eventintA NuiEvent event.
infoStringIgnore this parameter.
info_lenintIgnore this parameter.
databyte[]Auxiliary data, such as audio data processed by AEC.
NuiEvent: event types
EventDescription
EVENT_TRANSCRIBER_STARTEDThe task started successfully.
EVENT_VAD_STARTTriggered right after the task starts. This does not mean that the start of speech is detected.
EVENT_VAD_ENDThe end of speech is detected.
EVENT_ASR_PARTIAL_RESULTAn intermediate speech recognition result.
EVENT_ASR_WARNA warning that does not interrupt speech recognition occurred, such as a network outage when reconnection is enabled.
EVENT_ASR_ERRORAn error occurred during speech recognition.
EVENT_MIC_ERRORTriggered when no audio data is received for 2 consecutive seconds.
EVENT_SENTENCE_ENDThe end of a sentence is detected. A complete recognition result for the sentence is returned.
EVENT_TRANSCRIBER_COMPLETESpeech recognition has ended.
EVENT_AEC_DATAAudio data processed by AEC.

Fun-ASR-Realtime

Key interfaces

NativeNui
initialize
Initializes a speech recognition SDK instance. The SDK is a singleton. Do not initialize it more than once before you call release. This method blocks, so call it on a non-UI thread. Method signature
public synchronized int initialize(final INativeNuiCallback callback,
                                   String parameters,
                                   final Constants.LogLevel level,
                                   final boolean save_log)
Parameters
ParameterTypeDescription
callbackINativeNuiCallbackThe implementation of the event and data callback interface.
parametersStringA JSON string that contains the authentication, connection, and debug parameters. See Connection and control parameters.
levelConstants.LogLevelControls the print level of the SDK's own logs.
save_logbooleanWhether to save local logs. If set to true, specify the path through debug_path in the Connection and control parameters, and optionally set the file size through max_log_file_size.
Return value An error code.
setParams
Sets the Speech recognition parameters in JSON format. Call this method before startDialog. Method signature
public synchronized int setParams(String params)
Parameters
ParameterTypeDescription
paramsStringSpeech recognition parameters.
Return value An error code.
startDialog
Starts recognition. Method signature
public synchronized int startDialog(VadMode vad_mode, String dialog_params)
Parameters
ParameterTypeDescription
vad_modeVadModeThe VAD mode. Fixed to VadMode.TYPE_P2T.
dialog_paramsStringIf the apikey parameter in Connection and control parameters uses a temporary API key, you can update it here when it expires.To improve recognition accuracy by using context, update the context here.The content is in JSON format:
{
  "apikey": "st-****",
  "input_context": [
    {
      "role": "user",
      "content": [
        {
          "text": "xxxxx",
          "type": "input_text"
        }
      ]
    }
  ]
}
Return value An error code.
updateAction
Sends a runtime action to notify on-device AEC of the playback state. Method signature
public synchronized int updateAction(String params);
Parameters
ParameterTypeDescription
paramsStringA JSON string that contains the runtime action.
params.typeStringSet to "action".
params.commandStringplay_start: When on-device AEC is used, notifies the SDK that the player has started playing audio.play_over: When on-device AEC is used, notifies the SDK that the player has finished playing audio.
Return value An error code.
updateAudio
When audio_update_manually is set to "true", call this method to actively push recording data instead of supplying the data through onNuiNeedAudioData. Method signature
public synchronized int updateAudio(byte[] data, int len,
                                    boolean first_pack);
Parameters
ParameterTypeDescription
databyte[]The audio data to push.
lenintThe number of bytes of audio data to push.
first_packbooleanIgnore this parameter.
Return value An error code.
updateRefAudio
When audio_update_manually is set to "true" and on-device AEC is enabled, call this method to push the audio played by the player as the reference signal. Method signature
public synchronized int updateRefAudio(byte[] data, int len,
                                       boolean first_pack);
Parameters
ParameterTypeDescription
databyte[]The audio data to push.
lenintThe number of bytes of audio data to push.
first_packbooleanIgnore this parameter.
Return value An error code.
INativeNuiCallback: listener callbacks
onNuiEventCallback: listen for events and speech recognition results
Method signature
void onNuiEventCallback(NuiEvent event, final int resultCode, final int arg2, KwsResult kwsResult, AsrResult asrResult);
Parameters
ParameterTypeDescription
eventNuiEventThe callback event.
resultCodeintThe error code. Valid when the EVENT_ASR_ERROR event occurs.
arg2intA reserved parameter.
asrResultAsrResultThe speech recognition result.
kwsResultKwsResultThe voice wake-up feature. You do not need to use this parameter.
onNuiAudioStateChanged: listen for the audio state
The SDK uses this callback to notify you when to start or stop recording. Method signature
void onNuiAudioStateChanged(AudioState state);
AudioState states
StateDescription
STATE_OPENThe interaction has started. You can open the recording device and start recording.
STATE_PAUSEThe interaction has stopped. You can stop recording.
STATE_CLOSEThe SDK instance has been released. You can fully close the recording device.
onNuiNeedAudioData: supply the audio data to recognize
After recognition starts, this callback is triggered continuously. Supply the audio data to recognize in this callback. Method signature
int onNuiNeedAudioData(byte[] buffer, int len);
Parameters
ParameterTypeDescription
bufferbyte[]The audio data to fill.
lenintThe number of bytes of audio data to fill.
Return value The number of bytes actually filled.
onNuiAssistEventCallback: receive auxiliary events and data
This callback receives auxiliary events and related data from the SDK. Method signature
void onNuiAssistEventCallback_(int event, byte[] info, int info_len,
                               byte[] data);
Parameters
ParameterTypeDescription
eventintA NuiEvent event.
infoStringIgnore this parameter.
info_lenintIgnore this parameter.
databyte[]Auxiliary data, such as audio data processed by AEC.
NuiEvent: event types
EventDescription
EVENT_TRANSCRIBER_STARTEDThe task started successfully.
EVENT_VAD_STARTTriggered right after the task starts. This does not mean that the start of speech is detected.
EVENT_VAD_ENDThe end of speech is detected.
EVENT_ASR_PARTIAL_RESULTAn intermediate speech recognition result.
EVENT_ASR_WARNA warning that does not interrupt speech recognition occurred, such as a network outage when reconnection is enabled.
EVENT_ASR_ERRORAn error occurred during speech recognition.
EVENT_MIC_ERRORTriggered when no audio data is received for 2 consecutive seconds.
EVENT_SENTENCE_ENDThe end of a sentence is detected. A complete recognition result for the sentence is returned.
EVENT_TRANSCRIBER_COMPLETESpeech recognition has ended.
EVENT_AEC_DATAAudio data processed by AEC.