Qwen-Audio-3.0-ASR-Flash-Streaming/Fun-ASR-Realtime iOS SDK

​

Quick start

1. Get an API key: Obtain an API key
2. Download the SDK and run the sample code:
   • Download the latest SDK package.
   • Extract the ZIP package and add the included nuisdk.xcframework to your project.
   • In Build Phases → Link Binary With Libraries, add nuisdk.xcframework.
   • In General → Frameworks, Libraries, and Embedded Content, set nuisdk.xcframework to Embed & Sign.
   • Open the sample project in Xcode. The sample code is in DashFunAsrSpeechTranscriberViewController.m. Replace the API key with your own to try out the feature.

​

Call sequence

1. Initialize the SDK.
2. Set parameters for your use case: use the nui_initialize API to set Connection and control parameters, and use the nui_set_params API to set Recognition quality parameters.
3. Call nui_dialog_start to start the recognition process.
4. In the onNuiAudioStateChanged callback, open the recording device based on the audio state.
5. In the onNuiNeedAudioData callback, continuously supply recording data, or call nui_update_audio_data to actively push recording data.
6. In the onNuiEventCallback callback, listen for events and retrieve speech recognition results.
7. Call nui_dialog_cancel to stop recognition, and confirm that recognition has finished by listening for the EVENT_TRANSCRIBER_COMPLETE event.
8. When you no longer need the recognition feature, call nui_release to release the SDK resources.

​

Request parameters

​

Connection and control parameters

• Example parameters: The following JSON string is an example and does not list all parameters. Add the parameters you need when you write your code:

{
    "url": "wss://maas.qwencloudapi.com/api-ws/v1/inference",
    "apikey": "st-****",
    "device_id": "my_device_id",
    "service_mode": "1"
}

• Parameter descriptions

​

Recognition quality parameters

• Example parameters: The following JSON string is an example and does not list all parameters. Add the parameters you need when you write your code:

{
    "service_type": 4,
    "nls_config": {
        "model": "qwen-audio-3.0-asr-flash-streaming",
        "sr_format": "pcm",
        "sample_rate": "16000"
    }
}

• Parameter descriptions

​

Key APIs

​

NeoNui

​

nui_initialize

• Method signature

-(NuiResultCode) nui_initialize:(const char *)parameters
                       logLevel:(NuiSdkLogLevel)level
                        saveLog:(BOOL)save_log;

• Parameter descriptions

• Return value Returns an error code. See Error code reference.

​

nui_set_params

• Method signature

-(NuiResultCode) nui_set_params:(const char *)params;

• Parameter descriptions

• Return value Returns an error code. See Error code reference.

​

nui_dialog_start

• Method signature

-(NuiResultCode) nui_dialog_start:(NuiVadMode)vad_mode
                      dialogParam:(const char *)dialog_params;

• Parameter descriptions

{
  "apikey": "st-****",
  "input_context": [
    {
      "role": "user",
      "content": [
        {
          "text": "xxxxx",
          "type": "input_text"
        }
      ]
    }
  ]
}

• Return value Returns an error code. See Error code reference.

​

nui_dialog_cancel

• Method signature

-(NuiResultCode) nui_dialog_cancel:(BOOL)force;

• Parameter descriptions

• Return value Returns an error code. See Error code reference.

​

nui_dialog_action

• Method signature

-(NuiResultCode) nui_dialog_action:(const char *)action_params;

• Parameter descriptions

{
  "context": [
    {
      "role": "user",
      "content": [
        {
          "text": "xxx",
          "type": "input_text"
        }
      ]
    }
  ]
}

• Return value Returns an error code. See Error code reference.

​

nui_update_audio_data

• Method signature

-(NuiResultCode) nui_update_audio_data:(const char *)data
                                    Len:(int)length
                              FirstPack:(BOOL)first_pack;

• Parameter descriptions

• Return value Returns an error code. See Error code reference.

​

nui_push_reference_data

• Method signature

-(NuiResultCode) nui_push_reference_data:(const char *)data
                                     Len:(int)length
                               FirstPack:(BOOL)first_pack;

• Parameter descriptions

• Return value Returns an error code. See Error code reference.

​

nui_release

• Method signature

-(NuiResultCode) nui_release;

• Return value Returns an error code. See Error code reference.

​

nui_get_version

• Method signature

-(const char*) nui_get_version;

• Return value The current SDK version.

​

nui_get_all_response

• Method signature

-(const char*) nui_get_all_response;

• Return value The complete event information as a JSON string.

​

NeoNuiSdkDelegate: callback listeners

​

onNuiEventCallback

• Method signature

-(void) onNuiEventCallback:(NuiCallbackEvent)nuiEvent
                    dialog:(long)dialog
                 kwsResult:(const char *)wuw
                 asrResult:(const char *)asr_result
                  ifFinish:(BOOL)finish
                   retCode:(int)code;

• Parameter descriptions

​

onNuiAudioStateChanged

• Method signature

-(void) onNuiAudioStateChanged:(NuiAudioState)state;

• NuiAudioState states

​

onNuiNeedAudioData

• Method signature

-(int) onNuiNeedAudioData:(char *)audioData length:(int)len;

• Parameter descriptions

​

onNuiAssistEventCallback

• Method signature

-(void) onNuiAssistEventCallback:(NuiCallbackEvent)nuiEvent
                            info:(char*)info
                         infoLen:(int)info_len
                          buffer:(char*)buffer
                             len:(int)len;

• Parameter descriptions

​

onNuiLogTrackCallback

-(void) onNuiLogTrackCallback:(NuiSdkLogLevel)level
                   logMessage:(const char *)log;

​

NuiCallbackEvent: event types