iOS SDK

提示:

• 在使用SDK之前，请先确保已阅读了 接口说明文档。

实时语音识别

实时语音识别相对于一句话识别，支持一个持续不断的长连接进行识别，典型的应用场景是会议转写、记者访谈等。比如您可以用实时语音识别来转写一场会议的发言。服务会自动的对上传的语音进行断句，并返回每句话的开始、结束和识别结果。

SDK下载调用

• 下载 iOS SDK 2.0，解压后打开压缩包，NlsDemo目录即为Demo工程目录；
• 双击NlsDemo.xcodeproj可以使用Xcode 9.3打开Demo工程，如您的Xcode版本高于/低于该版本，可能需要您调整版本或手动导入Demo文件；
• Demo 已导入的iOS SDK 即NlsDemo/AliyunNlsSdk.framework，SDK支持 x86_64/armv7/arm64三种架构，支持模拟器架构；
• 提交苹果应用商店，不允许提交x86_64架构，所以我们提供了只包含真机的framework，您可以集成这个版本：NlsDemo-iOS/ReleaseFramework-iphoneOS/AliyunNlsSdk.framework；
• AliyunNlsSdk是动态库，所以您在项目导入时应该选择在Embedded Binaries 添加Framework。

SDK调用顺序

请使用Embedded Binaries方式导入SDK到您的工程中。

1. 引入NlsSdk中的AliyunNlsClientAdaptor.h、NlsSpeechTranscriberRequest.h以及TranscriberRequestParam.h头文件。
2. 实现NlsSpeechTranscriberRequest的NlsSpeechTranscriberDelegate回调方法。
3. 创建一个AliyunNlsClientAdaptor的对象nlsClient，该对象只需创建一次并且可以重复使用。
4. 通过调用nlsClient对象的createTranscriberRequest方法获得一个NlsSpeechTranscriberRequest 对象。该NlsSpeechTranscriberRequest对象不能重复使用，但是可以创建多个，每个请求创建一个对象。
5. 通过TranscriberRequestParam设置识别过程中的参数，如accessToken、appkey等(详细参数说明见下文)。
6. 通过NlsSpeechTranscriberRequest的setTranscriberParams 传入【步骤 5】中设置的TranscriberRequestParam对象。
7. 调用NlsSpeechTranscriberRequest对象的start方法和stop方法开始结束识别。
8. 通过NlsSpeechTranscriberRequest对象的sendAudio:(NSData *)audioData length:(int)len 接口传入识别数据。
9. 如有识别结果，则会触发【步骤 3】中设置的相关回调函数，返回的形式是文本方式。

关键接口

• AliyunNlsClientAdaptor：语言处理client，相当于所有语音相关处理类的factory，全局创建一个实例即可。线程安全。
• NlsSpeechTranscriberRequest：语音识别处理的请求对象，用来完成语音识别等功能，线程安全。
• TranscriberRequestParam：语音识别相关参数。
• NlsSpeechTranscriberDelegate：定义了多个语音识别相关回调函数，在获得结果，遇到错误等事件发生时会触发回调。

代码调用示例

#import <Foundation/Foundation.h>
#import "Transcriber.h"
@interface Transcriber()<NlsSpeechTranscriberDelegate,NlsVoiceRecorderDelegate>{
    IBOutlet UITextView *textViewTranscriber;
    IBOutlet UISwitch *switchTranscriber;
    Boolean transcriberStarted;
}
@end
@implementation Transcriber
-(void)viewDidLoad {
    [super viewDidLoad];
    //1. 全局参数初始化操作
    //1.1 初始化识别客户端,将transcriberStarted状态置为false
    _nlsClient = [[NlsClientAdaptor alloc]init];
    transcriberStarted = false;
    //1.2 初始化录音recorder工具
    _voiceRecorder = [[NlsVoiceRecorder alloc]init];
    _voiceRecorder.delegate = self;
    //1.3 初始化识别参数类
    _transRequestParam = [[TranscriberRequestParam alloc]init];
    //1.4 设置log级别
    [_nlsClient setLog:NULL logLevel:1];
}
- (IBAction)startTranscriber {
    //2. 创建请求对象和开始识别
    if(_transcriberRequest!= NULL){
        [_transcriberRequest releaseRequest];
        _transcriberRequest = NULL;
    }
    //2.1 创建请求对象，设置NlsSpeechTranscriberDelegate回调
    _transcriberRequest = [_nlsClient createTranscriberRequest];
    _transcriberRequest.delegate = self;
    //2.2 设置TranscriberRequestParam请求参数
    [_transRequestParam setFormat:@"opu"];
    [_transRequestParam setEnableIntermediateResult:true];
    //请使用https://help.aliyun.com/document_detail/72153.html 动态生成token
    // <AccessKeyId> <AccessKeySecret> 请使用您的阿里云账户生成 https://ak-console.aliyun.com/
    [_transRequestParam setToken:@""];
    //请使用阿里云语音服务管控台(https://nls-portal.console.aliyun.com/)生成您的appkey
    [_transRequestParam setAppkey:@""];
    //2.3 传入请求参数
    [_transcriberRequest setTranscriberParams:_transRequestParam];
    //2.4 启动录音和识别，将transcriberStarted置为true
    [_voiceRecorder start];
    [_transcriberRequest start];
    transcriberStarted = true;
    //2.5 更新UI
    dispatch_async(dispatch_get_main_queue(), ^{
        // UI更新代码
        [self->switchTranscriber setOn:true];
        self->textViewTranscriber.text = @"start Recognize！";
    });
}
- (IBAction)stopTranscriber {
    //3 结束识别 停止录音，停止识别请求
    [_voiceRecorder stop:true];
    [_transcriberRequest stop];
    transcriberStarted= false;
    _transcriberRequest = NULL;
    dispatch_async(dispatch_get_main_queue(), ^{
        // UI更新代码
        [self->switchTranscriber setOn:false];
    });
}
/**
 *4. NlsSpeechTranscriberDelegate接口回调方法
 */
//4.1 识别回调，本次请求失败
- (void)OnTaskFailed:(NlsDelegateEvent)event statusCode:(NSString *)statusCode errorMessage:(NSString *)eMsg {
    NSLog(@"OnTaskFailed, statusCode is: %@ error message ：%@",statusCode,eMsg);
}
//4.2 识别回调，服务端连接关闭
- (void)OnChannelClosed:(NlsDelegateEvent)event statusCode:(NSString *)statusCode errorMessage:(NSString *)eMsg {
    NSLog(@"OnChannelClosed, statusCode is: %@",statusCode);
}
//4.3 实时语音识别开始
- (void)OnTranscriptionStarted:(NlsDelegateEvent)event statusCode:(NSString *)statusCode errorMessage:(NSString *)eMsg {
}
//4.4 识别回调，一句话的开始
- (void)OnSentenceBegin:(NlsDelegateEvent)event result:(NSString*)result statusCode:(NSString *)statusCode errorMessage:(NSString *)eMsg {
    dispatch_async(dispatch_get_main_queue(), ^{
        // UI更新代码
        self->textViewTranscriber.text = result;
        NSLog(@"%@", result);
    });
}
//4.5 识别回调，一句话的结束
- (void)OnSentenceEnd:(NlsDelegateEvent)event result:(NSString*)result statusCode:(NSString *)statusCode errorMessage:(NSString *)eMsg {
    dispatch_async(dispatch_get_main_queue(), ^{
        // UI更新代码
        self->textViewTranscriber.text = result;
        NSLog(@"%@", result);
    });
}
//4.5 识别回调，一句话识别的中间结果
- (void)OnTranscriptionResultChanged:(NlsDelegateEvent)event result:(NSString *)result statusCode:(NSString *)statusCode errorMessage:(NSString *)eMsg {
    dispatch_async(dispatch_get_main_queue(), ^{
        // UI更新代码
        self->textViewTranscriber.text = result;
        NSLog(@"%@", result);
    });
}
//4.6 识别回调，转写完全结束
- (void)OnTranscriptionCompleted:(NlsDelegateEvent)event statusCode:(NSString *)statusCode errorMessage:(NSString *)eMsg {
}
/**
 *5. 录音相关回调
 */
- (void)recorderDidStart {
    NSLog(@"Did start recorder!");
}
- (void)recorderDidStop {
    NSLog(@"Did stop recorder!");
}
- (void)voiceDidFail:(NSError *)error {
    NSLog(@"Did recorder error!");
}
//5.1 录音数据回调
- (void)voiceRecorded:(NSData *)frame {
    if (_transcriberRequest != nil && transcriberStarted) {
        //录音线程回调的数据传给识别服务
        if ([_transcriberRequest sendAudio:frame length:(short)frame.length] == -1) {
            NSLog(@"connect closed ,stop transcriberRequest!");
            [self stopTranscriber];
        }
    }
}
@end