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

Prompt Interface


Detailed Description

Abstract interface for Prompting functionality.

Prompts are represented as a series of SSML documents.


Classes

struct  VXIpromptInterface
 Abstract interface for Prompting functionality. More...

Properties

Keys identifying properties in a VXIMap passed to the Prompt interface functions.

#define PROMPT_AUDIO_REFS   L"vxi.prompt.audioReferences"
 Key to a VXIMap that holds audio content created during a <record>.
#define PROMPT_PREFETCH_REQUEST   L"vxi.prompt.prefetchLevel"
 Key to a VXIInteger that indicates whether a SSML document passed to Prefetch should be prefetched.

Defines

#define PROMPT_AUDIO_REFS_SCHEME   L"x-vxiprompt-ref"
 For audio created during a <record>, the SSML document passed to Queue will contain a <mark> with a name prefixed with this string.

Typedefs

typedef enum VXIpromptResult VXIpromptResult
 Result codes for interface methods.
typedef VXIpromptInterface VXIpromptInterface
 Abstract interface for Prompting functionality.

Enumerations

enum  VXIpromptResult {
  VXIprompt_RESULT_FATAL_ERROR = -100, VXIprompt_RESULT_IO_ERROR = -8, VXIprompt_RESULT_OUT_OF_MEMORY = -7, VXIprompt_RESULT_SYSTEM_ERROR = -6,
  VXIprompt_RESULT_PLATFORM_ERROR = -5, VXIprompt_RESULT_BUFFER_TOO_SMALL = -4, VXIprompt_RESULT_INVALID_PROP_NAME = -3, VXIprompt_RESULT_INVALID_PROP_VALUE = -2,
  VXIprompt_RESULT_INVALID_ARGUMENT = -1, VXIprompt_RESULT_SUCCESS = 0, VXIprompt_RESULT_FAILURE = 1, VXIprompt_RESULT_NON_FATAL_ERROR = 2,
  VXIprompt_RESULT_FETCH_TIMEOUT = 50, VXIprompt_RESULT_FETCH_ERROR = 51, VXIprompt_RESULT_BAD_SAYAS_CLASS = 52, VXIprompt_RESULT_TTS_ACCESS_ERROR = 53,
  VXIprompt_RESULT_TTS_BAD_LANGUAGE = 54, VXIprompt_RESULT_TTS_BAD_DOCUMENT = 55, VXIprompt_RESULT_TTS_SYNTAX_ERROR = 56, VXIprompt_RESULT_TTS_ERROR = 57,
  VXIprompt_RESULT_RESOURCE_BUSY = 58, VXIprompt_RESULT_HW_BAD_TYPE = 59, VXIprompt_RESULT_HW_ERROR = 60, VXIprompt_RESULT_NO_RESOURCE = 61,
  VXIprompt_RESULT_NO_AUTHORIZATION = 62, VXIprompt_RESULT_UNSUPPORTED = 100
}
 Result codes for interface methods. More...


Define Documentation

#define PROMPT_AUDIO_REFS   L"vxi.prompt.audioReferences"
 

Key to a VXIMap that holds audio content created during a <record>.

This map will contain key matching <mark> names in a SSML document passed to Queue. Each key will return a VXIContent value. See Queue for more information.

#define PROMPT_AUDIO_REFS_SCHEME   L"x-vxiprompt-ref"
 

For audio created during a <record>, the SSML document passed to Queue will contain a <mark> with a name prefixed with this string.

See Queue for more information.

#define PROMPT_PREFETCH_REQUEST   L"vxi.prompt.prefetchLevel"
 

Key to a VXIInteger that indicates whether a SSML document passed to Prefetch should be prefetched.

The value is 0 if no prefetch is requested. 1 if prefetch is desired.


Typedef Documentation

typedef struct VXIpromptInterface VXIpromptInterface
 

Abstract interface for Prompting functionality.

Prompts are represented as a series of SSML documents.

The Prompt interface the handles prefetching, caching, and streaming audio as required to provide good response times and low CPU and network overhead.

There is one prompt interface per thread/line.

typedef enum VXIpromptResult VXIpromptResult
 

Result codes for interface methods.

Result codes less then zero are severe errors (likely to be platform faults), those greater then zero are warnings (likely to be application issues)


Enumeration Type Documentation

enum VXIpromptResult
 

Result codes for interface methods.

Result codes less then zero are severe errors (likely to be platform faults), those greater then zero are warnings (likely to be application issues)

Enumeration values:
VXIprompt_RESULT_FATAL_ERROR 
VXIprompt_RESULT_IO_ERROR 
VXIprompt_RESULT_OUT_OF_MEMORY 
VXIprompt_RESULT_SYSTEM_ERROR 
VXIprompt_RESULT_PLATFORM_ERROR 
VXIprompt_RESULT_BUFFER_TOO_SMALL 
VXIprompt_RESULT_INVALID_PROP_NAME 
VXIprompt_RESULT_INVALID_PROP_VALUE 
VXIprompt_RESULT_INVALID_ARGUMENT 
VXIprompt_RESULT_SUCCESS 
VXIprompt_RESULT_FAILURE 
VXIprompt_RESULT_NON_FATAL_ERROR 
VXIprompt_RESULT_FETCH_TIMEOUT 
VXIprompt_RESULT_FETCH_ERROR 
VXIprompt_RESULT_BAD_SAYAS_CLASS 
VXIprompt_RESULT_TTS_ACCESS_ERROR 
VXIprompt_RESULT_TTS_BAD_LANGUAGE 
VXIprompt_RESULT_TTS_BAD_DOCUMENT 
VXIprompt_RESULT_TTS_SYNTAX_ERROR 
VXIprompt_RESULT_TTS_ERROR 
VXIprompt_RESULT_RESOURCE_BUSY 
VXIprompt_RESULT_HW_BAD_TYPE 
VXIprompt_RESULT_HW_ERROR 
VXIprompt_RESULT_NO_RESOURCE 
VXIprompt_RESULT_NO_AUTHORIZATION 
VXIprompt_RESULT_UNSUPPORTED 


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