Files
CustomPlugin/Libs/iflyMSC.framework/Headers/IFlySpeechRecognizerDelegate.h
2023-04-10 18:48:16 +08:00

112 lines
3.3 KiB
Objective-C
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

//
// IFlySpeechRecognizerDelegate.h
// MSC
//
// Created by ypzhao on 13-3-27.
// Copyright (c) 2013年 iflytek. All rights reserved.
//
#import <Foundation/Foundation.h>
@class IFlySpeechError;
/*!
* 构建语法结束回调
*
* @param grammarId 语法id
* @param error 错误描述
*/
typedef void(^IFlyOnBuildFinishCompletionHandler)(NSString* grammarId,IFlySpeechError * error);
/*!
* 语音识别协议<br>
* 在使用语音识别时,需要实现这个协议中的方法.
*/
@protocol IFlySpeechRecognizerDelegate <NSObject>
@required
/*!
* 识别结果回调
*
* 在进行语音识别过程中的任何时刻都有可能回调此函数你可以根据errorCode进行相应的处理当errorCode没有错误时表示此次会话正常结束否则表示此次会话有错误发生。特别的当调用`cancel`函数时,引擎不会自动结束,需要等到回调此函数,才表示此次会话结束。在没有回调此函数之前如果重新调用了`startListenging`函数则会报错误。
*
* @param errorCode 错误描述
*/
- (void) onError:(IFlySpeechError *) errorCode;
/*!
* 识别结果回调
*
* 在识别过程中可能会多次回调此函数,你最好不要在此回调函数中进行界面的更改等操作,只需要将回调的结果保存起来。<br>
* 使用results的示例如下
* <pre><code>
* - (void) onResults:(NSArray *) results{
* NSMutableString *result = [[NSMutableString alloc] init];
* NSDictionary *dic = [results objectAtIndex:0];
* for (NSString *key in dic){
* [result appendFormat:@"%@",key];//合并结果
* }
* }
* </code></pre>
*
* @param results -[out] 识别结果NSArray的第一个元素为NSDictionaryNSDictionary的key为识别结果sc为识别结果的置信度。
* @param isLast -[out] 是否最后一个结果
*/
- (void) onResults:(NSArray *) results isLast:(BOOL)isLast;
@optional
/*!
* 音量变化回调<br>
* 在录音过程中,回调音频的音量。
*
* @param volume -[out] 音量范围从0-30
*/
- (void) onVolumeChanged: (int)volume;
/*!
* 开始录音回调<br>
* 当调用了`startListening`函数之后,如果没有发生错误则会回调此函数。<br>
* 如果发生错误则回调onError:函数
*/
- (void) onBeginOfSpeech;
/*!
* 停止录音回调<br>
* 当调用了`stopListening`函数或者引擎内部自动检测到断点,如果没有发生错误则回调此函数。<br>
* 如果发生错误则回调onError:函数
*/
- (void) onEndOfSpeech;
/*!
* 取消识别回调<br>
* 当调用了`cancel`函数之后会回调此函数在调用了cancel函数和回调onError之前会有一个<br>
* 短暂时间,您可以在此函数中实现对这段时间的界面显示。
*/
- (void) onCancel;
#ifdef _EDUCATION_
/*!
* 返回音频Key
*
* @param key 音频Key
*/
- (void) getAudioKey:(NSString *)key;
#endif
/*!
* 扩展事件回调<br>
* 根据事件类型返回额外的数据
*
* @param eventType 事件类型具体参见IFlySpeechEventType的IFlySpeechEventTypeVoiceChangeResult枚举。
* @param arg0 arg0
* @param arg1 arg1
* @param eventData 事件数据
*/
- (void) onEvent:(int)eventType arg0:(int)arg0 arg1:(int)arg1 data:(NSData *)eventData;
@end