Qwen-Audio-ASR-Message实时语音识别iOS SDK

本文档提供了Qwen-Audio-3.1-ASR-Flash-Message实时语音识别iOS SDK的详细使用指南，帮助您将语音转换为文本。

快速开始

1. 获取API Key：获取与配置 API Key

2. 下载SDK并运行示例代码：
   • 下载最新SDK整合包。
   • 解压 ZIP 包，将其中的 nuisdk.xcframework 添加到工程。
   • 在 Build Phases → Link Binary With Libraries 中添加 nuisdk.xcframework。
   • 在 General → Frameworks, Libraries, and Embedded Content 中将 nuisdk.xcframework 设置为 Embed & Sign。
   • 用 Xcode 打开示例工程。示例代码位于DashFunAsrSpeechTranscriberViewController.m，替换 API Key 后体验功能。

调用步骤

1. 初始化 SDK
2. 按业务需求设置参数：通过nui_initialize接口设置连接与控制参数；通过nui_set_params接口设置语音识别效果参数。
3. 调用nui_dialog_start启动识别流程。
4. 在onNuiAudioStateChanged回调中，根据音频状态开启录音设备。
5. 在onNuiNeedAudioData回调中持续提供录音数据，或者通过nui_update_audio_data持续推送录音数据。
6. 在onNuiEventCallback回调中监听事件并获取语音识别结果。
7. 调用nui_dialog_cancel停止识别，并通过监听EVENT_TRANSCRIBER_COMPLETE事件确认识别已结束。
8. 当识别功能不再使用时，调用nui_release接口释放 SDK 资源。

请求参数

连接与控制参数

通过在nui_initialize接口的parameters参数中传入一个JSON字符串来配置。

参数示例：以下为 JSON 字符串示例，参数未完整列出。请按实际需求在编码时补充：

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

语音识别效果参数

通过在nui_set_params接口的params参数中传入一个JSON字符串来配置。

参数示例：以下为 JSON 字符串示例，参数未完整列出。请按实际需求在编码时补充：

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

关键接口

NeoNui

nui_initialize

初始化语音识别SDK实例。SDK为单例模式，在调用 nui_release 前禁止重复初始化。

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

返回错误码，参见错误码查询。

nui_set_params

以JSON格式设置语音识别效果参数。在 nui_dialog_start 之前调用。

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

返回错误码，参见错误码查询。

nui_dialog_start

开始识别。

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

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

返回错误码，参见错误码查询。

nui_dialog_cancel

结束识别或者立即取消当前交互。

-(NuiResultCode) nui_dialog_cancel:(BOOL)force;

返回错误码，参见错误码查询。

nui_dialog_action

在交互过程中下发对话动作指令，用于更新识别上下文等运行时行为。

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

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

返回错误码，参见错误码查询。

nui_update_audio_data

当 audio_update_manually 设为 "true" 时，录音数据不再通过 onNuiNeedAudioData 填入，而是通过此接口主动推送。

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

返回错误码，参见错误码查询。

nui_push_reference_data

当 audio_update_manually 设为 "true" 且启用端侧 AEC 回声消除能力时，需要通过此接口推送播放器播放的音频数据作为参考信号。

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

返回错误码，参见错误码查询。

nui_release

释放SDK所有内部资源，并强制终止所有正在进行的任务。此方法调用后，SDK实例将变为不可用状态，如需再次使用，必须重新调用 nui_initialize 进行初始化。

-(NuiResultCode) nui_release;

返回错误码，参见错误码查询。

nui_get_version

获得当前SDK版本信息。此接口需在 nui_initialize 之后调用才有返回值。

-(const char*) nui_get_version;

当前SDK版本信息。

nui_get_all_response

获得当前事件回调的完整信息。

-(const char*) nui_get_all_response;

JSON字符串格式的完整事件信息。

NeoNuiSdkDelegate：监听回调

onNuiEventCallback：监听事件和语音识别结果

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

onNuiAudioStateChanged：监听音频状态

SDK 通过此回调通知何时应该开始或停止录音。

-(void) onNuiAudioStateChanged:(NuiAudioState)state;

onNuiNeedAudioData：填充待识别音频数据

开始识别后，该回调被连续触发，需在其中提供待识别音频数据。

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

onNuiAssistEventCallback：辅助数据和信息结果

此回调用于接收 SDK 内部的辅助事件和相关数据。

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

onNuiLogTrackCallback：监听追踪日志

此回调用于接收 SDK 内部的详细日志，方便进行问题定位和调试。

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

NuiCallbackEvent：事件类型