SR_RecognizerResult.h

00001 /*---------------------------------------------------------------------------*
00002  *  SR_RecognizerResult.h  *
00003  *                                                                           *
00004  *  Copyright 2007 Nuance Communciations, Inc.                               *
00005  *                                                                           *
00006  *  Licensed under the Apache License, Version 2.0 (the 'License');          *
00007  *  you may not use this file except in compliance with the License.         *
00008  *                                                                           *
00009  *  You may obtain a copy of the License at                                  *
00010  *      http://www.apache.org/licenses/LICENSE-2.0                           *
00011  *                                                                           *
00012  *  Unless required by applicable law or agreed to in writing, software      *
00013  *  distributed under the License is distributed on an 'AS IS' BASIS,        *
00014  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * 
00015  *  See the License for the specific language governing permissions and      *
00016  *  limitations under the License.                                           *
00017  *                                                                           *
00018  *---------------------------------------------------------------------------*/
00019 
00020 #ifndef __SR_RECOGNIZERRESULT_H
00021 #define __SR_RECOGNIZERRESULT_H
00022 
00023 
00024 
00025 #include <stddef.h>
00026 #include "ESR_Locale.h"
00027 #include "ESR_ReturnCode.h"
00028 #include "SR_RecognizerPrefix.h"
00029 #include "ptypes.h"
00030 
00041 typedef struct SR_RecognizerResult_t
00042 {
00052   ESR_ReturnCode(*getWaveform)(const struct SR_RecognizerResult_t* self, const asr_int16_t** waveform,
00053                                size_t* size);
00061   ESR_ReturnCode(*getSize)(const struct SR_RecognizerResult_t* self, size_t* resultSize);
00070   ESR_ReturnCode(*getKeyCount)(const struct SR_RecognizerResult_t* self, const size_t nbest,
00071                                size_t* count);
00084   ESR_ReturnCode(*getKeyList)(const struct SR_RecognizerResult_t* self, const size_t nbest,
00085                               LCHAR** list, size_t* listSize);
00098   ESR_ReturnCode(*getValue)(const struct SR_RecognizerResult_t* self, const size_t nbest,
00099                             const LCHAR* key, LCHAR* value, size_t* len);
00100                             
00108   ESR_ReturnCode(*getLocale)(const struct SR_RecognizerResult_t* self,  ESR_Locale* locale);
00109   
00110 }
00111 SR_RecognizerResult;
00112 
00122 SREC_RECOGNIZER_API ESR_ReturnCode SR_RecognizerResultGetWaveform(const SR_RecognizerResult* self,
00123     const asr_int16_t** waveform, size_t* size);
00131 SREC_RECOGNIZER_API ESR_ReturnCode SR_RecognizerResultGetSize(const SR_RecognizerResult* self,
00132     size_t* resultSize);
00141 SREC_RECOGNIZER_API ESR_ReturnCode SR_RecognizerResultGetKeyCount(const SR_RecognizerResult* self,
00142     const size_t nbest,
00143     size_t* count);
00156 SREC_RECOGNIZER_API ESR_ReturnCode SR_RecognizerResultGetKeyList(const SR_RecognizerResult* self,
00157     const size_t nbest,
00158     LCHAR** list,
00159     size_t* listSize);
00172 SREC_RECOGNIZER_API ESR_ReturnCode SR_RecognizerResultGetValue(const SR_RecognizerResult* self,
00173     const size_t nbest,
00174     const LCHAR* key,
00175     LCHAR* value, size_t* len);
00176     
00184 SREC_RECOGNIZER_API ESR_ReturnCode SR_RecognizerResultGetLocale(const SR_RecognizerResult* self,
00185     ESR_Locale* locale);
00186     
00192 #endif /* __SR_RECOGNIZERRESULT_H */

Generated on Thu May 1 15:37:26 2008 for SREC by  doxygen 1.5.3