Paraformer real-time speech recognition iOS SDK

​

Getting started

1. Obtain an API key: Obtain an API key

2. Download the SDK and run the sample code:
   • Download the latest SDK package.
   • Unzip the package and add nuisdk.framework to your project.
   • In the Build Phases settings, under Link Binary With Libraries, add nuisdk.framework.
   • In the General settings, under Frameworks, Libraries, and Embedded Content, set nuisdk.framework to Embed & Sign.
   • Open the sample project in Xcode. The sample code is in the DashParaformerSpeechTranscriberViewController class. Replace the API key to test the feature.

​

Call procedure

1. Initialize the SDK.
2. Configure the parameters as needed. Use the nui_initialize interface to set connection and control parameters. Use the nui_set_param interface to set speech recognition effect parameters.
3. Call nui_dialog_start to start the recognition process.
4. In the onNuiAudioStateChanged callback, start the recording device based on the audio state.
5. In the onNuiNeedAudioData callback, continuously provide the recorded audio data.
6. In the onNuiEventCallback callback, listen for events and retrieve the speech recognition results.
7. Call nui_dialog_cancel to stop the recognition. Confirm that the recognition has ended by listening for the EVENT_TRANSCRIBER_COMPLETE event.
8. When you no longer need the recognition feature, call the nui_release interface to release the SDK resources.

​

Request parameters

​

Connection and control parameters

• Parameter example: The following code provides an example of the JSON string. Not all parameters are listed. You can add parameters as needed during encoding:

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

• Parameter descriptions

​

Speech recognition effect parameters

• Parameter example: The following code provides an example of the JSON string. Not all parameters are listed. You can add parameters as needed during encoding:

{
    "service_type": 4,
    "nls_config": {
        "model": "paraformer-realtime-v2",
        "sr_format": "pcm",
        "sample_rate": "16000"
    }
}

• Parameter descriptions

​

Key interfaces

​

NeoNui

​

nui_initialize

• Method signature

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

• Parameter descriptions

• Return value

​

nui_set_param

• Method signature

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

• Parameter descriptions

• Return value

​

nui_dialog_start

• Method signature

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

• Parameter descriptions

{
  "apikey": "st-****"
}

• Return value

​

nui_dialog_cancel

• Method signature

-(NuiResultCode) nui_dialog_cancel:(BOOL)force;

• Parameter descriptions

• Return value

​

nui_release

• Method signature

-(NuiResultCode) nui_release;

• Return value

​

nui_get_version

• Method signature

-(const char*) nui_get_version;

• Return value The current version of the SDK.

​

nui_get_all_response

• Method signature

-(const char*) nui_get_all_response;

• Return value A JSON string that contains the complete event information.

​

NeoNuiSdkDelegate: Listener callbacks

​

onNuiEventCallback: Listen for events and speech recognition results

• 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: Listen for audio state

• Method signature

-(void) onNuiAudioStateChanged:(NuiAudioState)state;

• NuiAudioState descriptions

​

onNuiNeedAudioData: Fill audio data for recognition

• Method signature

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

• Parameter descriptions

​

onNuiLogTrackCallback: Listen for tracking logs

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

​

NuiCallbackEvent: Event types