# iOS 语音识别(Recognizer)

这里介绍的是iOS API关于语音识别(Recognizer)的相关说明，点击右侧目录可快速找到相应文件。

# 类IFlyDataUploader

# IFlyDataUploader Class Reference

# Overview

数据上传类，主要用于上传语法文件或上传联系人、词表等个性化数据。

# dataName

数据名称

@property (nonatomic, copy) NSString *dataName

Declared In
IFlyDataUploader.h

# data

数据

@property (nonatomic, copy) NSString *data

Declared In
IFlyDataUploader.h

# uploadDataWithCompletionHandler:name:data:

上传数据 此函数用于上传数据，下载的过程是异步的。

- (void)uploadDataWithCompletionHandler:(IFlyUploadDataCompletionHandler)*completionHandler* name:(NSString *)*name* data:(NSString *)*data

# Parameters

Declared In
IFlyDataUploader.h

# setParameter:forKey:

设置上传数据参数

- (void)setParameter:(NSString *)*parameter* forKey:(NSString *)*key

# Parameters

Declared In
IFlyDataUploader.h

# 类IFlyRecognizerView

# IFlyRecognizerView Class Reference

# Overview

语音识别控件
录音时触摸控件结束录音，开始识别（相当于旧版的停止）；触摸其他位置，取消录音，结束会话（取消）
出错时触摸控件，重新开启会话（相当于旧版的再说一次）；触摸其他位置，取消录音，结束会话（取消）

# delegate

设置委托对象

@property (nonatomic, assign) id delegate

Declared In
IFlyRecognizerView.h

# initWithOrigin:

初始化控件

- (id)initWithOrigin:(CGPoint)*origin

Parameters

Return Value
IFlyRecognizerView 对象

Declared In
IFlyRecognizerView.h

# initWithCenter:

初始化控件

- (id)initWithCenter:(CGPoint)*center

Parameters

Declared In
IFlyRecognizerView.h

Return Value

IFlyRecognizerView 对象

Declared In
IFlyRecognizerView.h

# setAutoRotate:

设置横竖屏自适应

- (void)setAutoRotate:(BOOL)*autoRotate

Parameters

Declared In
IFlyRecognizerView.h

# setParameter:forKey:

设置识别引擎的参数

- (BOOL)setParameter:(NSString *)*value* forKey:(NSString *)*key

Parameters

Return Value
成功返回YES；失败返回NO

Discussion
识别的引擎参数(key)取值如下：

Declared In
IFlyRecognizerView.h

# parameterForKey:

获取识别引擎参数

- (NSString *)parameterForKey:(NSString *)*key

Parameters

Return Value
参数值

Declared In
IFlyRecognizerView.h

# start

开始识别

- (BOOL)start

Return Value
成功返回YES；失败返回NO

Declared In
IFlyRecognizerView.h

# cancel

取消本次识别

- (void)cancel

Declared In
IFlyRecognizerView.h

# 类IFlySpeechRecognizer

# IFlySpeechRecognizer Class Reference

# Overview

语音识别类 此类现在设计为单例，你在使用中只需要创建此对象，不能调用release/dealloc函数去释放此对象。所有关于语音识别的操作都在此类中。

音频流识别 音频流识别可以将文件分段写入

# Other Methods

# delegate

设置委托对象

@property (nonatomic, assign) id delegate

Declared In
IFlySpeechRecognizer.h

# sharedInstance

返回识别对象的单例

+ (instancetype)sharedInstance

Return Value
识别对象的单例 Declared In
IFlySpeechRecognizer.h

# destroy

销毁识别对象。

- (BOOL)destroy

Return Value
成功返回YES,失败返回NO

Declared In
IFlySpeechRecognizer.h

# setParameter:forKey:

设置识别引擎的参数

- (BOOL)setParameter:(NSString *)*value* forKey:(NSString *)*key*

Parameters

Return Value

成功返回YES；失败返回NO

Discussion

识别的引擎参数(key)取值如下：

Declared In
IFlySpeechRecognizer.h

# parameterForKey:

获取识别引擎参数

- (NSString *)parameterForKey:(NSString *)*key

# Parameters

Return Value
参数值

Declared In
IFlySpeechRecognizer.h

# startListening

开始识别

- (BOOL)startListening

Return Value
成功返回YES；失败返回NO

Discussion
同时只能进行一路会话，这次会话没有结束不能进行下一路会话，否则会报错。若有需要多次回话，请在onCompleted回调返回后请求下一路回话。

Declared In
IFlySpeechRecognizer.h

# stopListening

停止录音
调用此函数会停止录音，并开始进行语音识别

- (void)stopListening

Declared In
IFlySpeechRecognizer.h

# cancel

取消本次会话

- (void)cancel

Declared In
IFlySpeechRecognizer.h

# buildGrammarCompletionHandler:grammarType:grammarContent:

上传语法

- (int)buildGrammarCompletionHandler:(IFlyOnBuildFinishCompletionHandler)*completionHandler* grammarType:(NSString *)*grammarType* grammarContent:(NSString *)*grammarContent

Parameters

Return Value
错误码

Declared In
IFlySpeechRecognizer.h

# isListening

是否正在识别

@property (nonatomic, readonly) BOOL isListening

Declared In
IFlySpeechRecognizer.h

# IFlyStreamRecognizer Methods

# writeAudio:

写入音频流

- (BOOL)writeAudio:(NSData *)*audioData

# Parameters

Return Value
写入成功返回YES，写入失败返回NO

Discussion
此方法的使用示例如下:

[_iFlySpeechRecognizer setParameter:@"-1" value:@"audio_source"];
[_iFlySpeechRecognizer startListening];
[_iFlySpeechRecognizer writeAudio:audioData1];
[_iFlySpeechRecognizer writeAudio:audioData2];
...
[_iFlySpeechRecognizer stopListening];

Declared In
IFlySpeechRecognizer.h

# 类IFlyUserWords

# IFlyUserWords Class Reference

# Overview

用户词表类 获取用户词表是为了更好的语音识别(iat)，用户词表也属于个性化的一部分.

# initWithJson:

初始化对象

- (id)initWithJson:(NSString *)*json

Parameters

Return Value
IFlyUserWords对象

Discussion
在进行初始化时，需要传入的格式如下：

{\"userword\":[{\"name\":\"iflytek\",\"words\":[\"科大讯飞\", \"云平台\",\"用户词条\",\"开始上传词条\"]}]}

Declared In
IFlyUserWords.h

# toString

将数据转化为上传的数据格式

- (NSString *)toString

Return Value
没有数据或者格式不对时返回nil

Declared In
IFlyUserWords.h

# getWords:

返回key对应的数据

- (NSArray *)getWords:(NSString *)*key

Parameters

Return Value
key对应的数组

Declared In
IFlyUserWords.h

# putWord:value:

添加一条用户词数据

- (BOOL)putWord:(NSString *)*key* value:(NSString *)*value

Parameters

Return Value
成功返回YES,失败返回NO

Declared In
IFlyUserWords.h

# putwords:words:

添加一组数据

- (BOOL)putwords:(NSString *)*key* words:(NSArray *)*words

Parameters

Return Value
成功返回YES,失败返回NO

Declared In
IFlyUserWords.h

# containsKey:

是否包含key对应的用户词数据

- (BOOL)containsKey:(NSString *)*key

Parameters

Return Value
成功返回YES,失败返回NO

# 协议IFlyRecognizerViewDelegate

# IFlyRecognizerViewDelegate Protocol Reference

# Overview

识别回调委托

# onResult:isLast: required method

回调返回识别结果

- (void)onResult:(NSArray *)*resultArray* isLast:(BOOL)*isLast

Parameters

Declared In
IFlyRecognizerViewDelegate.h

# onCompleted: required method

识别结束回调

- (void)onCompleted:(IFlySpeechError *)*error

Parameters

Declared In
IFlyRecognizerViewDelegate.h

# 协议IFlySpeechRecognizerDelegate

# IFlySpeechRecognizerDelegate Protocol Reference

# Overview

语音识别协议 在使用语音识别时，需要实现这个协议中的方法.

# onCompleted: required method

识别结果回调

- (void)onCompleted:(IFlySpeechError *)*errorCode

Parameters

Discussion
在进行语音识别过程中的任何时刻都有可能回调此函数，你可以根据errorCode进行相应的处理，当errorCode没有错误时，表示此次会话正常结束；否则，表示此次会话有错误发生。特别的当调用cancel函数时，引擎不会自动结束，需要等到回调此函数，才表示此次会话结束。在没有回调此函数之前如果重新调用了startListenging函数则会报错误。

Declared In
IFlySpeechRecognizerDelegate.h

# onResults:isLast: required method

识别结果回调

- (void)onResults:(NSArray *)*results* isLast:(BOOL)*isLast

# Parameters

Return Value
appendFormat:@“%@”,key];//合并结果 } }

Discussion
在识别过程中可能会多次回调此函数，你最好不要在此回调函数中进行界面的更改等操作，只需要将回调的结果保存起来。
使用results的示例如下：

- (void) onResults:(NSArray ) results{
NSMutableString result = [[NSMutableString alloc] init];
NSDictionary dic = [results objectAtIndex:0];
for (NSString key in dic){

Declared In
IFlySpeechRecognizerDelegate.h

# onVolumeChanged:

音量变化回调
在录音过程中，回调音频的音量。

- (void)onVolumeChanged:(int)*volume

Parameters

Declared In
IFlySpeechRecognizerDelegate.h

# Declared In

IFlySpeechRecognizerDelegate.h

# onBeginOfSpeech

开始录音回调
当调用了startListening函数之后，如果没有发生错误则会回调此函数。
如果发生错误则回调onCompleted:函数

- (void)onBeginOfSpeech

Declared In
IFlySpeechRecognizerDelegate.h

# onEndOfSpeech

停止录音回调
当调用了stopListening函数或者引擎内部自动检测到断点，如果没有发生错误则回调此函数。
如果发生错误则回调onCompleted:函数

- (void)onEndOfSpeech

Declared In
IFlySpeechRecognizerDelegate.h

# onCancel

取消识别回调
当调用了cancel函数之后，会回调此函数，在调用了cancel函数和回调onCompleted之前会有一个
短暂时间，您可以在此函数中实现对这段时间的界面显示。

- (void)onCancel

Declared In
IFlySpeechRecognizerDelegate.h

# getAudioKey:

返回音频Key

- (void)getAudioKey:(NSString *)*key

Parameters

Declared In
IFlySpeechRecognizerDelegate.h

# onEvent:arg0:arg1:data:

扩展事件回调
根据事件类型返回额外的数据

- (void)onEvent:(int)*eventType* arg0:(int)*arg0* arg1:(int)*arg1* data:(NSData *)*eventData

# Parameters

Declared In
IFlySpeechRecognizerDelegate.h