Paraformer real-time speech recognition Android SDK

​

Getting started

1. Obtain an API key: Get an API key. For security purposes, configure the API key as an environment variable.

2. Download the SDK and run the sample code:
   • Download the latest SDK package.
   • Unzip the package. Obtain the AAR-format SDK from the app/libs folder and add it to your project dependencies.
     For Android C++ integration, use the android_libs and android_include folders in the ZIP package to obtain the dynamic libraries and header files.
     
     
   • Open the project in Android Studio. The sample code is in DashParaformerSpeechTranscriberActivity.java. Replace the API key to test the feature.

​

Invocation steps

1. Initialize the SDK.
2. Set the required parameters. Use the parameters parameter of the initialize method to set connection and control parameters. Use the setParams method to set speech recognition effect parameters.
3. Call startDialog 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 recording data.
6. In the onNuiEventCallback callback, listen for events and retrieve the speech recognition results.
7. Call stopDialog to stop recognition. Confirm that recognition has ended by listening for the EVENT_TRANSCRIBER_COMPLETE event.
8. When the recognition feature is no longer needed, call the release method to release SDK resources.

​

Request parameters

​

Connection and control parameters

• Parameter example: The following code provides a sample 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 a sample 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

​

NativeNui

​

initialize

• Method signature

public synchronized int initialize(final INativeNuiCallback callback,
                                   String parameters,
                                   final Constants.LogLevel level,
                                   final boolean save_log)

• Parameter descriptions

• Return value

​

setParams

• Method signature

public synchronized int setParams(String params)

• Parameter descriptions

• Return value

​

startDialog

• Method signature

public synchronized int startDialog(VadMode vad_mode, String dialog_params)

• Parameter descriptions

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

• Return value

​

stopDialog

• Method signature

public synchronized int stopDialog();

• Return value

​

cancelDialog

• Method signature

public synchronized int cancelDialog();

• Return value

​

release

• Method signature

public synchronized int release();

• Return value

​

GetVersion

• Method signature

public synchronized String GetVersion();

• Return value The current SDK version information.

​

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);

• Parameter descriptions

​

onNuiAudioStateChanged: Listen for audio state

• Method signature

void onNuiAudioStateChanged(AudioState state);

• AudioState descriptions

​

onNuiNeedAudioData: Fill in audio data for recognition

• Method signature

int onNuiNeedAudioData(byte[] buffer, int len);

• Parameter descriptions

• Return value The actual number of bytes filled.

​

onNuiLogTrackCallback: Listen for tracking logs

default void onNuiLogTrackCallback(Constants.LogLevel level, String log)

​

NuiEvent: Event types