VXIrecAPI.h
上传用户:xqtpzdz
上传日期:2022-05-21
资源大小:1764k
文件大小:4k
源码类别:

xml/soap/webservice

开发平台:

Visual C++

  1. /****************License************************************************
  2.  * Vocalocity OpenVXI
  3.  * Copyright (C) 2004-2005 by Vocalocity, Inc. All Rights Reserved.
  4.  * This program is free software; you can redistribute it and/or
  5.  * modify it under the terms of the GNU General Public License
  6.  * as published by the Free Software Foundation; either version 2
  7.  * of the License, or (at your option) any later version.
  8.  *  
  9.  * This program is distributed in the hope that it will be useful,
  10.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12.  * GNU General Public License for more details.
  13.  *
  14.  * You should have received a copy of the GNU General Public License
  15.  * along with this program; if not, write to the Free Software
  16.  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  17.  * Vocalocity, the Vocalocity logo, and VocalOS are trademarks or 
  18.  * registered trademarks of Vocalocity, Inc. 
  19.  * OpenVXI is a trademark of Scansoft, Inc. and used under license 
  20.  * by Vocalocity.
  21.  ***********************************************************************/
  22. #ifndef _VXIREC_API_H
  23. #define _VXIREC_API_H
  24. #include <VXIheaderPrefix.h>
  25. #include <VXIrec.h>                 /* For VXIrec base interface */
  26. #include <VXIlog.h>                 /* For VXIlog interface */
  27. #include <VXIinet.h>                   /* For VXIinet interface */
  28. #include <VXIcache.h>
  29. #include <VXIprompt.h>
  30. #include <VXItel.h>
  31. #ifdef __cplusplus
  32. extern "C" {
  33. #endif
  34. /**
  35.  * @name VXIrec
  36.  * @memo VXIrec Interface
  37.  * @doc
  38.  * VXIrec provides a simulator implementation of the VXIrec abstract interface
  39.  * for recognition functionality.   Recognition is done with all
  40.  * blocking calls, because VoiceXML is essentially a blocking
  41.  * protocol.  One VXIrec interface should be constructed per line.
  42.  */
  43. /*@{*/
  44. /**
  45.  * Global platform initialization of VXIrec
  46.  *
  47.  * @param log            VXI Logging interface used for error/diagnostic 
  48.  *                       logging, only used for the duration of this 
  49.  *                       function call
  50.  * @param diagLogBase    Base tag number for diagnostic logging purposes.
  51.  *                       All diagnostic tags for VXIrec will start at this
  52.  *                       ID and increase upwards.
  53.  * 
  54.  * @result VXIrec_RESULT_SUCCESS on success
  55.  */
  56. VXIREC_API VXIrecResult VXIrecInit(VXIlogInterface *log,
  57.    VXIunsigned      diagLogBase,
  58.    VXIMap           *args);
  59. /**
  60.  * Global platform shutdown of Recognizer
  61.  *
  62.  * @param log    VXI Logging interface used for error/diagnostic logging,
  63.  *               only used for the duration of this function call
  64.  *
  65.  * @result VXIrec_RESULT_SUCCESS on success
  66.  */
  67. VXIREC_API VXIrecResult VXIrecShutDown(VXIlogInterface *log);
  68. /**
  69.  * Create a new recognizer service handle
  70.  *
  71.  * @param log    VXI Logging interface used for error/diagnostic logging,
  72.  *               must remain a valid pointer throughout the lifetime of
  73.  *               the resource (until VXIrecDestroyResource( ) is called)
  74.  * @param inet   VXI Internet interface used for URL fetches,
  75.  *               must remain a valid pointer throughout the lifetime of
  76.  *               the resource (until VXIrecDestroyResource( ) is called)
  77.  * @param rec    VXIrecInterface pointer that will be allocated within this
  78.  *               function. Call VXIrecDestroyResource( ) to delete the 
  79.  *               resource.
  80.  *
  81.  * @result VXIrec_RESULT_SUCCESS on success 
  82.  */
  83. VXIREC_API VXIrecResult VXIrecCreateResource(VXIlogInterface   *log,
  84.      VXIinetInterface  *inet,
  85.       VXIcacheInterface *cache,
  86.       VXIpromptInterface *prompt,
  87.       VXItelInterface *tel,      
  88.      VXIrecInterface  **rec);
  89. /**
  90.  * Destroy the interface and free internal resources. Once this is
  91.  *  called, the logging and Internet interfaces passed to
  92.  *  VXIrecognizerCreateResource( ) may be released as well.
  93.  *
  94.  * @param rec    VXIrecInterface pointer that will be deallocated.  It will
  95.  *               be set to NULL when deallocated.
  96.  *
  97.  * @result VXIrec_RESULT_SUCCESS on success 
  98.  */
  99. VXIREC_API VXIrecResult VXIrecDestroyResource(VXIrecInterface **rec);
  100. /*@}*/
  101. #ifdef __cplusplus
  102. }
  103. #endif
  104. #include "VXIheaderSuffix.h"
  105. #endif  /* include guard */