灵云SDK开发手册(C API)  5.2
 全部 结构体 函数 变量 类型定义 枚举 枚举值 组 页
hci_sys.h
1 
6 #ifndef _hci_sys_header_
7 #define _hci_sys_header_
8 
9 #ifdef __ANDROID__
10 #include <jni.h>
11 #endif
12 
13 #ifdef __cplusplus
14 extern "C"
15 {
16 #endif
17 
19 /* @{ */
20 
21 /* parameter remark definition */
22 #ifndef _IN_
23 #define _IN_
24 #endif
25 #ifndef _OUT_
26 #define _OUT_
27 #endif
28 #ifndef _IN_OUT_
29 #define _IN_OUT_
30 #endif
31 #ifndef _MUST_
32 #define _MUST_
33 #endif
34 #ifndef _OPT_
35 #define _OPT_
36 #endif
37 
38 #ifdef _WIN32
39 #define HCIAPI _stdcall
40 #else
41 #define HCIAPI
42 #endif
43 
45 /* @{ */
46 
50 #if !defined _MSC_VER && !defined __BORLANDC__
51 # include <stdint.h>
52 #endif
53 
54 #if defined _MSC_VER || defined __BORLANDC__
55 typedef __int64 int64;
56 #else
57 typedef int64_t int64;
58 #endif
59 
63 #define SYS_MODULE "HCI_SYS"
64 
68 typedef enum {
69  HCI_ERR_UNKNOWN = -1,
70  HCI_ERR_NONE = 0,
71  HCI_ERR_PARAM_INVALID,
72  HCI_ERR_OUT_OF_MEMORY,
73  HCI_ERR_CONFIG_INVALID,
74  HCI_ERR_CONFIG_CAPKEY_MISSING,
75  HCI_ERR_CONFIG_CAPKEY_NOT_MATCH,
76  HCI_ERR_CONFIG_DATAPATH_MISSING,
77  HCI_ERR_CONFIG_UNSUPPORT,
78  HCI_ERR_SERVICE_CONNECT_FAILED,
79  HCI_ERR_SERVICE_TIMEOUT,
80  HCI_ERR_SERVICE_DATA_INVALID,
81  HCI_ERR_SERVICE_RESPONSE_FAILED,
82  HCI_ERR_CAPKEY_NOT_FOUND,
83  HCI_ERR_NOT_LOCAL_CAPKEY,
84  HCI_ERR_LOCAL_LIB_MISSING,
85  HCI_ERR_URL_MISSING,
86  HCI_ERR_SESSION_INVALID,
87  HCI_ERR_TOO_MANY_SESSION,
88  HCI_ERR_ACTIVE_SESSION_EXIST,
89  HCI_ERR_START_LOG_FAILED,
90  HCI_ERR_DATA_SIZE_TOO_LARGE,
91  HCI_ERR_LOAD_CODEC_DLL,
92  HCI_ERR_UNSUPPORT,
93  HCI_ERR_LOAD_FUNCTION_FROM_DLL,
94  HCI_ERR_TXACCOUNT_NOT_FOUND,
95 
96  //HCI_SYS
97  HCI_ERR_SYS_NOT_INIT = 100,
98  HCI_ERR_SYS_ALREADY_INIT,
99  HCI_ERR_SYS_CONFIG_AUTHPATH_MISSING,
100  HCI_ERR_SYS_CONFIG_CLOUDURL_MISSING,
101  HCI_ERR_SYS_CONFIG_USERID_MISSING,
102  HCI_ERR_SYS_CONFIG_PASSWORD_MISSING,
103  HCI_ERR_SYS_CONFIG_PLATFORMID_MISSING,
104  HCI_ERR_SYS_CONFIG_DEVELOPERID_MISSING,
105  HCI_ERR_SYS_CONFIG_DEVELOPERKEY_MISSING,
106  HCI_ERR_SYS_CONFIG_APPNO_MISSING,
107  HCI_ERR_SYS_USERINFO_INVALID,
108  HCI_ERR_SYS_AUTHFILE_INVALID,
109  HCI_ERR_SYS_CHECKAUTH_RESPONSE_FAILED,
110  HCI_ERR_SYS_REGISTER_RESPONSE_FAILED,
111  HCI_ERR_SYS_USING,
112  HCI_ERR_SYS_CONFIG_APPKEY_MISSING,
113 
114  /* HCI_ASR */
115  HCI_ERR_ASR_NOT_INIT = 200,
116  HCI_ERR_ASR_ALREADY_INIT,
117  HCI_ERR_ASR_CONFIRM_NO_TASK,
118  HCI_ERR_ASR_PARAM_CHECK_FLAG_INVALID,
119  HCI_ERR_ASR_GRAMMAR_DATA_TOO_LARGE,
120  HCI_ERR_ASR_ENGINE_NOT_INIT,
121  HCI_ERR_ASR_ENGINE_INIT_FAILED,
122  HCI_ERR_ASR_OPEN_GRAMMAR_FILE,
123  HCI_ERR_ASR_LOAD_GRAMMAR_FAILED,
124  HCI_ERR_ASR_ENGINE_FAILED,
125  HCI_ERR_ASR_GRAMMAR_ID_INVALID,
126  HCI_ERR_ASR_REALTIME_WAITING,
127  HCI_ERR_ASR_GRAMMAR_OVERLOAD,
128  HCI_ERR_ASR_GRAMMAR_USING,
129  HCI_ERR_ASR_REALTIME_END,
130  HCI_ERR_ASR_UPLOAD_NO_DATA,
131  HCI_ERR_ASR_REALTIME_NO_VOICE_INPUT,
132  HCI_ERR_ASR_VOICE_DATA_TOO_LARGE,
133 
134  /* HCI_HWR */
135  HCI_ERR_HWR_NOT_INIT = 300,
136  HCI_ERR_HWR_ALREADY_INIT,
137  HCI_ERR_HWR_CONFIRM_NO_TASK,
138  HCI_ERR_HWR_ENGINE_INIT_FAILED,
139  HCI_ERR_HWR_ENGINE_FAILED,
140  HCI_ERR_HWR_UPLOAD_NO_DATA,
141  HCI_ERR_HWR_ENGINE_SESSION_START_FAILED,
142  HCI_ERR_HWR_ENGINE_NOT_INIT,
143  HCI_ERR_HWR_CONFIG_SUBLANG_MISSING,
144  HCI_ERR_HWR_TOO_MANY_DOMAIN,
145 
146  /* HCI_OCR */
147  HCI_ERR_OCR_NOT_INIT = 400,
148  HCI_ERR_OCR_ALREADY_INIT,
149  HCI_ERR_OCR_ENGINE_INIT_FAILED,
150  HCI_ERR_OCR_ENGINE_FAILED,
151  HCI_ERR_OCR_ENGINE_NOT_INIT,
152  HCI_ERR_OCR_LOAD_IMAGE,
153  HCI_ERR_OCR_SAVE_IMAGE,
154  HCI_ERR_OCR_IMAGE_NOT_SET,
155  HCI_ERR_OCR_LOAD_TEMPLATE_FAILED,
156  HCI_ERR_OCR_TEMPLATE_OVERLOAD,
157  HCI_ERR_OCR_TEMPLATE_ID_INVALID,
158  HCI_ERR_OCR_TEMPLATE_USING,
159  HCI_ERR_OCR_DETECT_CORNER_FAILED,
160  HCI_ERR_OCR_NORMALIZE_FAILED,
161  HCI_ERR_OCR_RECOGNIZABLE_FAILED,
162  HCI_ERR_OCR_IMAGE_NOT_CLEAR,
163  HCI_ERR_OCR_CONFIG_TEMPLATE_ID_MISSING,
164  HCI_ERR_OCR_CONFIG_TEMPLATE_INDEX_MISSING,
165  HCI_ERR_OCR_CONFIG_TEMPLATE_PAGE_INDEX_MISSING,
166  HCI_ERR_OCR_CONFIG_PROPERTY_MISSING,
167  HCI_ERR_OCR_EDGE_IS_NOT_EXIST,
168 
169  /* HCI_TTS */
170  HCI_ERR_TTS_NOT_INIT = 500,
171  HCI_ERR_TTS_ALREADY_INIT,
172  HCI_ERR_TTS_SESSION_BUSY,
173  HCI_ERR_TTS_ENGINE_SESSION_START_FAILED,
174  HCI_ERR_TTS_ENGINE_FAILED,
175  HCI_ERR_TTS_ENGINE_INIT_FAILED,
176  HCI_ERR_TTS_ENGINE_NOT_INIT,
177  HCI_ERR_TTS_CONFIG_PROPERTY_MISSING,
178 
179  /* HCI_MT */
180  HCI_ERR_MT_NOT_INIT = 600,
181  HCI_ERR_MT_ALREADY_INIT,
182 
183  /*HCI_NLU*/
184  HCI_ERR_NLU_NOT_INIT = 700,
185  HCI_ERR_NLU_ALREADY_INIT,
186  HCI_ERR_NLU_ENGINE_SESSION_START_FAILED,
187  HCI_ERR_NLU_ENGINE_FAILED,
188 
189  /*HCI_KB*/
190  HCI_ERR_KB_NOT_INIT = 800,
191  HCI_ERR_KB_ALREADY_INIT,
192  HCI_ERR_KB_ENGINE_SESSION_START_FAILED,
193  HCI_ERR_KB_ENGINE_FAILED,
194  HCI_ERR_KB_SYLLABLE_INVALID,
195  HCI_ERR_KB_UDB_WORD_EXIST,
196  HCI_ERR_KB_CONFIRM_NO_TASK,
197 
198  /*HCI_VPR*/
199  HCI_ERR_VPR_NOT_INIT = 900,
200  HCI_ERR_VPR_ALREADY_INIT,
201  HCI_ERR_VPR_ENGINE_INIT_FAILED,
202  HCI_ERR_VPR_ENGINE_FAILED,
203  HCI_ERR_VPR_USERID_NOT_EXIST,
204  HCI_ERR_VPR_ENGINE_SESSION_START_FAILED,
205  HCI_ERR_VPR_CONFIG_USER_ID_MISSING,
206  HCI_ERR_VPR_CONFIG_GROUP_ID_MISSING,
207  HCI_ERR_VPR_REALTIME_WAITING,
208  HCI_ERR_VPR_VOICE_SHORT,
209  HCI_ERR_VPR_VOLUMN_HIGH,
210  HCI_ERR_VPR_VOLUMN_LOW,
211  HCI_ERR_VPR_NOISE_HIGH,
212  HCI_ERR_VPR_VAD_DETECT_RESULT_IS_EMPTY,
213 
214 
215  /*HCI_FPR*/
216  HCI_ERR_FPR_NOT_INIT = 1000,
217  HCI_ERR_FPR_ALREADY_INIT,
218  HCI_ERR_FPR_ENGINE_INIT_FAILED,
219  HCI_ERR_FPR_ENGINE_FAILED,
220  HCI_ERR_FPR_USERID_NOT_EXIST,
221  HCI_ERR_FPR_ENGINE_SESSION_START_FAILED,
222  HCI_ERR_FPR_CONFIG_USER_ID_MISSING,
223  HCI_ERR_FPR_CONFIG_DPI_MISSING,
224  HCI_ERR_FPR_CONFIG_BGCOLOR_MISSING,
225  HCI_ERR_FPR_CONFIG_WIDTH_MISSING,
226  HCI_ERR_FPR_CONFIG_HEIGHT_MISSING,
227  HCI_ERR_FPR_CONFIG_GROUP_ID_MISSING,
228 
229  /*HCI_AFR*/
230  HCI_ERR_AFR_NOT_INIT = 1100,
231  HCI_ERR_AFR_ALREADY_INIT,
232  HCI_ERR_AFR_ENGINE_INIT_FAILED,
233  HCI_ERR_AFR_ENGINE_FAILED,
234  HCI_ERR_AFR_USERID_NOT_EXIST,
235  HCI_ERR_AFR_ENGINE_SESSION_START_FAILED,
236  HCI_ERR_AFR_CONFIG_USER_ID_MISSING,
237  HCI_ERR_AFR_CONFIG_FACE_ID_MISSING,
238  HCI_ERR_AFR_CONFIG_GROUP_ID_MISSING,
239  HCI_ERR_AFR_ENGINE_SESSION_IMAGE_MISSING,
240  HCI_ERR_AFR_LOAD_IMAGE,
241  HCI_ERR_AFR_IMAGE_INVALID,
242  HCI_ERR_AFR_MODEL_INVALID,
243  HCI_ERR_AFR_CONFIG_INVALID,
244  HCI_ERR_AFR_PARAM_KEY,
245  HCI_ERR_AFR_SAVE_MODEL,
246  HCI_ERR_AFR_ENGINE,
247  HCI_ERR_AFR_FACEID_NOT_EXIST,
248  HCI_ERR_AFR_MODEL_NOT_EXIST,
249 
250  /*ASR Recorder*/
251  HCI_ERR_RECORDER_NOT_INIT = 1200,
252  HCI_ERR_RECORDER_ALREADY_INIT,
253  HCI_ERR_RECORDER_NOT_BEGIN,
254  HCI_ERR_RECORDER_ALREADY_BEGIN
255 
256 } HCI_ERR_CODE;
257 
258 
262 typedef struct _tag_CAPABILITY_ITEM
263 {
265  char* pszCapKey;
266 } CAPABILITY_ITEM;
267 
271 typedef struct _tag_CAPABILITY_LIST
272 {
274  CAPABILITY_ITEM * pItemList;
275 
277  unsigned int uiItemCount;
278 } CAPABILITY_LIST;
279 
280 /* @} */
282 /* @{ */
283 
472 #ifdef __ANDROID__
473 HCI_ERR_CODE HCIAPI hci_init(
474  _MUST_ _IN_ const char * pszConfig ,
475  _MUST_ _IN_ JavaVM *vm,
476  _MUST_ _IN_ jobject context);
477 #else
478 HCI_ERR_CODE HCIAPI hci_init(
479  _MUST_ _IN_ const char * pszConfig
480  );
481 #endif
482 
498 HCI_ERR_CODE HCIAPI hci_check_auth();
499 
513 HCI_ERR_CODE HCIAPI hci_get_auth_expire_time(
514  _MUST_ _OUT_ int64 * pnExpireTime
515  );
516 
517 
531 HCI_ERR_CODE HCIAPI hci_get_capability_list(
532  _OPT_ _IN_ const char * pszHciType,
533  _MUST_ _OUT_ CAPABILITY_LIST * psCapabilityList
534  );
535 
546 HCI_ERR_CODE HCIAPI hci_free_capability_list(
547  _MUST_ _IN_ CAPABILITY_LIST * psCapabilityList
548  );
549 
550 
566 HCI_ERR_CODE HCIAPI hci_upload_user_history();
567 
579 HCI_ERR_CODE HCIAPI hci_release();
580 
581 
589 const char * HCIAPI hci_get_error_info(HCI_ERR_CODE nErrorCode);
590 
596 const char * HCIAPI hci_get_sdk_version();
597 
598 /* @} */
599 /* @} */
601 
602 #ifdef __cplusplus
603 };
604 #endif
605 
606 #endif