IFlySpeechRecognizer.h
7.01 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
//
// IFlySpeechRecognizer.h
// MSC
//
// Created by iflytek on 13-3-19.
// Copyright (c) 2013年 iflytek. All rights reserved.
//
#import <Foundation/Foundation.h>
#import "IFlySpeechRecognizerDelegate.h"
#define IFLY_AUDIO_SOURCE_MIC @"1"
#define IFLY_AUDIO_SOURCE_STREAM @"-1"
/*!
* 语音识别类
* 此类现在设计为单例，你在使用中只需要创建此对象，不能调用release/dealloc函数去释放此对象。所有关于语音识别的操作都在此类中。
*/
@interface IFlySpeechRecognizer : NSObject<IFlySpeechRecognizerDelegate>
/** 设置委托对象 */
@property(nonatomic,assign) id<IFlySpeechRecognizerDelegate> delegate ;
/*!
* 返回识别对象的单例
*
* @return 识别对象的单例
*/
+ (instancetype) sharedInstance;
/*!
* 销毁识别对象。
*
* @return 成功返回YES,失败返回NO
*/
- (BOOL) destroy;
/*
* | ------------- |-----------------------------------------------------------
* | 参数 | 描述
* | ------------- |-----------------------------------------------------------
* | domain |应用的领域: 取值为:iat、search、video、poi、music、asr；
* | | iat：普通文本听写；
* | | search：热词搜索；
* | | video：视频音乐搜索；
* | | asr：关键词识别;
* | ------------- |-----------------------------------------------------------
* | vad_bos |前端点检测: 静音超时时间，即用户多长时间不说话则当做超时处理； 单位：ms；
* | | engine指定iat识别默认值为5000；
* | | 其他情况默认值为 4000，范围 0-10000。
* | ------------- |-----------------------------------------------------------
* | vad_eos |后断点检测: 后端点静音检测时间,即用户停止说话多长时间内即认为不再输入,
* | | 自动停止录音；单位:ms;
* | | sms 识别默认值为 1800;
* | | 其他默认值为 700，范围 0-10000。
* | ------------- |-----------------------------------------------------------
* | sample_rate |采样率:目前支持的采样率设置有 16000 和 8000。
* | ------------- |-----------------------------------------------------------
* | asr_ptt |标点符号设置: 默认为 1，当设置为 0 时，将返回无标点符号文本。
* | ------------- |-----------------------------------------------------------
* | result_type |返回结果的数据格式: 可设置为json，xml，plain，默认为json。
* | ------------- |-----------------------------------------------------------
* | grammarID |识别的语法id: 只针对 domain 设置为”asr”的应用。
* | ------------- |-----------------------------------------------------------
* | asr_audio_path|音频文件名: 设置此参数后，将会自动保存识别的录音文件。
* | | 路径为Documents/(指定值)。
* | | 不设置或者设置为nil，则不保存音频。
* | ------------- |-----------------------------------------------------------
* | params |扩展参数: 对于一些特殊的参数可在此设置，一般用于设置语义。
* | ------------- |-----------------------------------------------------------
*
*/
/*!
* 设置识别引擎的参数
* 识别的引擎参数(key)取值如下：
* <table>
* <thead>
* <tr><th>*参数</th><th><em>描述</em></th>
* </tr>
* </thead>
* <tbody>
* <tr><td>domain</td><td>应用的领域: 取值为:iat、search、video、poi、music、asr；<br/>iat：普通文本听写；<br/>search：热词搜索；<br/>video：视频音乐搜索；<br/>video：视频音乐搜索；<br/>asr：关键词识别;</td></tr>
* <tr><td>vad_bos</td><td>前端点检测: 静音超时时间，即用户多长时间不说话则当做超时处理； 单位：ms；<br/>engine指定iat识别默认值为5000；<br/>其他情况默认值为 4000，范围 0-10000。</td></tr>
* <tr><td>vad_eos</td><td>后断点检测: 后端点静音检测时间,即用户停止说话多长时间内即认为不再输入,<br/>自动停止录音；单位:ms;<br/>sms 识别默认值为 1800;<br/>其他默认值为 700，范围 0-10000。</td></tr>
* <tr><td>sample_rate</td><td>采样率:目前支持的采样率设置有 16000 和 8000。</td></tr>
* <tr><td>asr_ptt</td><td>标点符号设置: 默认为 1，当设置为 0 时，将返回无标点符号文本。</td></tr>
* <tr><td>result_type</td><td>返回结果的数据格式: 可设置为json，xml，plain，默认为json。</td></tr>
* <tr><td>grammarID</td><td>识别的语法id: 只针对 domain 设置为”asr”的应用。</td></tr>
* <tr><td>asr_audio_path</td><td>音频文件名: 设置此参数后，将会自动保存识别的录音文件。<br/> 路径为Documents/(指定值)。<br/>不设置或者设置为nil，则不保存音频。</td></tr>
* <tr><td>params</td><td>扩展参数: 对于一些特殊的参数可在此设置，一般用于设置语义。</td></tr>
* </tbody>
* </table>
* @param value 参数对应的取值
* @param key 识别引擎参数
*
* @return 成功返回YES；失败返回NO
*/
-(BOOL) setParameter:(NSString *) value forKey:(NSString*)key;
/*!
* 获取识别引擎参数
*
* @param key 参数key
*
* @return 参数值
*/
-(NSString*) parameterForKey:(NSString *)key;
/*!
* 开始识别
* 同时只能进行一路会话，这次会话没有结束不能进行下一路会话，否则会报错。若有需要多次回话，
* 请在onError回调返回后请求下一路回话。
*
* @return 成功返回YES；失败返回NO
*/
- (BOOL) startListening;
/*!
* 停止录音
* 调用此函数会停止录音，并开始进行语音识别
*/
- (void) stopListening;
/*!
* 取消本次会话
*/
- (void) cancel;
/*!
* 上传语法
*
* @param completionHandler 上传语法完成回调
* @param grammarType 语法类型
* @param grammarContent 语法内容
*
* @return 错误码
*/
- (int) buildGrammarCompletionHandler:(IFlyOnBuildFinishCompletionHandler)completionHandler
grammarType:(NSString *)grammarType
grammarContent:(NSString *)grammarContent;
/** 是否正在识别
*/
@property (nonatomic, readonly) BOOL isListening;
@end
/*!
* 音频流识别
* 音频流识别可以将文件分段写入
*/
@interface IFlySpeechRecognizer(IFlyStreamRecognizer)
/*!
* 写入音频流
* 此方法的使用示例如下:
* <pre><code>[_iFlySpeechRecognizer setParameter:@"audio_source" value:@"-1"];
* [_iFlySpeechRecognizer startListening];
* [_iFlySpeechRecognizer writeAudio:audioData1];
* [_iFlySpeechRecognizer writeAudio:audioData2];
* ...
* [_iFlySpeechRecognizer stopListening];
* </code></pre>
*
* @param audioData 音频数据
*
* @return 写入成功返回YES，写入失败返回NO
*/
- (BOOL) writeAudio:(NSData *) audioData;
@end