14a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project/*---------------------------------------------------------------------------* 24a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * SR_SemanticResult.h * 34a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * * 44a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * Copyright 2007, 2008 Nuance Communciations, Inc. * 54a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * * 64a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * Licensed under the Apache License, Version 2.0 (the 'License'); * 74a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * you may not use this file except in compliance with the License. * 84a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * * 94a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * You may obtain a copy of the License at * 104a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 * 114a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * * 124a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * Unless required by applicable law or agreed to in writing, software * 134a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * distributed under the License is distributed on an 'AS IS' BASIS, * 144a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * 154a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * See the License for the specific language governing permissions and * 164a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * limitations under the License. * 174a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * * 184a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project *---------------------------------------------------------------------------*/ 194a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project 204a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#ifndef __SR_SEMANTICRESULT_H 214a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#define __SR_SEMANTICRESULT_H 224a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project 234a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project 244a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project 254a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#include "ESR_ReturnCode.h" 264a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#include "SR_SemprocPrefix.h" 274a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project 284a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project/** 294a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * Semantic result. 304a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project */ 314a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Projecttypedef struct SR_SemanticResult_t 324a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project{ 334a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project /** 344a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * Returns number of [key, value] pairs in the current results. 354a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * 364a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * @param self SemanticResult handler 374a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * @param count The number keys 384a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project */ 394a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project ESR_ReturnCode(*getKeyCount)(struct SR_SemanticResult_t* self, size_t* count); 404a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project /** 414a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * Given an array of pointers to <code>LCHAR*</code>, populates that array with pointers 424a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * to the keys used internally by the recognition result. These keys should not be modified! 434a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * 444a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * @param self SemanticResult handler 454a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * @param list [out] List of keys associated with n-best list entry. 464a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * @param size [in/out] Size of list. If the return code is ESR_BUFFER_OVERFLOW, the required size 474a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * is returned in this variable. 484a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project */ 494a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project ESR_ReturnCode(*getKeyList)(struct SR_SemanticResult_t* self, LCHAR** list, size_t* size); 504a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project /** 514a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * Returns copy of semantic value. 524a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * 534a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * @param self SemanticResult handler 544a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * @param key The key to look up 554a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * @param value [out] The buffer used to hold the resulting value 564a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * @param len [in/out] Length of value argument. If the return code is ESR_BUFFER_OVERFLOW, 574a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * the required length is returned in this variable. 584a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project */ 594a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project ESR_ReturnCode(*getValue)(struct SR_SemanticResult_t* self, const LCHAR* key, LCHAR* value, size_t* len); 604a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project /** 614a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * Destroys a semantic result. 624a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * 634a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * @param self SemanticResult handler 644a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project */ 654a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project ESR_ReturnCode(*destroy)(struct SR_SemanticResult_t* self); 664a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project} 674a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source ProjectSR_SemanticResult; 684a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project 694a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project 704a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project/** 714a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * Create a new semantic result. 724a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * 734a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * @param self SemanticResult handle 744a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project */ 754a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source ProjectSREC_SEMPROC_API ESR_ReturnCode SR_SemanticResultCreate(SR_SemanticResult** self); 764a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project/** 774a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * Returns number of [key, value] pairs in the current results. 784a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * 794a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * @param self SemanticResult handler 804a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * @param count The number keys 814a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project */ 824a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source ProjectSREC_SEMPROC_API ESR_ReturnCode SR_SemanticResultGetKeyCount(SR_SemanticResult* self, size_t* count); 834a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project/** 844a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * Given an array of pointers to <code>LCHAR*</code>, populates that array with pointers 854a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * to the keys used internally by the recognition result. These keys should not be modified! 864a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * 874a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * @param self SemanticResult handler 884a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * @param list [out] List of keys associated with n-best list entry. 894a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * @param size [in/out] Size of list. If the return code is ESR_BUFFER_OVERFLOW, the required size 904a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * is returned in this variable. 914a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project */ 924a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source ProjectSREC_SEMPROC_API ESR_ReturnCode SR_SemanticResultGetKeyList(SR_SemanticResult* self, LCHAR** list, 934a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project size_t* size); 944a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project/** 954a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * Returns value component of [key, value] pair. 964a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * 974a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * @param self SemanticResult handler 984a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * @param key The key to look up 994a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * @param value [out] The buffer used to hold the resulting value 1004a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * @param len [in/out] Length of value argument. If the return code is ESR_BUFFER_OVERFLOW, 1014a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * the required length is returned in this variable. 1024a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project */ 1034a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source ProjectSREC_SEMPROC_API ESR_ReturnCode SR_SemanticResultGetValue(SR_SemanticResult* self, const LCHAR* key, LCHAR* value, size_t* len); 1044a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project/** 1054a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * Destroys a semantic result. 1064a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * 1074a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * @param self SemanticResult handler 1084a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project */ 1094a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source ProjectSREC_SEMPROC_API ESR_ReturnCode SR_SemanticResultDestroy(SR_SemanticResult* self); 1104a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project 1114a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project 1124a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#endif /* __SR_SEMANTICRESULT_H */ 113