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

VXIrecTransferResult Struct Reference
[Rec Interface]

#include <VXIrec.h>

List of all members.


Detailed Description

Record results structure as returned by HotwordTransfer().


Public Attributes

VXIContent * xmlresult
 The semantic interpretation of the recognition expressed using the Natural Language Semantic Markup Language (NLSML).
VXIunsigned duration
 Duration of the transfer in milliseconds.
VXItelTransferStatus status
 Result code for the transfer request.
VXIString * markname
 The name of the mark last executed by the SSML processor before barge-in occurred or the end of audio playback occurred.
VXIunsigned marktime
 The number of milliseconds that elapsed since the last mark was executed by the SSML processor until barge-in occurred or the end of audio playback occurred.
VXIContent * utterance
 Waveform of the caller's utterance.
VXIunsigned utteranceDuration
 Utterance length in milliseconds.
void(* Destroy )(struct VXIrecTransferResult **result)
 Call to release the resources stored with this result structure.


Member Data Documentation

void(* VXIrecTransferResult::Destroy)(struct VXIrecTransferResult **result)
 

Call to release the resources stored with this result structure.

The implementor of this function is expected to destroy all members of this structure. i.e., VXIContentDestory, VXIStringDestroy, or VXIULongDestroy respectively.

VXIunsigned VXIrecTransferResult::duration
 

Duration of the transfer in milliseconds.

VXIString* VXIrecTransferResult::markname
 

The name of the mark last executed by the SSML processor before barge-in occurred or the end of audio playback occurred.

If no mark was executed, this variable is NULL.

VXIunsigned VXIrecTransferResult::marktime
 

The number of milliseconds that elapsed since the last mark was executed by the SSML processor until barge-in occurred or the end of audio playback occurred.

If no mark was executed, this variable is NULL.

VXItelTransferStatus VXIrecTransferResult::status
 

Result code for the transfer request.

VXIContent* VXIrecTransferResult::utterance
 

Waveform of the caller's utterance.

If the VXML property 'recordutterance' is true, the audio data of the callers utterance should be placed here. Otherwise, this field should be set to NULL.

The MIME type of the utterance, as specified by 'recordutterancetype' should be used when calling VXIContentCreate.

VXIunsigned VXIrecTransferResult::utteranceDuration
 

Utterance length in milliseconds.

This field is ignored if 'utterance' is NULL.

VXIContent* VXIrecTransferResult::xmlresult
 

The semantic interpretation of the recognition expressed using the Natural Language Semantic Markup Language (NLSML).

The mimetype of the VXIContent may allow multiple formats to be supported.


The documentation for this struct was generated from the following file:
Generated on Wed Jun 1 12:50:19 2005 for OpenVXI by  doxygen 1.4.2