移动端SDK说明

前提条件与使用限制

• 已开通录音文件识别极速版商用服务。极速版不支持试用，开通、计费及并发限制请参见录音文件识别极速版接口说明。

• 已获取项目 Appkey 和有效的 NLS Token，分别参见管理项目和获取 Token。识别语种和模型在项目中配置，所选模型应与音频语种匹配。

• 音频格式支持 WAV、MP3、AAC、MP4、OPUS。文件大小不超过 100 MB，时长不超过 2 小时。

获取 SDK

从移动端 SDK 选择与下载获取支持录音文件识别的 SDK 包，并按该页核对兼容性和合规使用要求。包内录音文件识别示例为 Android 的 FileTranscriberActivity.java 和 iOS 的 FileTranscriberViewController.m。

具体集成和代码示例请参见Android SDK和iOS SDK。

SDK V2.6.2 起，纯云端功能不需要复制资源文件或设置 workspace。

服务地址

SDK 初始化时通过 url 设置服务地址。移动设备通过公网接入；VPC 内网地址用于具备对应地域 VPC 网络访问条件的运行环境。

Host 为 URL 的域名部分，例如上海公网地址对应 nls-gateway-cn-shanghai.aliyuncs.com。

调用流程

下图展示 Android SDK 和 iOS SDK 的交互流程。

1. 创建 SDK 实例并设置录音文件识别回调，使用 Appkey、NLS Token、服务地址和设备标识初始化 SDK。

2. 设置识别参数。nls_config 可以通过参数设置接口配置，也可以在启动任务的参数中传入。

3. 传入本地音频文件的绝对路径并启动任务。接口返回 0 表示调用成功；识别结果通过 EVENT_FILE_TRANS_RESULT 回调返回，发生错误时收到 EVENT_ASR_ERROR。

4. 处理识别结果，不再使用 SDK 时释放资源。初始化、启动和释放等同步调用应在非 UI 线程执行。

两端的调用接口如下。

void onFileTransEventCallback(Constants.NuiEvent event, int resultCode,
        int finish, AsrResult asrResult, String taskId);

- (void)onFileTransEventCallback:(NuiCallbackEvent)nuiEvent
                     asrResult:(const char *)asr_result
                        taskId:(const char *)task_id
                      ifFinish:(BOOL)finish
                       retCode:(int)code;

参数说明

{
  "url": "https://nls-gateway-cn-shanghai.aliyuncs.com/stream/v1/FlashRecognizer",
  "app_key": "<APPKEY>",
  "token": "<NLS_TOKEN>",
  "device_id": "<DEVICE_ID>"
}

{
  "file_path": "<AUDIO_FILE_PATH>",
  "nls_config": {
    "format": "wav",
    "sample_rate": 16000,
    "enable_word_level_result": true
  }
}

{
  "token": "<NEW_NLS_TOKEN>"
}

响应说明

识别结果通过 EVENT_FILE_TRANS_RESULT 返回。以下为开启词级结果的响应示例。

{
  "task_id": "<TASK_ID>",
  "status": 20000000,
  "message": "SUCCESS",
  "flash_result": {
    "duration": 3834,
    "completed": true,
    "sentences": [
      {
        "text": "hello world, ",
        "words": [
          {
            "text": "hello ",
            "begin_time": "280",
            "end_time": "752",
            "punc": ""
          },
          {
            "text": "world",
            "begin_time": "752",
            "end_time": "988",
            "punc": ", "
          }
        ],
        "begin_time": 280,
        "end_time": 988,
        "channel_id": 0
      },
      {
        "text": "这里是阿里巴巴语音实验室。",
        "words": [
          {
            "text": "这里",
            "begin_time": "988",
            "end_time": "1460",
            "punc": ""
          },
          {
            "text": "是",
            "begin_time": "1460",
            "end_time": "1696",
            "punc": ""
          },
          {
            "text": "阿里巴巴",
            "begin_time": "1696",
            "end_time": "2640",
            "punc": ""
          },
          {
            "text": "语音",
            "begin_time": "2640",
            "end_time": "3112",
            "punc": ""
          },
          {
            "text": "实验室",
            "begin_time": "3112",
            "end_time": "3820",
            "punc": "。"
          }
        ],
        "begin_time": 988,
        "end_time": 3820,
        "channel_id": 0
      }
    ]
  }
}

flash_result 字段

sentences 字段

words 字段

错误码

服务端和移动端 SDK 的错误码及处理方法，请参见错误码查询。