灵云SDK开发手册(C API)  8.1
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  HCI_ERR_COMPRESS_DATA_FAILED,
96  HCI_ERR_ROCKEY_INVALID,
97 
98  //HCI_SYS
99  HCI_ERR_SYS_NOT_INIT = 100,
100  HCI_ERR_SYS_ALREADY_INIT,
101  HCI_ERR_SYS_CONFIG_AUTHPATH_MISSING,
102  HCI_ERR_SYS_CONFIG_CLOUDURL_MISSING,
103  HCI_ERR_SYS_CONFIG_USERID_MISSING,
104  HCI_ERR_SYS_CONFIG_PASSWORD_MISSING,
105  HCI_ERR_SYS_CONFIG_PLATFORMID_MISSING,
106  HCI_ERR_SYS_CONFIG_DEVELOPERID_MISSING,
107  HCI_ERR_SYS_CONFIG_DEVELOPERKEY_MISSING,
108  HCI_ERR_SYS_CONFIG_APPNO_MISSING,
109  HCI_ERR_SYS_USERINFO_INVALID,
110  HCI_ERR_SYS_AUTHFILE_INVALID,
111  HCI_ERR_SYS_CHECKAUTH_RESPONSE_FAILED,
112  HCI_ERR_SYS_REGISTER_RESPONSE_FAILED,
113  HCI_ERR_SYS_USING,
114  HCI_ERR_SYS_CONFIG_APPKEY_MISSING,
115 
116  /* HCI_ASR */
117  HCI_ERR_ASR_NOT_INIT = 200,
118  HCI_ERR_ASR_ALREADY_INIT,
119  HCI_ERR_ASR_CONFIRM_NO_TASK,
120  HCI_ERR_ASR_PARAM_CHECK_FLAG_INVALID,
121  HCI_ERR_ASR_GRAMMAR_DATA_TOO_LARGE,
122  HCI_ERR_ASR_ENGINE_NOT_INIT,
123  HCI_ERR_ASR_ENGINE_INIT_FAILED,
124  HCI_ERR_ASR_OPEN_GRAMMAR_FILE,
125  HCI_ERR_ASR_LOAD_GRAMMAR_FAILED,
126  HCI_ERR_ASR_ENGINE_FAILED,
127  HCI_ERR_ASR_GRAMMAR_ID_INVALID,
128  HCI_ERR_ASR_REALTIME_WAITING,
129  HCI_ERR_ASR_GRAMMAR_OVERLOAD,
130  HCI_ERR_ASR_GRAMMAR_USING,
131  HCI_ERR_ASR_REALTIME_END,
132  HCI_ERR_ASR_UPLOAD_NO_DATA,
133  HCI_ERR_ASR_REALTIME_NO_VOICE_INPUT,
134  HCI_ERR_ASR_VOICE_DATA_TOO_LARGE,
135  HCI_ERR_ASR_SAVE_GRAMMAR_FAILED,
136  HCI_ERR_ASR_GRAMMAR_ID_EMPTY,
137 
138  /* HCI_HWR */
139  HCI_ERR_HWR_NOT_INIT = 300,
140  HCI_ERR_HWR_ALREADY_INIT,
141  HCI_ERR_HWR_CONFIRM_NO_TASK,
142  HCI_ERR_HWR_ENGINE_INIT_FAILED,
143  HCI_ERR_HWR_ENGINE_FAILED,
144  HCI_ERR_HWR_UPLOAD_NO_DATA,
145  HCI_ERR_HWR_ENGINE_SESSION_START_FAILED,
146  HCI_ERR_HWR_ENGINE_NOT_INIT,
147  HCI_ERR_HWR_CONFIG_SUBLANG_MISSING,
148  HCI_ERR_HWR_TOO_MANY_DOMAIN,
149 
150  /* HCI_OCR */
151  HCI_ERR_OCR_NOT_INIT = 400,
152  HCI_ERR_OCR_ALREADY_INIT,
153  HCI_ERR_OCR_ENGINE_INIT_FAILED,
154  HCI_ERR_OCR_ENGINE_FAILED,
155  HCI_ERR_OCR_ENGINE_NOT_INIT,
156  HCI_ERR_OCR_LOAD_IMAGE,
157  HCI_ERR_OCR_SAVE_IMAGE,
158  HCI_ERR_OCR_IMAGE_NOT_SET,
159  HCI_ERR_OCR_LOAD_TEMPLATE_FAILED,
160  HCI_ERR_OCR_TEMPLATE_OVERLOAD,
161  HCI_ERR_OCR_TEMPLATE_ID_INVALID,
162  HCI_ERR_OCR_TEMPLATE_USING,
163  HCI_ERR_OCR_DETECT_CORNER_FAILED,
164  HCI_ERR_OCR_NORMALIZE_FAILED,
165  HCI_ERR_OCR_RECOGNIZABLE_FAILED,
166  HCI_ERR_OCR_IMAGE_NOT_CLEAR,
167  HCI_ERR_OCR_CONFIG_TEMPLATE_ID_MISSING,
168  HCI_ERR_OCR_CONFIG_TEMPLATE_INDEX_MISSING,
169  HCI_ERR_OCR_CONFIG_TEMPLATE_PAGE_INDEX_MISSING,
170  HCI_ERR_OCR_CONFIG_PROPERTY_MISSING,
171  HCI_ERR_OCR_EDGE_IS_NOT_EXIST,
172  HCI_ERR_OCR_NOT_BIZCARD,
173  HCI_ERR_OCR_NO_TEXT,
174  HCI_ERR_OCR_INVALID_SIZE_IMAGE,
175  HCI_ERR_OCR_IMAGE_DARK,
176 
177  /* HCI_TTS */
178  HCI_ERR_TTS_NOT_INIT = 500,
179  HCI_ERR_TTS_ALREADY_INIT,
180  HCI_ERR_TTS_SESSION_BUSY,
181  HCI_ERR_TTS_ENGINE_SESSION_START_FAILED,
182  HCI_ERR_TTS_ENGINE_FAILED,
183  HCI_ERR_TTS_ENGINE_INIT_FAILED,
184  HCI_ERR_TTS_ENGINE_NOT_INIT,
185  HCI_ERR_TTS_CONFIG_PROPERTY_MISSING,
186 
187  /* HCI_MT */
188  HCI_ERR_MT_NOT_INIT = 600,
189  HCI_ERR_MT_ALREADY_INIT,
190 
191  /*HCI_NLU*/
192  HCI_ERR_NLU_NOT_INIT = 700,
193  HCI_ERR_NLU_ALREADY_INIT,
194  HCI_ERR_NLU_ENGINE_SESSION_START_FAILED,
195  HCI_ERR_NLU_ENGINE_FAILED,
196 
197  /*HCI_KB*/
198  HCI_ERR_KB_NOT_INIT = 800,
199  HCI_ERR_KB_ALREADY_INIT,
200  HCI_ERR_KB_ENGINE_SESSION_START_FAILED,
201  HCI_ERR_KB_ENGINE_FAILED,
202  HCI_ERR_KB_SYLLABLE_INVALID,
203  HCI_ERR_KB_UDB_WORD_EXIST,
204  HCI_ERR_KB_CONFIRM_NO_TASK,
205 
206  /*HCI_VPR*/
207  HCI_ERR_VPR_NOT_INIT = 900,
208  HCI_ERR_VPR_ALREADY_INIT,
209  HCI_ERR_VPR_ENGINE_INIT_FAILED,
210  HCI_ERR_VPR_ENGINE_FAILED,
211  HCI_ERR_VPR_USERID_NOT_EXIST,
212  HCI_ERR_VPR_ENGINE_SESSION_START_FAILED,
213  HCI_ERR_VPR_CONFIG_USER_ID_MISSING,
214  HCI_ERR_VPR_CONFIG_GROUP_ID_MISSING,
215  HCI_ERR_VPR_REALTIME_WAITING,
216  HCI_ERR_VPR_VOICE_SHORT,
217  HCI_ERR_VPR_VOLUMN_HIGH,
218  HCI_ERR_VPR_VOLUMN_LOW,
219  HCI_ERR_VPR_NOISE_HIGH,
220  HCI_ERR_VPR_VAD_DETECT_RESULT_IS_EMPTY,
221 
222 
223  /*HCI_FPR*/
224  HCI_ERR_FPR_NOT_INIT = 1000,
225  HCI_ERR_FPR_ALREADY_INIT,
226  HCI_ERR_FPR_ENGINE_INIT_FAILED,
227  HCI_ERR_FPR_ENGINE_FAILED,
228  HCI_ERR_FPR_USERID_NOT_EXIST,
229  HCI_ERR_FPR_ENGINE_SESSION_START_FAILED,
230  HCI_ERR_FPR_CONFIG_USER_ID_MISSING,
231  HCI_ERR_FPR_CONFIG_DPI_MISSING,
232  HCI_ERR_FPR_CONFIG_BGCOLOR_MISSING,
233  HCI_ERR_FPR_CONFIG_WIDTH_MISSING,
234  HCI_ERR_FPR_CONFIG_HEIGHT_MISSING,
235  HCI_ERR_FPR_CONFIG_GROUP_ID_MISSING,
236 
237  /*HCI_AFR*/
238  HCI_ERR_AFR_NOT_INIT = 1100,
239  HCI_ERR_AFR_ALREADY_INIT,
240  HCI_ERR_AFR_ENGINE_INIT_FAILED,
241  HCI_ERR_AFR_ENGINE_FAILED,
242  HCI_ERR_AFR_USERID_NOT_EXIST,
243  HCI_ERR_AFR_ENGINE_SESSION_START_FAILED,
244  HCI_ERR_AFR_CONFIG_USER_ID_MISSING,
245  HCI_ERR_AFR_CONFIG_FACE_ID_MISSING,
246  HCI_ERR_AFR_CONFIG_GROUP_ID_MISSING,
247  HCI_ERR_AFR_ENGINE_SESSION_IMAGE_MISSING,
248  HCI_ERR_AFR_LOAD_IMAGE,
249  HCI_ERR_AFR_IMAGE_INVALID,
250  HCI_ERR_AFR_MODEL_INVALID,
251  HCI_ERR_AFR_CONFIG_INVALID,
252  HCI_ERR_AFR_PARAM_KEY,
253  HCI_ERR_AFR_SAVE_MODEL,
254  HCI_ERR_AFR_ENGINE,
255  HCI_ERR_AFR_FACEID_NOT_EXIST,
256  HCI_ERR_AFR_MODEL_NOT_EXIST
257 
258  } HCI_ERR_CODE;
259 
260 
264  typedef struct _tag_CAPABILITY_ITEM
265  {
267  char* pszCapKey;
268  } CAPABILITY_ITEM;
269 
273  typedef struct _tag_CAPABILITY_LIST
274  {
276  CAPABILITY_ITEM * pItemList;
277 
279  unsigned int uiItemCount;
280  } CAPABILITY_LIST;
281 
282  /* @} */
284  /* @{ */
285 
474 #ifdef __ANDROID__
475  HCI_ERR_CODE HCIAPI hci_init(
476  _MUST_ _IN_ const char * pszConfig ,
477  _MUST_ _IN_ JavaVM *vm,
478  _MUST_ _IN_ jobject context);
479 #else
480  HCI_ERR_CODE HCIAPI hci_init(
481  _MUST_ _IN_ const char * pszConfig
482  );
483 #endif
484 
500  HCI_ERR_CODE HCIAPI hci_check_auth();
501 
515  HCI_ERR_CODE HCIAPI hci_get_auth_expire_time(
516  _MUST_ _OUT_ int64 * pnExpireTime
517  );
518 
519 
533  HCI_ERR_CODE HCIAPI hci_get_capability_list(
534  _OPT_ _IN_ const char * pszHciType,
535  _MUST_ _OUT_ CAPABILITY_LIST * psCapabilityList
536  );
537 
548  HCI_ERR_CODE HCIAPI hci_free_capability_list(
549  _MUST_ _IN_ CAPABILITY_LIST * psCapabilityList
550  );
551 
552 
568  HCI_ERR_CODE HCIAPI hci_upload_user_history();
569 
581  HCI_ERR_CODE HCIAPI hci_release();
582 
583 
591  const char * HCIAPI hci_get_error_info(HCI_ERR_CODE nErrorCode);
592 
598  const char * HCIAPI hci_get_sdk_version();
599 
600  /* @} */
601  /* @} */
603 
604 #ifdef __cplusplus
605 };
606 #endif
607 
608 #endif
生成于 2019年 一月 2日 星期三 17:26:03 , 为 灵云SDK开发手册(C API)使用   doxygen 1.8.3.1