C++ SDK

SDK下载

可通过以下两种方法获取SDK。

• 方法一：从GitHub获取最新源码，详细编译和运行方式可见下文，或查看源码中的readme.md。

  git clone --depth 1 https://github.com/aliyun/alibabacloud-nls-cpp-sdk

• 方法二：直接从下表中选取需要SDK包进行下载。其中SDK源码包为SDK原始代码，需要通过下文编译方法生成集成所需的库文件。其他对应平台的SDK包内含相关库文件、头文件，无需编译。

  最新SDK包	平台	MD5
  alibabacloud-nls-cpp-sdk3.2.0f-master_dcaf740.zip	SDK源码	054d6f9f3226f689dbc68f8ed970fe3b
  NlsCppSdk_Linux-x86_64_3.2.0f_dcaf740.tar.gz	Linux x86_64	1ebb39ec10993583a645c0de8eebf654
  NlsCppSdk_Linux-aarch64_3.1.15_fa30fba.tar.gz	Linux aarch64	76c34a3ab397d7285963a139b9270ff4
  NlsCppSdk_Windows_3.1.16_4776504.zip	Windows	c428e5cf1295d8933d23a4945683e250

  其中：

  • alibabacloud-nls-cpp-sdk<version>-master_<github commit id>.zip为SDK源码包。

  • NlsCppSdk_<平台>_<版本号>_<github commit id>.tar.gz为对应平台下开发需要的SDK包，详见内部readme.md。

SDK包文件说明

• scripts/build_linux.sh：SDK源码中，以Linux平台为例的示例编译脚本。

• CMakeLists.txt：SDK源码中，以Linux平台为例的示例代码工程CMakeList文件。

• demo目录：SDK包中，集成示例代码，以Linux平台为例，如下表所示。

文件名	描述
speechRecognizerDemo.cpp	一句话识别示例。
speechSynthesizerDemo.cpp	语音合成示例。
speechTranscriberDemo.cpp	实时语音识别示例。
fileTransferDemo.cpp	录音文件识别示例。

• resource目录：SDK源码中，语音服务范例音频，可用于功能测试，如下表所示。

文件名	描述
test0.wav test1.wav test2.wav test3.wav	测试音频（16k采样频率、16bit采样位数的音频文件）。

• include：SDK源码中的头文件，如下表所示。

  文件名	描述
  nlsClient.h	SDK实例。
  nlsEvent.h	回调事件说明。
  nlsGlobal.h	SDK全局头文件。
  nlsToken.h	SDK Access Token实例。
  iNlsRequest.h	NLS请求基础头文件。
  speechRecognizerRequest.h	一句话识别。
  speechSynthesizerRequest.h	语音合成、长文本语音合成。
  speechTranscriberRequest.h	实时音频流识别。
  FileTrans.h	录音文件识别。

• lib：SDK库文件。

• readme.md：SDK说明。

• release.log：版本说明。

• version：版本号。

编译运行

关键接口

• 基础接口

  • NlsClient：语音处理客户端，利用该客户端可以进行一句话识别、实时语音识别和语音合成的语音处理任务。该客户端为线程安全，建议全局仅创建一个实例。

    接口名	启用版本	功能描述
    getInstance	2.x	获取（创建）NlsClient实例。
    setLogConfig	2.x	设置日志文件与存储路径。
    setDirectHost	3.x	跳过DNS域名解析直接设置服务器ipv4地址，若调用则需要在startWorkThread之前。
    setAddrInFamily	3.1.12	设置套接口地址结构的类型，默认为AF_INET仅返回IPV4相关的地址信息，需要在startWorkThread之前调用。
    setUseSysGetAddrInfo	3.1.13	若libevent的DNS无法满足，无法完成DNS，可调用此接口切换成系统的接口，需要在startWorkThread之前调用。
    setSyncCallTimeout	3.1.17	设置同步调用模式的超时时间（ms），0则为关闭同步模式，默认0。此模式start()后收到服务端结果再return出去，stop()后收到close()回调再return出去。
    startWorkThread	3.x	启动工作线程数，默认1即启动一个线程，若-1则启动CPU核数的线程数。在高并发的情况下建议选择-1。可以理解NlsClient实例初始化，必须调用。
    releaseInstance	3.x	销毁NlsClient对象实例。
    getVersion	2.x	获取SDK版本号。
    createTranscriberRequest	2.x	创建实时语音识别对象，线程安全，支持高并发请求。
    releaseTranscriberRequest	2.x	销毁实时语音识别对象，需要在当前请求的closed事件后调用。

  • NlsToken：创建Token对象，用于申请获取TokenId。申请新Token时需要先获取有效时间戳，若超过有效时间则再申请。若在有效时间内多次申请Token会导致TokenId错误而无法使用。

    接口名	功能描述
    setAccessKeyId	设置阿里云账号AccessKey ID。
    setKeySecret	设置阿里云账号AccessKey Secret。
    setDomain	设置域名，非必填。
    setServerVersion	设置API版本，非必填。
    setServerResourcePath	设置服务路径，非必填。
    setRegionId	设置服务的确ID，非必填。
    setAction	设置功能，非必填。
    applyNlsToken	申请获取TokenId。
    getToken	获取TokenId。
    getExpireTime	获取Token有效期时间戳（秒）。
    getErrorMsg	获得错误信息。

  • NlsEvent：事件对象，您可以从中获取Request状态码、云端返回结果、失败信息等。

    接口名	功能描述
    getStatusCode	获取状态码，正常情况为0或者20000000，失败时对应失败的错误码。
    getErrorMessage	在TaskFailed回调中，获取NlsRequest操作过程中出现失败时的错误信息。
    getTaskId	获取任务的TaskId。
    getAllResponse	获取云端返回的识别结果。
    getResult	获取中间识别结果和最终结果。
    getSentenceIndex	获取实时语音检测的句子编号。
    getSentenceTime	获取实时语音检测的句子的音频时长，单位是毫秒。
    getSentenceBeginTime	对应的SentenceBegin事件的时间，单位是毫秒。

• 识别接口

  SpeechTranscriberRequest：实时语音识别请求对象，用于长语音实时识别。接口说明以SpeechTranscriberRequest.h内容为准。

  接口名	启用版本	功能描述
  setOnTaskFailed	2.x	设置错误回调函数。
  setOnTranscriptionStarted	2.x	设置实时音频流识别开始回调函数。
  setOnSentenceBegin	2.x	设置一句话开始回调。
  setOnSentenceEnd	2.x	设置一句话结束回调函数。
  setOnTranscriptionResultChanged	2.x	设置实时音频流识别中间结果回调函数。
  setOnTranscriptionCompleted	2.x	设置服务端结束服务回调函数。
  setOnChannelClosed	2.x	设置通道关闭回调函数。
  setOnMessage	3.1.16	设置服务端response message回调函数，所有回调从此回调输出由用户自行解析。非必填。设置后需setEnableOnMessage启动。
  setAppKey	2.x	设置AppKey。
  setToken	2.x	口令认证。所有的请求都必须通过SetToken方法认证通过，才可以使用。
  setUrl	2.x	设置服务URL地址。
  setIntermediateResult	2.x	设置是否返回中间识别结果。
  setPunctuationPrediction	2.x	设置是否在后处理中添加标点。
  setInverseTextNormalization	2.x	设置是否在后处理中执行数字转换。
  setFormat	2.x	设置音频数据编码格式（PCM、OPUS、OPU，默认是PCM，推荐OPUS）。
  setSampleRate	2.x	音频采样率设置。
  setSemanticSentenceDetection	2.x	设置是否使用语义断句。
  setMaxSentenceSilence	2.x	设置vad阈值。
  setCustomizationId	2.x	设置定制模型。
  setVocabularyId	2.x	使用该接口也可以把项目和热词关联起来。如果同时配置了控制台热词和SDK，则SDK配置优先级最高，将会覆盖控制台热词配置。
  setTimeout	2.x	设置链接超时时间，默认5000ms。
  setSessionId	2.x	设置Session ID。
  setOutputFormat	2.x	设置输出文本的编码格式，编码格式UTF-8 or GBK。
  setPayloadParam	2.x	参数设置，入参为JSON格式字符串。
  setContextParam	2.x	设置用户自定义参数，入参为JSON格式字符串。
  AppendHttpHeaderParam	2.x	设置用户自定义ws阶段http header参数。
  setSendTimeout	3.1.14	设置发送超时时间，默认5000ms。
  setRecvTimeout	3.1.14	设置接收超时时间， 默认15000ms，需setEnableRecvTimeout开启后生效。
  setEnableRecvTimeout	3.1.16	设置开启接收超时时间，默认false，即默认关闭接收超时时间，开启后长时间未收服务端则报错。
  getOutputFormat	3.1.16	获得设置的输出文本的编码格式。
  setEnableOnMessage	3.1.16	设置开启服务器返回消息回调。
  getTaskId	3.1.17	获得当前请求的task_id。
  start	2.x	启动SpeechTranscriberRequest。
  stop	2.x	会与服务端确认关闭，正常停止实时音频流识别操作。
  cancel	2.x	不会与服务端确认关闭，直接关闭实时音频流识别过程。
  control	2.x	要求服务端更新识别参数。
  sendAudio	2.x	发送语音数据。建议一次发送音频数据640~16384字节。

C++SDK错误码

服务端响应状态码

关于服务状态码，请参见接口说明。

代码示例

#include <string.h>
#include <unistd.h>
#include <pthread.h>
#include <stdlib.h>
#include <ctime>
#include <string>
#include <iostream>
#include <vector>
#include <fstream>
#include <sys/time.h>
#include <errno.h>
#include "nlsClient.h"
#include "nlsEvent.h"
#include "nlsToken.h"
#include "speechTranscriberRequest.h"

#define FRAME_SIZE 3200
#define SAMPLE_RATE 16000

using namespace AlibabaNlsCommon; 
using AlibabaNls::NlsClient; 
using AlibabaNls::NlsEvent; 
using AlibabaNls::LogDebug; 
using AlibabaNls::LogInfo; 
using AlibabaNls::LogError;
using AlibabaNls::SpeechTranscriberRequest;

//自定义线程参数。
struct ParamStruct {
  std::string fileName;
  std::string appkey; 
  std::string token; 
};
//自定义事件回调参数。
struct ParamCallBack {
 public:
  ParamCallBack() {
    pthread_mutex_init(&mtxWord, NULL);
    pthread_cond_init(&cvWord, NULL);
  };
  ~ParamCallBack() {
    pthread_mutex_destroy(&mtxWord);
    pthread_cond_destroy(&cvWord);
  };

  int userId;
  char userInfo[8];
  pthread_mutex_t mtxWord;
  pthread_cond_t cvWord;
};

/**
 * 全局维护一个服务鉴权token和其对应的有效期时间戳，
 * 每次调用服务之前，首先判断token是否已经过期，
 * 如果已经过期，则根据AccessKey ID和AccessKey Secret重新生成一个token，
 * 并更新这个全局的token和其有效期时间戳。
 *
 * 获取Token具体操作，请参见：https://help.aliyun.com/document_detail/450514.html
 *
 * 注意：不要每次调用服务之前都重新生成新token，
 * 只需在token即将过期时重新生成即可。所有的服务并发可共用一个token。
 * 智能语音交互的AccessKey ID、AccessKey Secret和AppKey的环境变量名：NLS_AK_ENV、NLS_SK_ENV、NLS_APPKEY_ENV
 */
std::string g_akId = "";
std::string g_akSecret = "";
std::string g_token = "";
long g_expireTime = -1;
int g_sync_timeout = 0;
struct timeval tv;
struct timeval tv1;

/**
 * 根据AccessKey ID和AccessKey Secret重新生成一个token，
 * 并获取其有效期时间戳
 */
int generateToken(std::string akId, std::string akSecret,
                  std::string* token, long* expireTime) {
  NlsToken nlsTokenRequest;
  nlsTokenRequest.setAccessKeyId(akId); 
  nlsTokenRequest.setKeySecret(akSecret); 

  int ret = nlsTokenRequest.applyNlsToken();
  if (ret < 0) {
    // 获取失败原因。
    printf("generateToken Failed, error code:%d msg:%s\n",
        ret, nlsTokenRequest.getErrorMsg());
    return ret;
  }
  *token = nlsTokenRequest.getToken();
  *expireTime = nlsTokenRequest.getExpireTime();
  return 0;
}

/**
 * @brief 获取sendAudio发送延时时间
 * @param dataSize 待发送数据大小
 * @param sampleRate 采样率 16k/8K
 * @param compressRate 数据压缩率，例如压缩比为10:1的16k opus编码，此时为10；
 *                     非压缩数据则为1
 * @return 返回sendAudio之后需要sleep的时间
 * @note 对于8k pcm 编码数据, 16位采样，建议每发送1600字节 sleep 100 ms.
         对于16k pcm 编码数据, 16位采样，建议每发送3200字节 sleep 100 ms.
         对于其它编码格式(OPUS)的数据, 由于传递给SDK的仍然是PCM编码数据,
         按照SDK OPUS/OPU 数据长度限制, 需要每次发送640字节 sleep 20ms.
 */
unsigned int getSendAudioSleepTime(int dataSize,
                                   int sampleRate,
                                   int compressRate) { 
  // 仅支持16位采样
  const int sampleBytes = 16;     // 仅支持单通道
  const int soundChannel = 1;     // 当前采样率，采样位数下每秒采样数据的大小。
  int bytes = (sampleRate * sampleBytes * soundChannel) / 8;     // 当前采样率，采样位数下每毫秒采样数据的大小。
  int bytesMs = bytes / 1000;     // 待发送数据大小除以每毫秒采样数据大小，以获取sleep时间。
  int sleepMs = (dataSize * compressRate) / bytesMs;
  return sleepMs; 
}

/**
 * @brief 调用start(), 成功与云端建立连接, sdk内部线程上报started事件
 * @param cbEvent 回调事件结构, 详见nlsEvent.h
 * @param cbParam 回调自定义参数，默认为NULL, 可以根据需求自定义参数
 * @return
 */
void onTranscriptionStarted(NlsEvent* cbEvent, void* cbParam) {
  ParamCallBack* tmpParam = (ParamCallBack*)cbParam;
  // 演示如何打印/使用用户自定义参数示例。
  printf("onTranscriptionStarted: %d\n", tmpParam->userId);
  // 当前任务的task id，方便定位问题。
  printf("onTranscriptionStarted: status code=%d, task id=%s\n",
      cbEvent->getStatusCode(), cbEvent->getTaskId());

  // 获取服务端返回的全部信息
  //printf("onTranscriptionStarted: all response=%s\n", cbEvent->getAllResponse());

  // 通知发送线程start()成功, 可以继续发送数据
  pthread_mutex_lock(&(tmpParam->mtxWord));
  pthread_cond_signal(&(tmpParam->cvWord));
  pthread_mutex_unlock(&(tmpParam->mtxWord));
} 

/**
 * @brief 服务端检测到了一句话的开始, sdk内部线程上报SentenceBegin事件
 * @param cbEvent 回调事件结构, 详见nlsEvent.h
 * @param cbParam 回调自定义参数，默认为NULL, 可以根据需求自定义参数
 * @return
*/
void onSentenceBegin(NlsEvent* cbEvent, void* cbParam) {
  ParamCallBack* tmpParam = (ParamCallBack*)cbParam;
  // 演示如何打印/使用用户自定义参数示例。
  printf("onSentenceBegin: %d\n", tmpParam->userId);
  printf("onSentenceBegin: status code=%d, task id=%s, index=%d, time=%d\n",
      cbEvent->getStatusCode(), cbEvent->getTaskId(),
      cbEvent->getSentenceIndex(), //句子编号，从1开始递增。
      cbEvent->getSentenceTime() //当前已处理的音频时长，单位：毫秒。
  );

  // 获取服务端返回的全部信息
  //printf("onTranscriptionStarted: all response=%s\n", cbEvent->getAllResponse());
}

/**
 * @brief 服务端检测到了一句话结束, sdk内部线程上报SentenceEnd事件
 * @param cbEvent 回调事件结构, 详见nlsEvent.h
 * @param cbParam 回调自定义参数，默认为NULL, 可以根据需求自定义参数
 * @return
*/
void onSentenceEnd(NlsEvent* cbEvent, void* cbParam) {
  ParamCallBack* tmpParam = (ParamCallBack*)cbParam;
  // 演示如何打印
  //使用用户自定义参数示例。
  printf("onSentenceEnd: %d\n", tmpParam->userId);
  printf("onSentenceEnd: status code=%d, task id=%s, index=%d, time=%d, begin_time=%d, result=%s\n",
      cbEvent->getStatusCode(),
      cbEvent->getTaskId(),
      cbEvent->getSentenceIndex(), //句子编号，从1开始递增。
      cbEvent->getSentenceTime(), //当前已处理的音频时长，单位：毫秒。
      cbEvent->getSentenceBeginTime(), // 对应的SentenceBegin事件的时间。
      cbEvent->getResult()    // 当前句子的完整识别结果。
  );
  // 获取服务端返回的全部信息
  //printf("onTranscriptionStarted: all response=%s\n", cbEvent->getAllResponse());
}

/**
 * @brief 识别结果发生了变化, sdk在接收到云端返回到最新结果时,
 *        sdk内部线程上报ResultChanged事件
 * @param cbEvent 回调事件结构, 详见nlsEvent.h
 * @param cbParam 回调自定义参数，默认为NULL, 可以根据需求自定义参数
 * @return
*/
void onTranscriptionResultChanged(NlsEvent* cbEvent, void* cbParam) {
  ParamCallBack* tmpParam = (ParamCallBack*)cbParam;
  // 演示如何打印/使用用户自定义参数示例。
  printf("onTranscriptionResultChanged: %d\n", tmpParam->userId);
  printf("onTranscriptionResultChanged: status code=%d, task id=%s, index=%d, time=%d, result=%s\n",
      cbEvent->getStatusCode(),
      cbEvent->getTaskId(),
      cbEvent->getSentenceIndex(), //句子编号，从1开始递增。
      cbEvent->getSentenceTime(), //当前已处理的音频时长，单位：毫秒。
      cbEvent->getResult()    // 当前句子的完整识别结果
  );
  // 获取服务端返回的全部信息
  //printf("onTranscriptionStarted: all response=%s\n", cbEvent->getAllResponse());
}

/**
 * @brief 服务端停止实时音频流识别时, sdk内部线程上报Completed事件
 * @note 上报Completed事件之后，SDK内部会关闭识别连接通道. 
         此时调用sendAudio会返回负值, 请停止发送.
 * @param cbEvent 回调事件结构, 详见nlsEvent.h
 * @param cbParam 回调自定义参数，默认为NULL, 可以根据需求自定义参数
 * @return
*/
void onTranscriptionCompleted(NlsEvent* cbEvent, void* cbParam) {
  ParamCallBack* tmpParam = (ParamCallBack*)cbParam;
  // 演示如何打印/使用用户自定义参数示例。
  printf("onTranscriptionCompleted: %d\n", tmpParam->userId);
  printf("onTranscriptionCompleted: status code=%d, task id=%s\n",
      cbEvent->getStatusCode(),
      cbEvent->getTaskId());
}

/**
 * @brief 识别过程(包含start(), sendAudio(), stop())发生异常时, sdk内部线程上报TaskFailed事件
 * @note 上报TaskFailed事件之后, SDK内部会关闭识别连接通道. 此时调用sendAudio会返回负值, 请停止发送
 * @param cbEvent 回调事件结构, 详见nlsEvent.h
 * @param cbParam 回调自定义参数，默认为NULL, 可以根据需求自定义参数
 * @return
 */
void onTaskFailed(NlsEvent* cbEvent, void* cbParam) { 
  ParamCallBack* tmpParam = (ParamCallBack*)cbParam; 
  // 演示如何打印/使用用户自定义参数示例。
  printf("onTaskFailed: %d\n", tmpParam->userId); 
  printf("onTaskFailed: status code=%d, task id=%s, error message=%s\n", 
      cbEvent->getStatusCode(), 
      cbEvent->getTaskId(), 
      cbEvent->getErrorMessage()
  );     
  // 获取服务端返回的全部信息
  //printf("onTaskFailed: all response=%s\n", cbEvent->getAllResponse()); 
}

/**
 * @brief 识别结束或发生异常时，会关闭连接通道, sdk内部线程上报ChannelCloseed事件
 * @param cbEvent 回调事件结构, 详见nlsEvent.h
 * @param cbParam 回调自定义参数，默认为NULL, 可以根据需求自定义参数
 * @return
 */
void onChannelClosed(NlsEvent* cbEvent, void* cbParam) {     
  ParamCallBack* tmpParam = (ParamCallBack*)cbParam;     
  // 演示如何打印/使用用户自定义参数。
  printf("onChannelClosed: %d, %s\n", tmpParam->userId, tmpParam->userInfo); // 获取服务端返回的全部信息。
  printf("onChannelClosed: response=%s\n", cbEvent->getAllResponse());

  //通知发送线程, 最终识别结果已经返回, 可以调用stop()
  pthread_mutex_lock(&(tmpParam->mtxWord));
  pthread_cond_signal(&(tmpParam->cvWord));
  pthread_mutex_unlock(&(tmpParam->mtxWord));
}

/**
 * @brief 短链接模式下工作线程
 *        以 createTranscriberRequest           <----|
 *                   |                               |
 *           request->start()                        |
 *                   |                               |
 *           request->sendAudio()                    |
 *                   |                               |
 *           request->stop()                         |
 *                   |                               |
 *           收到onChannelClosed回调                 |
 *                   |                               |
 *           releaseTranscriberRequest(request)  ----|
 *        进行循环。
 */
void* pthreadFunction(void* arg) {
  int sleepMs = 0;
  int ret = 0;
  ParamCallBack *cbParam = NULL;

  //初始化自定义回调参数，以下两变量仅作为示例表示参数传递，在示例中不起任何作用。
  //回调参数在堆中分配之后，请在退出线程前释放。
  cbParam = new ParamCallBack();
  cbParam->userId = rand() % 100;
  strcpy(cbParam->userInfo, "User.");
  // 0：从自定义线程参数中获取token，配置文件等参数。
  ParamStruct *tst = (ParamStruct *) arg; 
  if (tst == NULL) {
    printf("arg is not valid\n"); 
    delete cbParam;
    return NULL;
  } 
  // 打开音频文件，获取数据。
  std::ifstream fs;
  fs.open(tst->fileName.c_str(), std::ios::binary | std::ios::in);
  if (!fs) {
    printf("%s isn't exist..\n", tst->fileName.c_str());
    return NULL;
  }
  /*
   * 1. 创建实时音频流识别SpeechTranscriberRequest对象
   */
  SpeechTranscriberRequest* request =
      NlsClient::getInstance()->createTranscriberRequest();
  if (request == NULL) {
    printf("createTranscriberRequest failed\n");
    delete cbParam;
    return NULL;
  }

  // 设置识别启动回调函数
  request->setOnTranscriptionStarted(onTranscriptionStarted, cbParam);
  // 设置识别结果变化回调函数
  request->setOnTranscriptionResultChanged(onTranscriptionResultChanged, cbParam);
  // 设置语音转写结束回调函数
  request->setOnTranscriptionCompleted(onTranscriptionCompleted, cbParam);
  // 设置一句话开始回调函数
  request->setOnSentenceBegin(onSentenceBegin, cbParam);
  // 设置一句话结束回调函数
  request->setOnSentenceEnd(onSentenceEnd, cbParam);
  // 设置异常识别回调函数
  request->setOnTaskFailed(onTaskFailed, cbParam);
  // 设置识别通道关闭回调函数
  request->setOnChannelClosed(onChannelClosed, cbParam);

  // 设置appKey。必填参数。
  request->setAppKey(tst->appkey.c_str());
  // 设置账号校验token, 必填参数
  request->setToken(tst->token.c_str());

  // 设置音频数据编码格式。可选参数，目前支持PCM/OPUS，默认为PCM。
  request->setFormat("opus");
  // 设置音频数据采样率。可选参数，目前支持16000/8000。默认为16000。
  request->setSampleRate(SAMPLE_RATE);
  // 设置是否返回中间识别结果。可选参数，默认false。
  request->setIntermediateResult(true);
  // 设置是否在后处理中添加标点。可选参数，默认false。
  request->setPunctuationPrediction(true);
  // 设置是否在后处理中执行ITN。可选参数，默认false。
  request->setInverseTextNormalization(true);

  // 语音断句检测阈值，一句话之后静音长度超过该值，即本句结束，合法参数范围200ms～2000ms，默认值800ms。
  //request->setMaxSentenceSilence(800);
  // 语义断句，启动此功能语音断句检测功能不会生效。此功能必须开启中间识别结果。
  //request->setSemanticSentenceDetection(true);
  // 定制语言模型id，可选。
  //request->setCustomizationId("TestId_123");
  // 定制泛热词id，可选。
  //request->setVocabularyId("TestId_456");
  // 用于传递某些定制化、高级参数设置，参数格式为JSON格式：{"key": "value"}。
  //request->setPayloadParam("{\"vad_model\": \"farfield\"}");

  struct timespec outtime;
  struct timeval now;
  /*
   * 2. start()为同步/异步两种操作，默认异步。由于异步模式通过回调判断request是否成功运行有修改门槛，且部分旧版本为同步接口。
   *    为了能较为平滑的更新升级SDK，提供了同步/异步两种调用方式。
   *    异步情况：默认未调用setSyncCallTimeout()的时候，start()调用立即返回，
   *            且返回值并不代表request成功开始工作，需要等待返回started事件表示成功启动，或返回TaskFailed事件表示失败。
   *    同步情况：调用setSyncCallTimeout()设置同步接口的超时时间，并启动同步模式。start()调用后不会立即返回，
   *            直到内部得到成功(同时也会触发started事件回调)或失败(同时也会触发TaskFailed事件回调)后返回。
   *            此方法方便旧版本SDK
   */
  ret = request->start();
  if (ret < 0) {
    printf("start() failed. may be can not connect server. please check network or firewalld\n");
    NlsClient::getInstance()->releaseTranscriberRequest(request); // start()失败，释放request对象。
    delete cbParam;
    return NULL;
  } else {
    if (g_sync_timeout == 0) {
      /*
       * 2.1. g_sync_timeout等于0，即默认未调用setSyncCallTimeout()，异步方式调用start()
       *      需要等待返回started事件表示成功启动，或返回TaskFailed事件表示失败。
       * 
       * 等待started事件返回表示start()成功, 然后再发送音频数据。
       * 语音服务器存在来不及处理当前请求的情况, 10s内不返回任何回调的问题,
       * 然后在10s后返回一个TaskFailed回调, 所以需要设置一个超时机制。
       */
      // 等待started事件返回, 再发送
      printf("wait started callback.\n");
    
      // 语音服务器存在来不及处理当前请求, 10s内不返回任何回调的问题,
      // 然后在10s后返回一个TaskFailed回调, 所以需要设置一个超时机制.
      gettimeofday(&now, NULL);
      outtime.tv_sec = now.tv_sec + 5;
      outtime.tv_nsec = now.tv_usec * 1000;
      pthread_mutex_lock(&(cbParam->mtxWord));
      if (ETIMEDOUT == pthread_cond_timedwait(&(cbParam->cvWord), &(cbParam->mtxWord), &outtime)) {
        printf("start timeout.\n");
        pthread_mutex_unlock(&(cbParam->mtxWord));
        request->cancel();
        NlsClient::getInstance()->releaseTranscriberRequest(request);
        delete cbParam;
        return NULL;
      }
      pthread_mutex_unlock(&(cbParam->mtxWord));
    } else {
      /*
       * 2.2. g_sync_timeout大于0，即调用了setSyncCallTimeout()，同步方式调用start()
       *      返回值0即表示启动成功。
       */
    }
  }

  while (!fs.eof()) {
    uint8_t data[FRAME_SIZE] = {0};
    fs.read((char *) data, sizeof(uint8_t) * FRAME_SIZE); 
    size_t nlen = fs.gcount();
    if (nlen <= 0) {
      continue;
    }

    /*
     * 3. 发送音频数据: sendAudio为异步操作, 返回负值表示发送失败, 需要停止发送;
     *      返回大于0 为成功. 
     *      若希望用省流量的opus格式上传音频数据, 则第三参数传入ENCODER_OPU/ENCODER_OPUS
     *
     * ENCODER_OPU/ENCODER_OPUS模式时, 会占用一定的CPU进行音频压缩
     */
    ret = request->sendAudio(data, nlen, ENCODER_OPUS); 
    if (ret < 0) {
      // 发送失败，退出循环数据发送。
      printf("send data fail.\n"); 
      break;
    } 

    /*
     * 实际使用中, 语音数据是实时的, 不用sleep控制速率, 直接发送即可.
     * 此处是用语音数据来自文件的方式进行模拟, 故发送时需要控制速率来模拟真实录音场景.
     */
    sleepMs = getSendAudioSleepTime(nlen, SAMPLE_RATE, 1); // 根据发送数据大小、采样率、数据压缩比来获取sleep时间。
    /*
     * 语音数据发送延时控制, 实际使用中无需sleep.
     */
    usleep(sleepMs * 1000);
  } // while

  printf("sendAudio done.\n");
  //5: 关闭音频文件
  fs.close();
  
  /*
   * 4. 通知云端数据发送结束.
   *    stop()为同步/异步两种操作，默认异步。由于异步模式通过回调判断request是否成功运行有修改门槛，且部分旧版本为同步接口。
   *    为了能较为平滑的更新升级SDK，提供了同步/异步两种调用方式。
   *    异步情况：默认未调用setSyncCallTimeout()的时候，stop()调用立即返回，
   *            且返回值并不代表request成功结束，需要等待返回closed事件表示结束。
   *    同步情况：调用setSyncCallTimeout()设置同步接口的超时时间，并启动同步模式。stop()调用后不会立即返回，
   *            直到内部完成工作，并触发closed事件回调后返回。
   *            此方法方便旧版本SDK。
   */
  ret = request->stop();
  if (ret == 0) {
      if (g_sync_timeout == 0) {
        /*
         * 4.1. g_sync_timeout等于0，即默认未调用setSyncCallTimeout()，异步方式调用stop()
         *      需要等待返回closed事件表示成功停止，或返回TaskFailed事件表示失败。
         * 
         * 等待closed事件返回表示stop()成功, 然后才可释放。
         * 语音服务器存在来不及处理当前请求的情况, 10s内不返回任何回调的问题,
         * 然后在10s后返回一个TaskFailed回调, 所以需要设置一个超时机制。
         */
        // 等待closed事件后再进行释放, 否则会出现崩溃
        // 若调用了setSyncCallTimeout()启动了同步调用模式, 则可以不等待closed事件。
        printf("wait closed callback.\n");
        
        // 语音服务器存在来不及处理当前请求, 10s内不返回任何回调的问题,
        // 然后在10s后返回一个TaskFailed回调, 错误信息为:
        // "Gateway:IDLE_TIMEOUT:Websocket session is idle for too long time, the last directive is 'StopRecognition'!"
        // 所以需要设置一个超时机制.
        gettimeofday(&now, NULL);
        outtime.tv_sec = now.tv_sec + 5;
        outtime.tv_nsec = now.tv_usec * 1000;
        // 等待closed事件后再进行释放
        pthread_mutex_lock(&(cbParam->mtxWord));
        if (ETIMEDOUT == pthread_cond_timedwait(&(cbParam->cvWord), &(cbParam->mtxWord), &outtime)) {
          printf("stop timeout\n");
          pthread_mutex_unlock(&(cbParam->mtxWord));
          NlsClient::getInstance()->releaseTranscriberRequest(request);
          delete cbParam;
          return NULL;
        }
        pthread_mutex_unlock(&(cbParam->mtxWord));
      } else {
        /*
         * 4.2. g_sync_timeout大于0，即调用了setSyncCallTimeout()，同步方式调用stop()
         *      返回值0即表示启动成功。
         */
      }
  } else {
    printf("stop ret is %d\n", ret);
  }

  /*
   * 5. 完成所有工作后释放当前请求。
   *    请在closed事件(确定完成所有工作)后再释放, 否则容易破坏内部状态机, 会强制卸载正在运行的请求。
   */
  NlsClient::getInstance()->releaseTranscriberRequest(request);
  delete cbParam;
  return NULL;
}

// 识别单个音频数据
int speechTranscriberFile(const char* appkey) {
  //获取当前系统时间戳，判断token是否过期。
  std::time_t curTime = std::time(0);
  if (g_expireTime - curTime < 10) {
    printf("the token will be expired, please generate new token by AccessKey-ID and AccessKey-Secret.\n");
    if (generateToken(g_akId, g_akSecret, &g_token, &g_expireTime) < 0) {
      return -1;
    } 
  }

  ParamStruct pa;
  pa.token = g_token;
  pa.appkey = appkey;
  pa.fileName = "test0.wav";

  // 启动一个工作线程，用于单次识别。
  pthread_t pthreadId;
  pthread_create(&pthreadId, NULL, &pthreadFunction, (void *)&pa);
  pthread_join(pthreadId, NULL);
  return 0;
}

//识别多个音频数据
//SDK多线程指一个音频数据源对应一个线程，非一个音频数据对应多个线程。
//示例代码为同时开启2个线程识别2个文件。
//免费用户并发连接不能超过2个。
#define AUDIO_FILE_NUMS 2
#define AUDIO_FILE_NAME_LENGTH 32
int speechTranscriberMultFile(const char* appkey) {
  //获取当前系统时间戳判断token是否过期。
  std::time_t curTime = std::time(0);
  if (g_expireTime - curTime < 10) {
    printf("the token will be expired, please generate new token by AccessKey-ID and AccessKey-Secret.\n");
    if (generateToken(g_akId, g_akSecret, &g_token, &g_expireTime) < 0) {
      return -1;
    }
  }

  char audioFileNames[AUDIO_FILE_NUMS][AUDIO_FILE_NAME_LENGTH] = {
      "test0.wav", 
      "test1.wav"
  };
  ParamStruct pa[AUDIO_FILE_NUMS];
  for (int i = 0; i < AUDIO_FILE_NUMS; i ++) {
    pa[i].token = g_token; 
    pa[i].appkey = appkey;
    pa[i].fileName = audioFileNames[i]; 
  } 

  // 启动2个工作线程，同时识别2个音频文件。
  std::vector<pthread_t> pthreadId(AUDIO_FILE_NUMS);
  for (int j = 0; j < AUDIO_FILE_NUMS; j++) {
    pthread_create(&pthreadId[j], NULL, &pthreadFunction, (void *)&(pa[j]));
  }
  for (int j = 0; j < AUDIO_FILE_NUMS; j++) {
    pthread_join(pthreadId[j], NULL);
  }
  return 0;
}

int main(int argc, char* argv[]) {
  printf("Usage: ./demo <your appkey> <your AccessKey ID> <your AccessKey Secret>\n");

  std::string appkey = getenv("NLS_APPKEY_ENV");
  g_akId = getenv("NLS_AK_ENV");
  g_akSecret = getenv("NLS_SK_ENV");

  // 根据需要设置SDK输出日志。可选。
  // 此处表示SDK日志输出至log-transcriber.txt。
  // LogDebug表示输出所有级别日志，支持LogDebug、LogInfo、LogWarning、LogError。
  // 400表示单个文件400MB。50表示50个日志文件循环记录。
  int ret = NlsClient::getInstance()->setLogConfig(
      "log-transcriber", LogDebug, 400, 50);
  if (ret < 0) {
    printf("set log failed.\n");
    return -1;
  }

  // 设置运行环境需要的套接口地址类型, 默认为AF_INET
  // 必须在startWorkThread()前调用
  //NlsClient::getInstance()->setAddrInFamily("AF_INET");
    
  // 私有云部署的情况下可进行直连IP的设置
  // 必须在startWorkThread()前调用
  //NlsClient::getInstance()->setDirectHost("106.15.83.44");

  // 存在部分设备在设置了dns后仍然无法通过SDK的dns获取可用的IP,
  // 可调用此接口主动启用系统的getaddrinfo来解决这个问题.
  //NlsClient::getInstance()->setUseSysGetAddrInfo(true);

  // g_sync_timeout等于0，即默认未调用setSyncCallTimeout()
  // 异步方式调用
  //   start(): 需要等待返回started事件表示成功启动，或返回TaskFailed事件表示失败。
  //   stop(): 需要等待返回closed事件则表示完成此次交互。
  // 同步方式调用
  //   start()/stop() 调用返回即表示交互启动/结束。
  if (g_sync_timeout > 0) {
    NlsClient::getInstance()->setSyncCallTimeout(g_sync_timeout);
  }

  // 启动工作线程, 在创建请求和启动前必须调用此函数, 可理解为对NlsClient的初始化
  // 入参为负时, 启动当前系统中可用的核数。
  // 200并发以下推荐入参为1, 更高并发入参推荐可看readme。
  NlsClient::getInstance()->startWorkThread(1);

  // 识别单个音频数据
  speechTranscriberFile(appkey.c_str());
  // 并发识别多个音频数据
  //speechTranscriberMultFile(appkey.c_str());

  // 所有工作完成，进程退出前，释放nlsClient。
  // 请注意releaseInstance()非线程安全, 需要确认所有请求都停止工作才可释放。
  NlsClient::releaseInstance();

  return 0;
}

常见问题