Main Page | Modules | Namespace List | Class Hierarchy | Class List | File List | Class Members | File Members

VXIrec.h File Reference

#include "VXItypes.h"
#include "VXIvalue.h"
#include "VXItel.h"
#include "VXIheaderPrefix.h"
#include "VXIheaderSuffix.h"

Properties

Keys identifying properties in VXIMap

For VXIrecInterface::LoadGrammarURI and VXIrecInterface::LoadGrammarString, the only standard properties are VXIinet properties that are simply passed through to VXIinet for fetches as-is. The implementation may define additional properties.

For VXIrecInterface::Recognize and VXIrecInterface::Record, the following standard properties are defined:

#define REC_BARGEIN_TYPE   L"vxi.rec.bargeinType"
#define REC_BEEP   L"vxi.rec.beep"
#define REC_CONFIDENCE_LEVEL   L"vxi.rec.confidenceLevel"
#define REC_DTMF_FLUSH_QUEUE   L"vxi.rec.flushDTMFQueue"
#define REC_DTMF_TERMINATOR_CHAR   L"vxi.rec.terminatorChar"
#define REC_DTMF_TIMEOUT   L"vxi.rec.timeout"
#define REC_DTMF_TIMEOUT_INTERDIGIT   L"vxi.rec.timeoutInterdigit"
#define REC_DTMF_TIMEOUT_TERMINATOR   L"vxi.rec.timeoutTerminator"
#define REC_INPUT_MODES   L"vxi.rec.inputModes"
#define REC_MAX_RECORDING_TIME   L"vxi.rec.maxRecordingTime"
#define REC_RECORD_MIME_TYPE   L"vxi.rec.recordingMimeType"
#define REC_RECORDUTTERANCE   L"vxi.rec.recordutterance"
#define REC_RECORDUTTERANCETYPE   L"vxi.rec.recordutterancetype"
#define REC_RESULT_NBEST_SIZE   L"vxi.rec.resultNbestSize"
#define REC_SENSITIVITY   L"vxi.rec.sensitivity"
#define REC_SPEED_VS_ACCURACY   L"vxi.rec.speedVsAccuracy"
#define REC_TERMINATED_ON_DTMF   L"vxi.rec.terminatedOnDTMF"
#define REC_TIMEOUT   L"vxi.rec.timeout"
#define REC_TIMEOUT_COMPLETE   L"vxi.rec.timeoutComplete"
#define REC_TIMEOUT_INCOMPLETE   L"vxi.rec.timeoutIncomplete"
#define REC_TIMEOUT_SPEECH   L"vxi.rec.maxspeechtime"

Grammar Properties

For VXIrecInterface::LoadGrammarURI, VXIrecInterface::LoadGrammarString, and VXIrecInterface::LoadGrammarOption, the following standard properties are defined:

#define REC_GRAMMAR_ACCEPTANCE   L"vxi.rec.grammarAcceptance"
#define REC_GRAMMAR_MODE   L"vxi.rec.grammarMode"
#define REC_GRAMMAR_WEIGHT   L"vxi.rec.grammarWeight"
#define REC_LANGUAGE   L"vxi.rec.language"
#define REC_PREFETCH_REQUEST   L"vxi.rec.prefetchLevel"

Defines

#define VXIREC_API   SYMBOL_IMPORT_DECL
#define VXIREC_MIMETYPE_ULAW   VXI_MIME_ULAW
#define VXIREC_MIMETYPE_XMLRESULT   L"application/x-vocalocity.nlsml"
#define REC_MIME_CHOICE   L"text/x-grammar-choice"
 MIME content types for LoadGrammarURI and LoadGrammarString, the implementation usually supports additional MIME types.
#define REC_MIME_CHOICE_DTMF   L"text/x-grammar-choice-dtmf"

Typedefs

typedef enum VXIrecBargeinType VXIrecBargeinType
 Bargein types as set in the REC_BARGEIN_TYPE property defined above.
typedef enum VXIrecInputMode VXIrecInputMode
 Input modes as set in the REC_INPUT_MODE property defined above and as returned in VXIrecResult structures.
typedef VXIrecRecognitionResult VXIrecRecognitionResult
 Recognition result as returned by Recognize().
typedef VXIrecRecordResult VXIrecRecordResult
 Record results structure as returned by Record().
typedef VXIrecTransferResult VXIrecTransferResult
 Record results structure as returned by HotwordTransfer().
typedef enum VXIrecResult VXIrecResult
 Result codes for interface methods.
typedef VXIrecInterface VXIrecInterface
 Abstract interface for recognition functionality required by VoiceXML.

Enumerations

enum  VXIrecBargeinType { REC_BARGEIN_SPEECH = 2, REC_BARGEIN_HOTWORD = 4 }
 Bargein types as set in the REC_BARGEIN_TYPE property defined above. More...
enum  VXIrecInputMode { REC_INPUT_MODE_DTMF = 2, REC_INPUT_MODE_SPEECH = 4, REC_INPUT_MODE_DTMF_SPEECH = 6 }
 Input modes as set in the REC_INPUT_MODE property defined above and as returned in VXIrecResult structures. More...
enum  VXIrecResult {
  VXIrec_RESULT_FATAL_ERROR = -100, VXIrec_RESULT_IO_ERROR = -8, VXIrec_RESULT_OUT_OF_MEMORY = -7, VXIrec_RESULT_SYSTEM_ERROR = -6,
  VXIrec_RESULT_PLATFORM_ERROR = -5, VXIrec_RESULT_BUFFER_TOO_SMALL = -4, VXIrec_RESULT_INVALID_PROP_NAME = -3, VXIrec_RESULT_INVALID_PROP_VALUE = -2,
  VXIrec_RESULT_INVALID_ARGUMENT = -1, VXIrec_RESULT_SUCCESS = 0, VXIrec_RESULT_FAILURE = 1, VXIrec_RESULT_NON_FATAL_ERROR = 2,
  VXIrec_RESULT_FETCH_TIMEOUT = 50, VXIrec_RESULT_FETCH_ERROR = 51, VXIrec_RESULT_BAD_GRAMMAR = 52, VXIrec_RESULT_SYNTAX_ERROR = 53,
  VXIrec_RESULT_BAD_MIME_TYPE = 54, VXIrec_RESULT_UNSUPPORTED_FORMAT = VXIrec_RESULT_BAD_MIME_TYPE, VXIrec_RESULT_UNSUPPORTED_BUILTIN = 55, VXIrec_RESULT_UNSUPPORTED_LANGUAGE = 56,
  VXIrec_RESULT_NO_RESOURCE = 57, VXIrec_RESULT_NO_AUTHORIZATION = 58, VXIrec_RESULT_MAX_SPEECH_TIMEOUT = 59, VXIrec_RESULT_CONNECTION_NO_AUTHORIZATION = 60,
  VXIrec_RESULT_CONNECTION_BAD_DESTINATION = 61, VXIrec_RESULT_CONNECTION_NO_ROUTE = 62, VXIrec_RESULT_CONNECTION_NO_RESOURCE = 63, VXIrec_RESULT_UNSUPPORTED_URI = 64,
  VXIrec_RESULT_UNSUPPORTED = 100
}
 Result codes for interface methods. More...


Define Documentation

#define VXIREC_API   SYMBOL_IMPORT_DECL
 


Generated on Wed Jun 1 12:50:19 2005 for OpenVXI by  doxygen 1.4.2