677      技术社区[云栖]

iOS SDK__一句话识别_语音识别(ASR)_智能语音交互-阿里云

功能介绍

语音iOS SDK提供一句话识别服务，提供将实时短语音转成文字的功能，可直接用于语音搜索类应用。

SDK下载地址

一句话识别iOSSDK

重要接口说明

发送语音请求的对象及方法NlsRequest.h

语音请求初始化方法

- (instancetype)init;

• 说明 语音识别、语音合成的语音请求初始化方法
• 返回值 self

设置语音请求的appkey

- (void)setAppkey:(NSString *)appKey;

• 说明 设置语音请求的appkey。
• 参数
  • appKey 用户申请的appKey
• 返回值 无

设置发送的请求是否需要带语音数据

- (void)setBstreamAttached:(BOOL)bstreamAttached;

• 说明 设置发送的请求是否需要带语音数据。若发送的是语音识别请求，则bstreamAttached为YES；若发送的是语音合成请求，则bstreamAttached为NO。
• 参数
  • bstreamAttached 请求是否需要带语音数据。
• 返回值 无

设置语音识别ASR请求

- (void)setAsrRequest:(NSString *)userId;

• 说明 设置语音识别ASR请求
• 参数
  • userId 用户id
• 返回值 无

数加验证

- (void)Authorize:(NSString )authId withSecret:(NSString )secret;

• 说明 数加验证，未经过数加验证的语音请求均为非法请求。
• 参数
  • authId 数加验证的ak_id
  • secret 数加验证的ak_secret
• 返回值 无

将语音请求NlsRequest对象转换成JSON字符串

+ (NSString )getJSONStringfromNlsRequest:(NlsRequest )nlsRequest;

• 说明 将语音请求NlsRequest对象转换成JSON字符串形式。
• 参数
  • nlsRequest NlsRequest对象
• 返回值 NlsRequest的JSON字符串

将对象转换成JSONString方法

+ (NSString *)getJSONString:(id)obj options:(NSJSONWritingOptions)options error:(NSError)error;**

• 说明 将object转换成JSONString。
• 参数
  • obj 被转化对象
  • options NSJSONWritingOptions
  • error NSError
• 返回值 NlsRequest的JSON字符串

将对象转换成NSDictionary方法

+ (NSDictionary *)getObjectData:(id)obj;

• 说明 将object转换成NSDictionary。
• 参数
  • obj 被转化对象
• 返回值 NSDictionary

语音服务SDK的核心类NlsRecognizer.h

语音服务SDK的核心类，封装了录音设备的初始化，压缩处理，语音检测（VAD）等复杂逻辑，自动的将语音数据同步传送到语音服务器上。开发者只需要传递正确的delegate，就能完成语音识别和语音合成。

语音识别的关键回调函数

-(void)recognizer:(NlsRecognizer )recognizer didCompleteRecognizingWithResult:(NlsRecognizerResult)result error:(NSError*)error;

• 说明 语音识别的关键回调函数，delegate必须实现。若appkey为流式返回appkey，将会多次回调该方法。
• 参数
  • recognizer NlsRecognizer
  • result 返回值对象 NlsRecognizerResult
  • error 语音识别错误和异常 NSError
• 返回值 无

返回录音的语音音量

-(void)recognizer:(NlsRecognizer *)recognizer recordingWithVoiceVolume:(NSUInteger)voiceVolume;

• 说明 返回录音的语音音量，调用频率取决于SDK内部设定。
• 参数
  • recognizer NlsRecognizer
  • voiceVolume 0-100的数值
• 返回值 无

返回录音的数据

-(void)recognizer:(NlsRecognizer )recognizer recordingWithVoiceData:(NSData)voiceData;

• 说明 返回录音的数据，调用频率取决于SDK内部设定。
• 参数
  • recognizer NlsRecognizer
  • frame 返回的语音
• 返回值 无

开始录音的回调通知

-(void)recognizerDidStartRecording:(NlsRecognizer *)recognizer;

• 说明 开始录音的回调通知
• 参数
  • recognizer NlsRecognizer
• 返回值 无

停止录音的回调通知

-(void)recognizerDidStopRecording:(NlsRecognizer *)recognizer;

• 说明 停止录音的回调通知
• 参数
  • recognizer NlsRecognizer
• 返回值 无

录音模式下停止的回调通知

-(void)recognizerDidStopRecording:(NlsRecognizer )recognizer withRecorderData:(NSData)data;

• 说明 录音模式下停止的回调通知，可得到录音数据（保留方法）
• 参数
  • recognizer NlsRecognizer
  • data 录音数据
• 返回值 无

设置SDK工作模式

NlsRecognizer @property(nonatomic,assign,readwrite) kNlsRecognizerMode mode;

• 说明 设置语音SDK的工作模式，若不设置，则为kMODE_RECOGNIZER

设置SDK是否监听App状态

NlsRecognizer @property(nonatomic,assign,readwrite) BOOL cancelOnAppEntersBackground;

• 说明 设置SDK是否监听App状态，缺省为NO。如果设为YES，则SDK会监听App状态，一旦切换到后台，就自动取消请求。

设置cancel时是否回调onRecognizeComplete方法

NlsRecognizer @property(nonatomic,assign,readwrite) BOOL enableUserCancelCallback;

• 说明 NlsRecognizer的cancel方法被调用的时候，会触发delegate的onRecognizeComplete方法，错误码为kERR_USER_CANCELED,错误信息为kNlsRecognizerErrorUserCanceled。如果App不想被回调，请设置为NO即可。参见 cancel方法。

设置是否记录语音

NlsRecognizer @property(nonatomic,assign,readwrite) BOOL enableVoiceLog;

• 说明 打开语音记录功能，SDK将会把语音识别的文件记录到当前App的document下面，调试用。缺省关闭，在DEBUG模式下有效，Release模式下无效。（保留字段）

配置语音服务模块的基础参数

+(void)configure;

• 说明 配置语音服务模块的基础参数，请在App启动的时候调用
• 参数 无
• 返回值 无

初始化NlsRecognizer

-(id)initWithNlsRequest:(NlsRequest )nlsRequest svcURL:(NSString )svcURL;

• 说明 初始化NlsRecognizer，注意: 通过该API使用的appKey必须提前通过configure函数预先配置好
• 参数
  • nlsRequest 语音请求NlsRequest
  • svcURL 语音服务地址
• 返回值 无

设置是否打开VAD开关

-(void)setVad;

• 说明 设置是否打开VAD开关，VAD默认关闭。
• 参数
  • isVad 是否打开静音检测开关
• 返回值 无

检测到用户语音后，自动停止的间隙

-(void)setVadAutoStopTimeInterval:(NSTimeInterval) timeinterval;

• 说明 检测到用户语音后，自动停止的间隙。
• 参数
  • timeinterval 静音触发自动停止的时长，以秒表示.缺省0.7s
• 返回值 无

打开VAD时，设置最短录音时间，缺省时为5s

-(void)setMinRecordTime:(NSTimeInterval) timeinterval;

• 说明 打开VAD时，设置最短录音时间，缺省时为5s
• 参数
  • timeinterval 最短录音时间，缺省时为5s
• 返回值 无

设置最长录音时间，缺省时为60s

-(void)setMaxRecordTime:(NSTimeInterval) timeinterval;

• 说明 设置最长录音时间，缺省时为60s
• 参数
  • timeinterval 最短录音时间，缺省时为60s
• 返回值 无

语音主服务是否可用

+(BOOL)isServiceAvailable;

• 说明 语音主服务是否可用，开发者可以根据测返回值，调整UI行为
• 返回值 返回语音主服务当前是否可用。

开始语音识别

-(void)start;

• 说明 开始语音识别。打开录音设备，同时开始识别。
• 返回值 无

停止语音识别

-(void)stop;

• 说明 停止语音识别。停止录音设备，delegate的didStopRecord会被回调。网络请求在后台继续，如果有识别结果返回，则会通过delegate的didCompleteRecognizingWithResult回调方法单独返回。
• 返回值 无

取消语音识别

-(void)cancel;

• 说明 取消语音识别。取消语音识别，录音会停止，网络请求会取消。根据enableUserCancelCallback的设置，决定是否回调delegate方法。
• 返回值 无

语音识别是否已经开始

-(BOOL)isStarted;

• 说明 语音识别是否已经开始
• 返回值 YES表示语音识别已经开始，NO表示语音识别未开始。

参数和错误码说明

发送ASR语音请求的参数：

    {
      "requests" : {
        "asr_in" : {
          "version" : "3.0",// 协议版本号
          "asrSC" : "opu",// 输入的语音格式，默认opu
          "user_id" : ""// 用户名，可选项
        },
        "context" : {
          "auth" : {} //requested
        }
      },
      "app_key" : "",
      "bstream_attached" : true,// 请求包的后面是不是还接着二进制语音流。语音识别时bstream_attached = YES 。
      "version" : "4.0"// 协议版本号
    }

返回的识别结果result是一个NlsRecognizerResult的对象：

    {
      "status" : "1",// 服务器状态，0为失败，非零为成功
      "id" : "",// 透传系统始终的uuid,服务端配置是否返回
      "finish" : "1",// 0为未结束，非零为结束，识别是否已经结束
      "results" : {
        "asr_out" : {
          "result" : "",// 语音识别结果
          "status" : 1,// 服务器状态，0为失败，非零为成功
          "finish" : 1,// 0为未结束，非零为结束，识别是否已经结束
          "version" : "4.0"
        },
        "out" : {}//保留字段
      },
      "bstream_attached" : false,// 应答包的后面是不是还接着二进制语音流。
      "version" : "4.0"// 协议版本号
    }

若识别发生错误，recognizer:didCompleteRecognizingWithResult:error:的回调函数中error不为nil。相应错误码的对应表如下所示。

• 客户端错误码

• 服务端返回结果错误码

完整示例

创建应用

使用Xcode创建iOS application应用工程。

添加Framework

在Xcode工程中需要引入所需要的framework，NlsClientSDK.framework。

添加方法：选中工程，点击TARGETS，在右侧的Build Phases中选择 Link Binary With Libraries，点击上图中左下角的+号，在弹出界面中依次添加所依赖的framework。

    $lipo -info NlsClientSDK
    Architectures in the fat file: NlsClientSDK are: armv7 i386 x86_64 arm64

引入头文件

在需要调用SDK的文件中，添加如下头文件:

    #import <NlsClientSDK/NlsClientSDK.h>

语音服务注册

AppDelegate中注册语音服务：

    #import "AppDelegate.h"
    #import "ViewController.h"
    #import <NlsClientSDK/NlsClientSDK.h>
    @interface AppDelegate ()
    @end
    @implementation AppDelegate
    - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    -     
    #warning configure语音服务，必须在调用语音服务前执行该方法。
    [NlsRecognizer configure];
        ……
    ｝

实现语音识别功能

ViewController中实现语音识别方法：

    #import "ViewController.h"
    #import <NlsClientSDK/NlsClientSDK.h>
    @interface ViewController ()<NlsRecognizerDelegate>
    @property(nonatomic,strong) NlsRecognizer *recognizer;
    @end
    @implementation ViewController
    - (void)viewWillAppear:(BOOL)animated
    {
        [super viewWillAppear:animated];
        // 检查asr服务是否可用
        if([NlsRecognizer isServiceAvailable]) {
            NSLog(@"当前语音服务可用");
        }
        else {
            NSLog(@"当前语音服务不可用");
        }
        // 监测语音服务状态
        [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(asrStatusChanged:) name:kNlsRecognizerServiceStatusChanged object:nil];
    }
    #pragma mark - Actions
    - (void)onStartAsrButtonClick:(id)sender {
        // 初始化语音请求类
        NlsRequest * nlsRequest = [[NlsRequest alloc] init];
    #warning appkey请从 "快速开始" 帮助页面的appkey列表中获取
        [nlsRequest setAppkey:@""]; // requested
        [nlsRequest setBstreamAttached:YES]; // requested 语音识别，setBstreamAttached = YES
        [nlsRequest setAsrRequest:@"input_userid"]; // requested 设置asr_in参数
    #warning 请修改为您在阿里云申请的数字验证串Access Key ID和Access Key Secret
        [nlsRequest Authorize:@"" withSecret:@""]; // requested
        // 初始化语音服务核心类
        NlsRecognizer *r = [[NlsRecognizer alloc] initWithNlsRequest:nlsRequest svcURL:nil]; // requested 采用默认svcURL
        //vad：自动语音检测，可根据需要设置是否打开，YES为打开，NO为关闭。
    [r setVad:self.setVadFlag];
        r.delegate = self;
        r.cancelOnAppEntersBackground = YES;
        r.enableUserCancelCallback = YES;
        self.recognizer = r;
        NSString *nlsRequestJSONString = [NlsRequest getJSONStringfromNlsRequest:nlsRequest];
        NSLog(@"setupAsrIn : %@",nlsRequestJSONString);
        //开始语音识别
        [self.recognizer start];
    }
    - (void)onStopAsrButtonClick:(id)sender {
        //结束语音识别
        [self.recognizer stop];
    }
    #pragma mark - Notification Callbacks
    -(void)asrStatusChanged:(NSNotification*)notify{
        //处理网络变化
    }
    #pragma mark - RecognizerDelegate
    -(void) recognizer:(NlsRecognizer *)recognizer didCompleteRecognizingWithResult:(NlsRecognizerResult*)result error:(NSError*)error{
        //处理识别结果和错误信息
        //若appkey为流式返回appkey，将会多次回调该方法
    }
    -(void) recognizer:(NlsRecognizer *)recognizer recordingWithVoiceVolume:(NSUInteger)voiceVolume{
        //处理音量变化    
    }
    -(void) recognizerDidStartRecording:(NlsRecognizer *)recognizer{
        //处理开始识别事件
    }
    -(void) recognizerDidStopRecording:(NlsRecognizer *)recognizer{
        //处理结束识别事件
    }
    @end

ld: 'xxx/NlsClientSDK.framework/NlsClientSDK(NlsRecognizer.o)' does not contain bitcode. You must rebuild it with bitcode enabled (Xcode setting ENABLE_BITCODE), obtain an updated library from the vendor, or disable bitcode for this target. for architecture arm64
clang: error: linker command failed with exit code 1 (use -v to see invocation)

{
    NSLocalizedDescription = "server closed connection, code:4403, reason:Unauthorized AppKey [xxx], wasClean:1";
}

#warning 请修改为您在阿里云申请的数字验证串Authorize withSecret
    [nlsRequest Authorize:@"Access Key ID" withSecret:@"Access Key Secret"]; // requested Access Key ID和Access Key Secret

#warning appkey请从 "快速开始" 帮助页面的appkey列表中获取。
    [nlsRequest setAppkey:@"your_appkey"]; // requested

//Config appkey.
 [NlsRecognizer configure];

NlsRecognizer *r = [[NlsRecognizer alloc] initWithNlsRequest:nlsRequest svcURL:nil];

{
    NSLocalizedDescription = "server closed connection, code:4400, reason:illegal params, operation forbidden, wasClean:1";
}

#warning 请修改为您在阿里云申请的APP_KEY
    [nlsRequest setAppkey:@"your_appkey"]; // requested