OpenSpeech Browser

Getting Started
Architecture Description
Integration Guide

Copyright (c) 1998-2001 SpeechWorks International, Inc. All Rights Reserved.



typedef struct VXIasEventData

Event structure for returning audio and/or detailed status information

[more]VXIulong dataSizeBytes
Size of the audio data in bytes, may be 0.
[more]VXIptr data
Pointer to the audio data, NULL if dataSizeBytes is 0 or when this is related to an AS_EVENT_LOST or AS_EVENT_OVERFLOW event
[more]VXIchar* mimetype
MIME content type for the audio data, must match an audio type supported by the recognizer, and must be the same across the entire record operation.
[more]VXIulong sequenceNum
When dataSizeBytes is greater then 0 (audio data is being delivered), sequence number of the data packet, where the first audio packet after TriggerRecord( ) is 1, and then each packet afterwards increments the sequence number by one.
[more]VXIasResult resultCode
Result code indicating details for AS_EVENT_ERROR events, typically set to VXIas_RESULT_SUCCESS for other events


Documentation

Event structure for returning audio and/or detailed status information

All Audio Source events return an event data structure for providing audio from the record operation and/or detailed status information. This structure, along with all the data it points at, is only valid for the duration of the event listener invocation.

oVXIulong dataSizeBytes
Size of the audio data in bytes, may be 0. For AS_EVENT_LOST and AS_EVENT_OVERFLOW events, this is the amount of audio data lost.

oVXIptr data
Pointer to the audio data, NULL if dataSizeBytes is 0 or when this is related to an AS_EVENT_LOST or AS_EVENT_OVERFLOW event

oVXIchar* mimetype
MIME content type for the audio data, must match an audio type supported by the recognizer, and must be the same across the entire record operation. Typical choices are "audio/basic" (VXI_MIME_ULAW, Raw (headerless) 8kHz 8-bit mono u-law [PCM] single channel audio [G.711]) and "audio/x-alaw-basic (VXI_MIME_ALAW, Raw (headerless) 8kHz 8-bit mono A-law [PCM] single channel audio [G.711]). When reporting AS_EVENT_LOST or AS_EVENT_OVERFLOW events, the MIME content type must still indicate the audio type used for the actual stream so the dataSizeBytes value can be properly interpreted.

oVXIulong sequenceNum
When dataSizeBytes is greater then 0 (audio data is being delivered), sequence number of the data packet, where the first audio packet after TriggerRecord( ) is 1, and then each packet afterwards increments the sequence number by one. (A TriggerStop( ) operation followed by a TriggerRecord( ) thus resets the sequence number to 1.) If data packets are discarded due to buffer overflows (when an AS_EVENT_OVERFLOW is delivered), or if data packets were lost (when an AS_EVENT_LOST is delivered), the sequence number should also be incremented by one for each packet discarded or lost.

oVXIasResult resultCode
Result code indicating details for AS_EVENT_ERROR events, typically set to VXIas_RESULT_SUCCESS for other events

Alphabetic index HTML hierarchy of classes or Java



This page was generated with the help of DOC++.