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

VXIrecRecordResult Struct Reference
[Rec Interface]

#include <VXIrec.h>

List of all members.


Detailed Description

Record results structure as returned by Record().


Public Attributes

VXIContent * waveform
 The bytes of the recording.
VXIContent * xmlresult
 The semantic interpretation of the recognition expressed using the Natural Language Semantic Markup Language (NLSML).
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.
VXIunsigned duration
 Duration of the recording in milliseconds.
VXIbyte termchar
 DTMF character which terminated the recording, or 0 if none.
VXIbool maxtime
 True if the recording was terminated because the maximum time limit was reached.
void(* Destroy )(struct VXIrecRecordResult **result)
 Call to release the resources stored with this result structure.


Member Data Documentation

void(* VXIrecRecordResult::Destroy)(struct VXIrecRecordResult **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 VXIrecRecordResult::duration
 

Duration of the recording in milliseconds.

VXIString* VXIrecRecordResult::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 VXIrecRecordResult::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.

VXIbool VXIrecRecordResult::maxtime
 

True if the recording was terminated because the maximum time limit was reached.

VXIbyte VXIrecRecordResult::termchar
 

DTMF character which terminated the recording, or 0 if none.

VXIContent* VXIrecRecordResult::waveform
 

The bytes of the recording.

VXIContent* VXIrecRecordResult::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