hci_kb.h

#ifndef __HCI_KB_HEADER__
#define __HCI_KB_HEADER__

#include "hci_sys.h"

#ifdef __cplusplus
extern "C"
{
#endif

        /* @{ */


    /* @{ */
    
    #define KB_MODULE    "HCI_KB"
        
        typedef enum _tag_KB_SLIDE_INFO_ITEM_TYPE
        {
                KB_SLIDE_INFO_ITEM_TYPE_MINOR = 0,              
                KB_SLIDE_INFO_ITEM_TYPE_MAJOR,                  
        } KB_SLIDE_INFO_ITEM_TYPE;

        typedef struct _tag_KB_SLIDE_INFO_ITEM
        {
                KB_SLIDE_INFO_ITEM_TYPE eType;  
                char *pszKey;                                   
                unsigned int uiPercent;                 
        } KB_SLIDE_INFO_ITEM;

        typedef struct _tag_KB_QUERY_SELECTED_ITEM 
        {
                char* pszSelected;                                                      
                char* pszMatched;                                                       
        }KB_QUERY_SELECTED_ITEM;

        typedef struct _tag_KB_QUERY_INFO 
        {
                char* pszQuery;                                                         
                unsigned int uiSelectedItemCount;                       
                KB_QUERY_SELECTED_ITEM *psSelectedItemList;     
                unsigned int uiSlideInfoItemCount;                      
                KB_SLIDE_INFO_ITEM *psSlideInfoItemList;        
        } KB_QUERY_INFO;


        typedef struct _tag_KB_RESULT_MATCH_ITEM
        {
                char *  pszResultItem;                  
                char *  pszSymbolsItem;                 
        } KB_RESULT_MATCH_ITEM;

        typedef struct _tag_KB_RECOG_RESULT_ITEM 
        {
                char  *pszResult;                                               
                char  *pszSymbols;                                              
                unsigned int uiMatchItemCount;                  
                KB_RESULT_MATCH_ITEM *psMatchItemList;  
        } KB_RECOG_RESULT_ITEM;


        typedef struct _tag_KB_CONFIRM_RESULT 
        {
                char  *pszResult;                                               
        } KB_CONFIRM_RESULT;

        typedef struct _tag_KB_SYLLABLE_RESULT_ITEM
        {
                char *pszSyllable;                      
        } KB_SYLLABLE_RESULT_ITEM;

        typedef struct _tag_KB_RECOG_RESULT 
        {
                KB_RECOG_RESULT_ITEM *psResultItemList;         
                unsigned int uiResultItemCount;                         
                KB_SYLLABLE_RESULT_ITEM *psSyllableItemList;
                unsigned int uiSyllableItemCount;                       
                bool bMore;                                                                     
        } KB_RECOG_RESULT;

        typedef struct _tag_KB_UDB_ITEM_INFO
        {
                KB_RECOG_RESULT_ITEM pUdbItem;                  
        } KB_UDB_ITEM_INFO;

        typedef enum _tag_KB_FUZZY_SYLLABLE_TYPE
        {
                KB_FUZZY_SYLLABLE_TYPE_DEFAULT,                         
                KB_FUZZY_SYLLABLE_TYPE_INITIAL,                         
                KB_FUZZY_SYLLABLE_TYPE_FINAL,                           
                KB_FUZZY_SYLLABLE_TYPE_FULL,                            
        } KB_FUZZY_SYLLABLE_TYPE;

        typedef struct _tag_KB_FUZZY_SYLLABLE
        {
                KB_FUZZY_SYLLABLE_TYPE eType;                   
                char *                          pszSyllableOne;         
                char *                          pszSyllableTwo;         
        } KB_FUZZY_SYLLABLE;


        typedef struct _tag_KB_CONV_RESULT_ITEM
        {
                char *  pszSymbols;                                     
        } KB_CONV_RESULT_ITEM;

        typedef struct _tag_KB_CONV_RESULT
        {
                KB_CONV_RESULT_ITEM *psConvItemList;            
                unsigned int uiConvItemCount;                           
        } KB_CONV_RESULT;

// 回调函数定义

        typedef bool (HCIAPI * Callback_KB_UDB_ITERATE)(
                _OPT_ _IN_ void * pvUserParam,
                _MUST_ _IN_ KB_UDB_ITEM_INFO * psKbUdbItem,
                _MUST_ _IN_ HCI_ERR_CODE  hciErrCode
                );


    /* @} */
    /* @{ */

        HCI_ERR_CODE HCIAPI hci_kb_init(
                _MUST_ _IN_ const char * pszConfig
                );


        HCI_ERR_CODE HCIAPI hci_kb_session_start(
                _MUST_ _IN_ const char * pszConfig,
                _MUST_ _OUT_ int * pnSessionId
                );


        HCI_ERR_CODE HCIAPI hci_kb_fuzzy_syllable(
                _MUST_ _IN_ int nSessionId,
                _MUST_ _IN_ KB_FUZZY_SYLLABLE *pFuzzySyllableList,
                _MUST_ _IN_ unsigned int uiFuzzySyllableCount
                );


        HCI_ERR_CODE HCIAPI hci_kb_recog(       
                _MUST_ _IN_ int nSessionId,
                _OPT_ _IN_ const char * pszConfig,
                _MUST_ _IN_ KB_QUERY_INFO *pQueryInfo,
                _MUST_ _OUT_ KB_RECOG_RESULT *pRecogResult
                );

        HCI_ERR_CODE HCIAPI hci_kb_confirm(_MUST_ _IN_ int nSessionId,_MUST_ _IN_ KB_CONFIRM_RESULT * pConfirmResult);

        HCI_ERR_CODE HCIAPI hci_kb_free_recog_result(_MUST_ _IN_ KB_RECOG_RESULT * pRecogResult);


        HCI_ERR_CODE HCIAPI hci_kb_udb_iterate(
                _MUST_ _IN_ int nSessionId,
                _MUST_ _IN_ Callback_KB_UDB_ITERATE pfnUdbIterate,
                _OPT_ _IN_ void * pvUserParam
                );

        HCI_ERR_CODE HCIAPI hci_kb_udb_commit(
                _MUST_ _IN_ int nSessionId,
                _OPT_ _IN_ const char * pszConfig,
                _MUST_ _IN_ KB_UDB_ITEM_INFO * psKbUdbItem
                );

        HCI_ERR_CODE HCIAPI hci_kb_udb_delete(
                _MUST_ _IN_ int nSessionId,
                _OPT_ _IN_ const char * pszConfig,
                _MUST_ _IN_ KB_UDB_ITEM_INFO * psKbUdbItem
                );

        HCI_ERR_CODE HCIAPI hci_kb_conv(
                _MUST_ _IN_ int nSessionId,
                _OPT_ _IN_ const char * pszConfig,
                _MUST_ _IN_ char *pszSrc,
                _MUST_ _IN_ KB_CONV_RESULT *pConvResult
                ); 

        HCI_ERR_CODE HCIAPI hci_kb_free_conv_result(_MUST_ _IN_ KB_CONV_RESULT * pConvResult);

        HCI_ERR_CODE HCIAPI hci_kb_session_stop(
                _MUST_ _IN_ int nSessionId
                );


        HCI_ERR_CODE HCIAPI hci_kb_release();

    /* @} */

/* @} */
#ifdef __cplusplus
}
#endif

#endif // _hci_cloud_tts_player_api_header_