epoc32/include/mmf/common/speechrecognitiondatacommon.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
child 4 837f303aceeb
permissions -rw-r--r--
Final list of Symbian^2 public API header files
williamr@2
     1
// Copyright (c) 2002-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     2
// All rights reserved.
williamr@2
     3
// This component and the accompanying materials are made available
williamr@2
     4
// under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
williamr@2
     5
// which accompanies this distribution, and is available
williamr@2
     6
// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2
     7
//
williamr@2
     8
// Initial Contributors:
williamr@2
     9
// Nokia Corporation - initial contribution.
williamr@2
    10
//
williamr@2
    11
// Contributors:
williamr@2
    12
//
williamr@2
    13
// Description:
williamr@2
    14
//
williamr@2
    15
williamr@2
    16
#ifndef __SPEECHRECOGNTIONDATACOMMON_H__
williamr@2
    17
#define __SPEECHRECOGNTIONDATACOMMON_H__
williamr@2
    18
williamr@2
    19
//  INCLUDES
williamr@2
    20
#include <e32base.h>
williamr@2
    21
#include <speechrecognitionuids.hrh>
williamr@2
    22
williamr@2
    23
// TYPEDEFS
williamr@2
    24
typedef TUint32 TModelBankID;
williamr@2
    25
typedef TUint32 TModelID;
williamr@2
    26
typedef TUint32 TPhonemeID;
williamr@2
    27
typedef TUint32 TLexiconID;
williamr@2
    28
typedef TUint32 TPronunciationID;
williamr@2
    29
typedef TUint32 TGrammarID;
williamr@2
    30
typedef TUint32 TRuleID;
williamr@2
    31
williamr@2
    32
typedef TInt TSpeechRecognitionEvent;
williamr@2
    33
typedef TInt TSpeechRecognitionResult;
williamr@2
    34
williamr@2
    35
static const TUid KUidMediaTypeASR	      			= {KUidMediaTypeASRDefine};
williamr@2
    36
williamr@2
    37
// CONSTANTS
williamr@2
    38
const TInt KUidAsrEventTrainReadyVal 				= 0x101FBF9E;
williamr@2
    39
const TInt KUidAsrEventTrainVal 					= 0x101FBF9F;
williamr@2
    40
const TInt KUidAsrEventAddPronunciationVal 			= 0x101FBFA0;
williamr@2
    41
const TInt KUidAsrEventAddRuleVal 					= 0x101FBFA1;
williamr@2
    42
const TInt KUidAsrEventLoadModelsVal 				= 0x101FBFA2;
williamr@2
    43
const TInt KUidAsrEventLoadLexiconVal 				= 0x101FBFA3;
williamr@2
    44
const TInt KUidAsrEventLoadGrammarVal 				= 0x101FBFA4;
williamr@2
    45
const TInt KUidAsrEventRecognitionReadyVal 			= 0x101FBFA5;
williamr@2
    46
const TInt KUidAsrEventRecognitionVal 				= 0x101FBFA6;
williamr@2
    47
const TInt KUidAsrEventUnloadRuleVal 				= 0x101FBFA7;
williamr@2
    48
const TInt KUidAsrEventRecordStartedVal 			= 0x101FBFA8;
williamr@2
    49
const TInt KUidAsrEventRecordVal 					= 0x101FBFA9;
williamr@2
    50
const TInt KUidAsrEventEouDetectedVal 				= 0x101FBFAA;
williamr@2
    51
const TInt KUidAsrEventPlayStartedVal	 			= 0x101FBFAB;
williamr@2
    52
const TInt KUidAsrEventPlayVal			 			= 0x101FBFAC;
williamr@2
    53
const TInt KUidAsrEventCreateGrammarVal 			= 0x101FBFAD;
williamr@2
    54
const TInt KUidAsrEventCreateLexiconVal 			= 0x101FBFAE;
williamr@2
    55
const TInt KUidAsrEventCreateModelBankVal 			= 0x101FBFAF;
williamr@2
    56
const TInt KUidAsrEventRemoveGrammarVal 			= 0x101FBFB0;
williamr@2
    57
const TInt KUidAsrEventRemoveLexiconVal 			= 0x101FBFB1;
williamr@2
    58
const TInt KUidAsrEventRemoveModelBankVal 			= 0x101FBFB2;
williamr@2
    59
const TInt KUidAsrEventRemoveRuleVal 				= 0x101FBFB3;
williamr@2
    60
const TInt KUidAsrEventRemovePronunciationVal 		= 0x101FBFB4;
williamr@2
    61
const TInt KUidAsrEventRemoveModelVal 				= 0x101FBFB5;
williamr@2
    62
const TInt KUidAsrEventGetAvailableStorageVal 		= 0x101FBFB6;
williamr@2
    63
const TInt KUidAsrEventGetRuleValidityVal 			= 0x101FBFB7;
williamr@2
    64
const TInt KUidAsrEventGetUtteranceDurationVal 		= 0x101FBFB8;
williamr@2
    65
const TInt KUidAsrEventGetModelCountVal 			= 0x101FBFB9;
williamr@2
    66
const TInt KUidAsrEventGetAllRuleIDsVal 			= 0x101FBFBA;
williamr@2
    67
const TInt KUidAsrEventGetAllPronunciationIDsVal 	= 0x101FBFBB;
williamr@2
    68
const TInt KUidAsrEventGetAllModelIDsVal 			= 0x101FBFBC;
williamr@2
    69
const TInt KUidAsrEventGetAllClientGrammarIDsVal 	= 0x101FBFBD;
williamr@2
    70
const TInt KUidAsrEventGetAllClientLexiconIDsVal 	= 0x101FBFBE;
williamr@2
    71
const TInt KUidAsrEventGetAllClientModelBankIDsVal 	= 0x101FBFBF;
williamr@2
    72
const TInt KUidAsrEventGetAllGrammarIDsVal 			= 0x101FBFC0;
williamr@2
    73
const TInt KUidAsrEventGetAllLexiconIDsVal 			= 0x101FBFC1;
williamr@2
    74
const TInt KUidAsrEventGetAllModelBankIDsVal 		= 0x101FBFC2;
williamr@2
    75
williamr@2
    76
const TUid KUidAsrEventTrainReady 					= {KUidAsrEventTrainReadyVal};
williamr@2
    77
const TUid KUidAsrEventTrain 						= {KUidAsrEventTrainVal};
williamr@2
    78
const TUid KUidAsrEventAddPronunciation 			= {KUidAsrEventAddPronunciationVal};
williamr@2
    79
const TUid KUidAsrEventAddRule 						= {KUidAsrEventAddRuleVal};
williamr@2
    80
const TUid KUidAsrEventLoadModels	 				= {KUidAsrEventLoadModelsVal};
williamr@2
    81
const TUid KUidAsrEventLoadLexicon	 				= {KUidAsrEventLoadLexiconVal};
williamr@2
    82
const TUid KUidAsrEventLoadGrammar	 				= {KUidAsrEventLoadGrammarVal};
williamr@2
    83
const TUid KUidAsrEventRecognitionReady	 			= {KUidAsrEventRecognitionReadyVal};
williamr@2
    84
const TUid KUidAsrEventRecognition	 				= {KUidAsrEventRecognitionVal};
williamr@2
    85
const TUid KUidAsrEventUnloadRule	 				= {KUidAsrEventUnloadRuleVal};
williamr@2
    86
const TUid KUidAsrEventRecordStarted	 			= {KUidAsrEventRecordStartedVal};
williamr@2
    87
const TUid KUidAsrEventRecord	 					= {KUidAsrEventRecordVal};
williamr@2
    88
const TUid KUidAsrEventEouDetected	 				= {KUidAsrEventEouDetectedVal};
williamr@2
    89
const TUid KUidAsrEventPlayStarted	 				= {KUidAsrEventPlayStartedVal};
williamr@2
    90
const TUid KUidAsrEventPlay			 				= {KUidAsrEventPlayVal};
williamr@2
    91
const TUid KUidAsrEventCreateGrammar	 			= {KUidAsrEventCreateGrammarVal};
williamr@2
    92
const TUid KUidAsrEventCreateLexicon	 			= {KUidAsrEventCreateLexiconVal};
williamr@2
    93
const TUid KUidAsrEventCreateModelBank				= {KUidAsrEventCreateModelBankVal};
williamr@2
    94
const TUid KUidAsrEventRemoveGrammar				= {KUidAsrEventRemoveGrammarVal};
williamr@2
    95
const TUid KUidAsrEventRemoveLexicon				= {KUidAsrEventRemoveLexiconVal};
williamr@2
    96
const TUid KUidAsrEventRemoveModelBank				= {KUidAsrEventRemoveModelBankVal};
williamr@2
    97
const TUid KUidAsrEventRemoveRule					= {KUidAsrEventRemoveRuleVal};
williamr@2
    98
const TUid KUidAsrEventRemovePronunciation			= {KUidAsrEventRemovePronunciationVal};
williamr@2
    99
const TUid KUidAsrEventRemoveModel					= {KUidAsrEventRemoveModelVal};
williamr@2
   100
const TUid KUidAsrEventGetAvailableStorage			= {KUidAsrEventGetAvailableStorageVal};
williamr@2
   101
const TUid KUidAsrEventGetRuleValidity				= {KUidAsrEventGetRuleValidityVal};
williamr@2
   102
const TUid KUidAsrEventGetUtteranceDuration			= {KUidAsrEventGetUtteranceDurationVal};
williamr@2
   103
const TUid KUidAsrEventGetModelCount				= {KUidAsrEventGetModelCountVal};
williamr@2
   104
const TUid KUidAsrEventGetAllRuleIDs				= {KUidAsrEventGetAllRuleIDsVal};
williamr@2
   105
const TUid KUidAsrEventGetAllPronunciationIDs		= {KUidAsrEventGetAllPronunciationIDsVal};
williamr@2
   106
const TUid KUidAsrEventGetAllModelIDs				= {KUidAsrEventGetAllModelIDsVal};
williamr@2
   107
const TUid KUidAsrEventGetAllClientGrammarIDs		= {KUidAsrEventGetAllClientGrammarIDsVal};
williamr@2
   108
const TUid KUidAsrEventGetAllClientLexiconIDs		= {KUidAsrEventGetAllClientLexiconIDsVal};
williamr@2
   109
const TUid KUidAsrEventGetAllClientModelBankIDs		= {KUidAsrEventGetAllClientModelBankIDsVal};
williamr@2
   110
const TUid KUidAsrEventGetAllGrammarIDs				= {KUidAsrEventGetAllGrammarIDsVal};
williamr@2
   111
const TUid KUidAsrEventGetAllLexiconIDs				= {KUidAsrEventGetAllLexiconIDsVal};
williamr@2
   112
const TUid KUidAsrEventGetAllModelBankIDs			= {KUidAsrEventGetAllModelBankIDsVal};
williamr@2
   113
williamr@2
   114
// Speech Recognition Errors
williamr@2
   115
const TInt KErrAsrNoSpeech 				= -12050;
williamr@2
   116
const TInt KErrAsrSpeechTooEarly 		= -12051;
williamr@2
   117
const TInt KErrAsrSpeechTooLong 		= -12052;
williamr@2
   118
const TInt KErrAsrSpeechTooShort		= -12053;
williamr@2
   119
const TInt KErrAsrNoMatch				= -12054;
williamr@2
   120
const TInt KErrAsrDataRightViolation	= -12055;
williamr@2
   121
const TInt KErrAsrNotRegisted			= -12056;
williamr@2
   122
const TInt KErrAsrInvalidState			= -12057;
williamr@2
   123
const TInt KErrAsrInitializationFailure	= -12058;
williamr@2
   124
williamr@2
   125
// Pre-defined Engine Parameter Identifiers starts from index 0x01
williamr@2
   126
// User-define Engine Parameter Identifiers starts from index 0x10000 and end at index KMaxTInt.
williamr@2
   127
const TInt KRecognizerMode = 0x01;
williamr@2
   128
const TInt KGrammarSupport = 0x02;
williamr@2
   129
const TInt KLoadMultipleGrammars = 0x03;
williamr@2
   130
const TInt KLoadMultipleLexicons = 0x04;
williamr@2
   131
const TInt KLoadMultipleModelBanks = 0x05;
williamr@2
   132
const TInt KModelStorageCapacity = 0x06;
williamr@2
   133
const TInt KMaxLoadableModels = 0x07;
williamr@2
   134
const TInt KMaxFrontEndBackEndDelay 		= 0x08;
williamr@2
   135
const TInt KSamplingRate 					= 0x09;
williamr@2
   136
const TInt KBitsPerSample 					= 0x0A;
williamr@2
   137
williamr@2
   138
/**
williamr@2
   139
@publishedAll
williamr@2
   140
@released
williamr@2
   141
williamr@2
   142
Speech recognition mode.
williamr@2
   143
*/
williamr@2
   144
enum TRecognitionMode
williamr@2
   145
{
williamr@2
   146
	/** Speaker dependant recognition mode.
williamr@2
   147
	*/
williamr@2
   148
	ESdMode,
williamr@2
   149
	/** Speaker independant recognition mode.
williamr@2
   150
	*/
williamr@2
   151
	ESiMode,
williamr@2
   152
	/** Combined speaker dependant and independant recognition mode.
williamr@2
   153
	*/
williamr@2
   154
	ESdSiMode
williamr@2
   155
};
williamr@2
   156
williamr@2
   157
/**
williamr@2
   158
@publishedAll
williamr@2
   159
@released
williamr@2
   160
williamr@2
   161
Grammar Support.
williamr@2
   162
*/
williamr@2
   163
enum TGrammarSupport
williamr@2
   164
{
williamr@2
   165
	/** Simple grammar support only.
williamr@2
   166
	*/
williamr@2
   167
	ESimpleGrammar,
williamr@2
   168
	/** Full W3C grammar support.
williamr@2
   169
	*/
williamr@2
   170
	EW3CGrammar
williamr@2
   171
};
williamr@2
   172
williamr@2
   173
#endif // __SPEECHRECOGNTIONDATACOMMON_H__