williamr@2: // Copyright (c) 2002-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2: // All rights reserved.
williamr@2: // This component and the accompanying materials are made available
williamr@4: // under the terms of "Eclipse Public License v1.0"
williamr@2: // which accompanies this distribution, and is available
williamr@4: // at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@2: //
williamr@2: // Initial Contributors:
williamr@2: // Nokia Corporation - initial contribution.
williamr@2: //
williamr@2: // Contributors:
williamr@2: //
williamr@2: // Description:
williamr@2: //
williamr@2: 
williamr@2: #ifndef __SPEECHRECOGNITIONUTILITY_H__
williamr@2: #define __SPEECHRECOGNITIONUTILITY_H__
williamr@2: 
williamr@2: // INCLUDES
williamr@2: 
williamr@2: #include <e32base.h>
williamr@2: #include <mmf/common/mmfcontroller.h>
williamr@2: #include <mmf/common/speechrecognitioncustomcommands.h>
williamr@2: #include <mmf/common/speechrecognitiondataclient.h>
williamr@2: #include <speechrecognitionutilityobserver.h>
williamr@2: 
williamr@2: 
williamr@2: // CLASS DECLARATION
williamr@2: 
williamr@2: /**
williamr@2: @publishedAll
williamr@2: @released
williamr@2: 
williamr@2: This is the main class of Speech Recognition Utility.
williamr@2: 
williamr@2: @since  8.0
williamr@2: */
williamr@2: class CSpeechRecognitionUtility : public CBase
williamr@2: 	{
williamr@2: 	class CBody;
williamr@2: public:
williamr@2: 
williamr@2: 	/**
williamr@2: 	Factory function for creating this class.
williamr@2: 
williamr@2: 	@param	aClientUid
williamr@2: 	        The UID of the client.
williamr@2: 	@param 	aSpeechRecognitionUtilityObserver
williamr@2: 	        A reference to the event observer class.
williamr@2: 
williamr@2: 	@return	A pointer to CSpeechRecognitionUtility object
williamr@2: 
williamr@2: 	@since  8.0
williamr@2: 	*/
williamr@2: 	IMPORT_C static CSpeechRecognitionUtility* NewL(
williamr@2: 							MSpeechRecognitionUtilityObserver&
williamr@2: 							aSpeechRecognitionUtilityObserver, TUid aClientUid );
williamr@2: 
williamr@2: 	/**
williamr@2: 	Factory function for creating this class. Leaves a pointer on the cleanup stack.
williamr@2: 
williamr@2: 	@param  aSpeechRecognitionUtilityObserver		
williamr@2: 	        A reference to the event observer class.
williamr@2: 	@param  aClientUid
williamr@2: 	        A client UID for data ownership.
williamr@2: 
williamr@2: 	@return A pointer to a CSpeechRecognitionUtility object.
williamr@2: 
williamr@2: 	@since  8.0
williamr@2: 	*/
williamr@2: 	IMPORT_C static CSpeechRecognitionUtility* NewLC(
williamr@2: 							MSpeechRecognitionUtilityObserver&
williamr@2: 							aSpeechRecognitionUtilityObserver, TUid aClientUid );
williamr@2: 
williamr@2: 	/**
williamr@2: 	Destructor.
williamr@2: 
williamr@2: 	@since  8.0
williamr@2: 	*/
williamr@2: 	IMPORT_C ~CSpeechRecognitionUtility();
williamr@2: 
williamr@2: 	/**
williamr@2: 	Returns the engine properties specified by the engine property
williamr@2: 	ID array. On return aPropertyValue contains an array of engine
williamr@2: 	properties.
williamr@2: 
williamr@2: 	@param  aPropertyId		
williamr@2: 	        A constant reference to an array of engine property ID's.
williamr@2: 	@param  aPropertyValue
williamr@2: 	        A reference to an array of engine property values.
williamr@2: 
williamr@2: 	@return An error code indicating if the function call was successful. KErrNone on success, otherwise
williamr@2: 	        another of the system-wide error codes.
williamr@2: 
williamr@2: 	@since  8.0
williamr@2: 	*/
williamr@2: 	IMPORT_C TInt GetEngineProperties( const RArray<TInt>& aPropertyId,
williamr@2: 		RArray<TInt>& aPropertyValue );
williamr@2: 
williamr@2: 	/**
williamr@2: 	Adds a new pronunciation for the given model into the
williamr@2: 	specified lexicon.
williamr@2: 	
williamr@2: 	@param  aLexiconID			
williamr@2: 	        The lexicon ID, where the new pronunciation is added to.
williamr@2: 	@param  aModelBankID		
williamr@2: 	        The model bank ID.
williamr@2: 	@param	aModelID			
williamr@2: 	        The model ID.
williamr@2: 	@param  aPronunciationID	
williamr@2: 	        A reference where the new pronunciation ID is assigned to.
williamr@2: 
williamr@2: 	@return An error code indicating if the function call was successful. KErrNone on success, otherwise
williamr@2: 	        another of the system-wide error codes.
williamr@2: 
williamr@2: 	@since  8.0
williamr@2: 	*/
williamr@2: 	IMPORT_C TInt AddPronunciation( TLexiconID aLexiconID,
williamr@2: 		TModelBankID aModelBankID, TModelID aModelID,
williamr@2: 		TPronunciationID& aPronunciationID );
williamr@2: 
williamr@2: 	/**
williamr@2: 	Adds a new rule for the given pronunciation into the
williamr@2: 	specified grammar.
williamr@2: 
williamr@2: 	@param  aGrammarID			
williamr@2: 	        The grammar ID, where the new rule is added to.
williamr@2: 	@param  aLexiconID			
williamr@2: 	        The lexicon ID.
williamr@2: 	@param  aPronunciationID	
williamr@2: 	        The pronunciation ID.
williamr@2: 	@param  aRuleID				
williamr@2: 	        A reference where the new rule ID is assigned to.
williamr@2: 
williamr@2: 	@return An error code indicating if the function call was successful. KErrNone on success, otherwise
williamr@2: 	        another of the system-wide error codes.
williamr@2: 
williamr@2: 	@since  8.0
williamr@2: 	*/
williamr@2: 	IMPORT_C TInt AddRule( TGrammarID aGrammarID, TLexiconID aLexiconID,
williamr@2: 		TPronunciationID aPronunciationID, TRuleID& aRuleID );
williamr@2: 
williamr@2: 	/**
williamr@2: 	Cancels the current operation.
williamr@2: 
williamr@2: 	@since 8.0
williamr@2: 	*/
williamr@2: 	IMPORT_C void Cancel();
williamr@2: 
williamr@2: 	/**
williamr@2: 	Commit the current train operation to the database.
williamr@2: 
williamr@2: 	@return An error code indicating if the function call was successful. KErrNone on success, otherwise
williamr@2: 	        another of the system-wide error codes.
williamr@2: 
williamr@2: 	@since  8.0
williamr@2: 	*/
williamr@2: 	IMPORT_C TInt CommitChanges();
williamr@2: 
williamr@2: 	/**
williamr@2: 	Creates a new grammar.
williamr@2: 
williamr@2: 	@param  aGrammarID			
williamr@2: 	        A reference where grammar ID is stored.
williamr@2: 
williamr@2: 	@return An error code indicating if the function call was successful. KErrNone on success, otherwise
williamr@2: 	        another of the system-wide error codes.
williamr@2: 
williamr@2: 	@since  8.0
williamr@2: 	*/
williamr@2: 	IMPORT_C TInt CreateGrammar( TGrammarID& aGrammarID );
williamr@2: 
williamr@2: 	/**
williamr@2: 	Creates a new lexicon.
williamr@2: 
williamr@2: 	@param  aLexiconID			
williamr@2: 	        A reference where lexicon ID is stored.
williamr@2: 
williamr@2: 	@return An error code indicating if the function call was successful. KErrNone on success, otherwise
williamr@2: 	        another of the system-wide error codes.
williamr@2: 
williamr@2: 	@since  8.0
williamr@2: 	*/
williamr@2: 	IMPORT_C TInt CreateLexicon( TLexiconID& aLexiconID );
williamr@2: 
williamr@2: 	/**
williamr@2: 	Loads the specified model bank into the recognizer;
williamr@2: 	done prior to recognition.
williamr@2: 
williamr@2: 	@param  aModelBankID
williamr@2: 			The Model bank ID
williamr@2: 
williamr@2: 	@return An error code indicating if the function call was successful. KErrNone on success, otherwise
williamr@2: 	        another of the system-wide error codes.
williamr@2: 
williamr@2: 	@since  8.0
williamr@2: 	*/
williamr@2: 	IMPORT_C TInt LoadModels( TModelBankID aModelBankID );
williamr@2: 
williamr@2: 	/**
williamr@2: 	Loads the specified grammar into the recognizer;
williamr@2: 	done prior to recognition.
williamr@2: 	
williamr@2: 	@param  aGrammarID			
williamr@2: 	        The grammar ID.
williamr@2: 
williamr@2: 	@return An error code indicating if the function call was successful. KErrNone on success, otherwise
williamr@2: 	        another of the system-wide error codes.
williamr@2: 
williamr@2: 	@since  8.0
williamr@2: 	*/
williamr@2: 	IMPORT_C TInt LoadGrammar( TGrammarID aGrammarID );
williamr@2: 
williamr@2: 	/**
williamr@2: 	Loads the specified lexicon into the recognizer;
williamr@2: 	done prior to recognition.
williamr@2: 
williamr@2: 	@param  aLexiconID			
williamr@2: 	        The lexicon ID.
williamr@2: 
williamr@2: 	@return An error code indicating if the function call was successful. KErrNone on success, otherwise
williamr@2: 	        another of the system-wide error codes.
williamr@2: 
williamr@2: 	@since  8.0
williamr@2: 	*/
williamr@2: 	IMPORT_C TInt LoadLexicon( TLexiconID aLexiconID );
williamr@2: 
williamr@2: 	/**
williamr@2: 	Returns the duration of the utterance for the specified model.
williamr@2: 
williamr@2: 	@param  aModelBankID		
williamr@2: 	        The model bank ID.
williamr@2: 	@param  aModelID			
williamr@2: 	        The model ID.
williamr@2: 	@param  aDuration			
williamr@2: 	        The reference where the duration of utterance is set.
williamr@2: 
williamr@2: 	@return An error code indicating if the function call was successful. KErrNone on success, otherwise
williamr@2: 	        another of the system-wide error codes.
williamr@2: 
williamr@2: 	@since  8.0
williamr@2: 	*/
williamr@2: 	IMPORT_C TInt GetUtteranceDuration( TModelBankID aModelBankID,
williamr@2: 		TModelID aModelID,
williamr@2: 		TTimeIntervalMicroSeconds32& aDuration);
williamr@2: 
williamr@2: 	/**
williamr@2: 	Plays the previously trained utterance.
williamr@2: 
williamr@2: 	@param  aModelBankID
williamr@2: 	        The model bank ID.
williamr@2: 	@param  aModelID
williamr@2: 	        The model ID, whose utterance is played.
williamr@2: 
williamr@2: 	@return An error code indicating if the function call was successful. KErrNone on success, otherwise
williamr@2: 	        another of the system-wide error codes.
williamr@2: 
williamr@2: 	@since  8.0
williamr@2: 	*/
williamr@2: 	IMPORT_C TInt PlayUtterance( TModelBankID aModelBankID,
williamr@2: 		TModelID aModelID);
williamr@2: 
williamr@2: 	/**
williamr@2: 	Returns the number of models in the specified model bank.
williamr@2: 
williamr@2: 	@param  aModelBankID		
williamr@2: 	        The model bank ID.
williamr@2: 	@param  aModelCount			
williamr@2: 	        The reference where the number of models is set.
williamr@2: 
williamr@2: 	@return An error code indicating if the function call was successful. KErrNone on success, otherwise
williamr@2: 	        another of the system-wide error codes.
williamr@2: 
williamr@2: 	@since  8.0
williamr@2: 	*/
williamr@2: 	IMPORT_C TInt GetModelCount( TModelBankID aModelBankID, TInt& aModelCount );
williamr@2: 
williamr@2: 	/**
williamr@2: 	Ends the current recognition session. Resources allocated
williamr@2: 	for recognition are freed.
williamr@2: 
williamr@2: 	@return An error code indicating if the function call was successful. KErrNone on success, otherwise
williamr@2: 	        another of the system-wide error codes.
williamr@2: 
williamr@2: 	@since  8.0
williamr@2: 	*/
williamr@2: 	IMPORT_C TInt EndRecSession();
williamr@2: 
williamr@2: 	/**
williamr@2: 	Starts a new recognition session.
williamr@2: 
williamr@2: 	@param  aMode				
williamr@2: 	        The recognition mode.
williamr@2: 
williamr@2: 	@return An error code indicating if the function call was successful. KErrNone on success, otherwise
williamr@2: 	        another of the system-wide error codes.
williamr@2: 
williamr@2: 	@since  8.0
williamr@2: 	*/
williamr@2: 	IMPORT_C TInt StartRecSession( TRecognitionMode aMode );
williamr@2: 
williamr@2: 	/**
williamr@2: 	Initiates recognition; performed following loading of
williamr@2: 	model bank, lexicon, and grammar.
williamr@2: 
williamr@2: 	@param  aResultSet			
williamr@2: 	        A reference where the recognition result is set.
williamr@2: 
williamr@2: 	@return An error code indicating if the function call was successful. KErrNone on success, otherwise
williamr@2: 	        another of the system-wide error codes.
williamr@2: 
williamr@2: 	@since  8.0
williamr@2: 	*/
williamr@2: 	IMPORT_C TInt Recognize( CSDClientResultSet& aResultSet );
williamr@2: 
williamr@2: 	/**
williamr@2: 	Records user utterance for training and recognition.
williamr@2: 
williamr@2: 	@param  aRecordTime			
williamr@2: 	        The recording time in microseconds.
williamr@2: 
williamr@2: 	@return An error code indicating if the function call was successful. KErrNone on success, otherwise
williamr@2: 	        another of the system-wide error codes.
williamr@2: 
williamr@2: 	@since  8.0
williamr@2: 	*/
williamr@2: 	IMPORT_C TInt Record( TTimeIntervalMicroSeconds32 aRecordTime );
williamr@2: 
williamr@2: 	/**
williamr@2: 	Removes the specified grammar from the permanent storage. 
williamr@2: 
williamr@2: 	Removing a grammar will remove all rules within the grammar.
williamr@2: 
williamr@2: 	@param  aGrammarID			
williamr@2: 	        The grammar ID.
williamr@2: 
williamr@2: 	@return An error code indicating if the function call was successful. KErrNone on success, otherwise
williamr@2: 	        another of the system-wide error codes.
williamr@2: 
williamr@2: 	@since  8.0
williamr@2: 	*/
williamr@2: 	IMPORT_C TInt RemoveGrammar( TGrammarID aGrammarID );
williamr@2: 
williamr@2: 	/**
williamr@2: 	Removes the specified pronunciation from the specified lexicon permanently.
williamr@2: 
williamr@2: 	@param  aLexiconID			
williamr@2: 	        The lexicon ID.
williamr@2: 	@param  aPronunciationID	
williamr@2: 	        The pronunciation ID.
williamr@2: 
williamr@2: 	@return An error code indicating if the function call was successful. KErrNone on success, otherwise
williamr@2: 	        another of the system-wide error codes.
williamr@2: 
williamr@2: 	@since  8.0
williamr@2: 	*/
williamr@2: 	IMPORT_C TInt RemovePronunciation( TLexiconID aLexiconID,
williamr@2: 		TPronunciationID aPronunciationID );
williamr@2: 
williamr@2: 	/**
williamr@2: 	Removes the specified lexicon from the permanent storage.
williamr@2: 	
williamr@2: 	Removing a lexicon will remove all pronunciations within the lexicon.
williamr@2: 
williamr@2: 	@param  aLexiconID			
williamr@2: 	        The lexicon ID.
williamr@2: 
williamr@2: 	@return An error code indicating if the function call was successful. KErrNone on success, otherwise
williamr@2: 	        another of the system-wide error codes.
williamr@2: 
williamr@2: 	@since  8.0
williamr@2: 	*/
williamr@2: 	IMPORT_C TInt RemoveLexicon( TLexiconID aLexiconID );
williamr@2: 
williamr@2: 	/**
williamr@2: 	Removes the specified model from the specified model bank
williamr@2: 	permanently.
williamr@2: 
williamr@2: 	@param  aModelBankID		
williamr@2: 	        The model bank ID.
williamr@2: 	@param  aModelID			
williamr@2: 	        The model ID.
williamr@2: 
williamr@2: 	@return An error code indicating if the function call was successful. KErrNone on success, otherwise
williamr@2: 	        another of the system-wide error codes.
williamr@2: 
williamr@2: 	@since  8.0
williamr@2: 	*/
williamr@2: 	IMPORT_C TInt RemoveModel( TModelBankID aModelBankID,
williamr@2: 		TModelID aModelID );
williamr@2: 
williamr@2: 	/**
williamr@2: 	Removes the specified rule from the specified grammar permanently.
williamr@2: 
williamr@2: 	@param  aGrammarID			
williamr@2: 	        The grammar ID.
williamr@2: 	@param  aRuleID
williamr@2: 	        The rule ID.
williamr@2: 
williamr@2: 	@return An error code indicating if the function call was successful. KErrNone on success, otherwise
williamr@2: 	        another of the system-wide error codes.
williamr@2: 
williamr@2: 	@since  8.0
williamr@2: 	*/
williamr@2: 	IMPORT_C TInt RemoveRule( TGrammarID aGrammarID, TRuleID aRuleID );
williamr@2: 
williamr@2: 	/**
williamr@2: 	Trains a new model into the specified model bank.
williamr@2: 
williamr@2: 	@param  aModelBankID		
williamr@2: 	        The model bank ID.
williamr@2: 	@param  aModelID			
williamr@2: 	        A reference where a new model ID is assigned to.
williamr@2: 
williamr@2: 	@return An error code indicating if the function call was successful. KErrNone on success, otherwise
williamr@2: 	        another of the system-wide error codes.
williamr@2: 
williamr@2: 	@since  8.0
williamr@2: 	*/
williamr@2: 	IMPORT_C TInt Train( TModelBankID aModelBankID, TModelID& aModelID );
williamr@2: 
williamr@2: 	/**
williamr@2: 	Unloads the specified rule from the specified grammar in temporary memory, previously loaded 
williamr@2: 	with LoadGrammarL.
williamr@2: 
williamr@2: 	The rule in the permanent storage remains intact.
williamr@2: 
williamr@2: 	@param  aGrammarID			
williamr@2: 	        The grammar ID.
williamr@2: 	@param  aRuleID				
williamr@2: 	        The rule ID.
williamr@2: 
williamr@2: 	@return An error code indicating if the function call was successful. KErrNone on success, otherwise
williamr@2: 	        another of the system-wide error codes.
williamr@2: 
williamr@2: 	@since  8.0
williamr@2: 	*/
williamr@2: 	IMPORT_C TInt UnloadRule( TGrammarID aGrammarID, TRuleID aRuleID );
williamr@2: 
williamr@2: 	/**
williamr@2: 	Sets the event handler for asynchronous events.
williamr@2: 
williamr@2: 	@param  aSpeechRecognitionUtilityObserver		
williamr@2: 	        A pointer to an observer.
williamr@2: 
williamr@2: 	@since  8.0
williamr@2: 	*/
williamr@2: 	IMPORT_C void SetEventHandler( MSpeechRecognitionUtilityObserver*
williamr@2: 		aSpeechRecognitionUtilityObserver );
williamr@2: 
williamr@2: 	/**
williamr@2: 	Returns all pronunciation IDs that exist in the specified lexicon.
williamr@2: 
williamr@2: 	@param  aLexiconID
williamr@2: 	        The lexicon ID.
williamr@2: 	@param  aPronunciationIDs
williamr@2: 	        A reference where pronunciation IDs are stored.
williamr@2: 
williamr@2: 	@return An error code indicating if the function call was successful. KErrNone on success, otherwise
williamr@2: 	        another of the system-wide error codes.
williamr@2: 
williamr@2: 	@since  8.0
williamr@2: 	*/
williamr@2: 	IMPORT_C TInt GetAllPronunciationIDs( TLexiconID aLexiconID,
williamr@2: 		RArray <TPronunciationID>& aPronunciationIDs );
williamr@2: 
williamr@2: 	/**
williamr@2: 	Returns all grammar IDs owned by the client.
williamr@2: 
williamr@2: 	@param  aGrammarIDs			
williamr@2: 	        A reference where rule IDs are stored.
williamr@2: 
williamr@2: 	@return An error code indicating if the function call was successful. KErrNone on success, otherwise
williamr@2: 	        another of the system-wide error codes.
williamr@2: 
williamr@2: 	@since  8.0
williamr@2: 	*/
williamr@2: 	IMPORT_C TInt GetAllClientGrammarIDs(RArray <TGrammarID>& aGrammarIDs );
williamr@2: 
williamr@2: 	/**
williamr@2: 	Returns all lexicons owned by the client.
williamr@2: 
williamr@2: 	@param  aLexiconIDs	
williamr@2: 	        A reference where lexicon IDs are stored.
williamr@2: 
williamr@2: 	@return An error code indicating if the function call was successful. KErrNone on success, otherwise
williamr@2: 	        another of the system-wide error codes.
williamr@2: 
williamr@2: 	@since  8.0
williamr@2: 	*/
williamr@2: 	IMPORT_C TInt GetAllClientLexiconIDs(RArray <TLexiconID>& aLexiconIDs );
williamr@2: 
williamr@2: 	/**
williamr@2: 	Returns all modelbank IDs owned by the client.
williamr@2: 
williamr@2: 	@param  aModelBankIDs			
williamr@2: 	        A reference where modelbank IDs are stored.
williamr@2: 
williamr@2: 	@return An error code indicating if the function call was successful. KErrNone on success, otherwise
williamr@2: 	        another of the system-wide error codes.
williamr@2: 
williamr@2: 	@since  8.0
williamr@2: 	*/
williamr@2: 		IMPORT_C TInt GetAllClientModelBankIDs(
williamr@2: 							RArray<TModelBankID>& aModelBankIDs );
williamr@2: 	/**
williamr@2: 	Returns all grammar IDs.
williamr@2: 
williamr@2: 	@param  aGrammarIDs			
williamr@2: 	        A reference where rule IDs are stored.
williamr@2: 
williamr@2: 	@return An error code indicating if the function call was successful. KErrNone on success, otherwise
williamr@2: 	        another of the system-wide error codes.
williamr@2: 
williamr@2: 	@since  8.0
williamr@2: 	*/
williamr@2: 	IMPORT_C TInt GetAllGrammarIDs(RArray <TGrammarID>& aGrammarIDs );
williamr@2: 	
williamr@2: 	/**
williamr@2: 	Returns all lexicons IDs.
williamr@2: 
williamr@2: 	@param  aLexiconIDs	
williamr@2: 	        A reference where lexicon IDs are stored.
williamr@2: 
williamr@2: 	@return An error code indicating if the function call was successful. KErrNone on success, otherwise
williamr@2: 	        another of the system-wide error codes.
williamr@2: 
williamr@2: 	@since  8.0
williamr@2: 	*/
williamr@2: 	IMPORT_C TInt GetAllLexiconIDs(RArray <TLexiconID>& aLexiconIDs );
williamr@2: 
williamr@2: 	/**
williamr@2: 	Returns all modelbank IDs.
williamr@2: 
williamr@2: 	@param  aModelBankIDs			
williamr@2: 	        A reference where modelbank IDs are stored.
williamr@2: 
williamr@2: 	@return An error code indicating if the function call was successful. KErrNone on success, otherwise
williamr@2: 	        another of the system-wide error codes.
williamr@2: 
williamr@2: 	@since  8.0
williamr@2: 	*/
williamr@2: 	IMPORT_C TInt GetAllModelBankIDs(
williamr@2: 		RArray<TModelBankID>& aModelBankIDs );
williamr@2: 
williamr@2: 	/**
williamr@2: 	Returns all model IDs that exist in the specified model bank.
williamr@2: 
williamr@2: 	@param  aModelBankID		
williamr@2: 	        The model bank ID.
williamr@2: 	@param  aModelIDs			
williamr@2: 	        A reference where model IDs are stored.
williamr@2: 
williamr@2: 	@return An error code indicating if the function call was successful. KErrNone on success, otherwise
williamr@2: 	        another of the system-wide error codes.
williamr@2: 
williamr@2: 	@since  8.0
williamr@2: 	*/
williamr@2: 	IMPORT_C TInt GetAllModelIDs( TModelBankID aModelBankID,
williamr@2: 		RArray <TModelID>& aModelIDs );
williamr@2: 
williamr@2: 	/**
williamr@2: 	Checks if the rule is valid or not.
williamr@2: 
williamr@2: 	@param  aGrammarID
williamr@2: 	        The grammar ID.
williamr@2: 	@param	aRuleID
williamr@2: 			The rule ID.
williamr@2: 	@param  aValid
williamr@2: 	        A reference where the validity of the rule is set.
williamr@2: 
williamr@2: 	@return An error code indicating if the function call was successful. KErrNone on success, otherwise
williamr@2: 	        another of the system-wide error codes.
williamr@2: 
williamr@2: 	@since  8.0
williamr@2: 	*/
williamr@2: 	IMPORT_C TInt GetRuleValidity( TGrammarID aGrammarID, TRuleID aRuleID,
williamr@2: 		TBool& aValid );
williamr@2: 
williamr@2: 	/**
williamr@2: 	Returns all rule IDs that exist in the specified grammar.
williamr@2: 
williamr@2: 	@param  aGrammarID			
williamr@2: 	        The grammar ID.
williamr@2: 	@param  aRuleIDs			
williamr@2: 	        A reference where rule IDs are stored.
williamr@2: 
williamr@2: 	@return An error code indicating if the function call was successful. KErrNone on success, otherwise
williamr@2: 	        another of the system-wide error codes.
williamr@2: 
williamr@2: 	@since  8.0
williamr@2: 	*/
williamr@2: 	IMPORT_C TInt GetAllRuleIDs( TGrammarID aGrammarID,
williamr@2: 		RArray <TRuleID>& aRuleIDs );
williamr@2: 
williamr@2: 	/**
williamr@2: 	Creates a new model bank.
williamr@2: 
williamr@2: 	@param  aModelBankID		
williamr@2: 	        A reference where a new model bank IF is assigned to.
williamr@2: 
williamr@2: 	@return An error code indicating if the function call was successful. KErrNone on success, otherwise
williamr@2: 	        another of the system-wide error codes.
williamr@2: 
williamr@2: 	@since  8.0
williamr@2: 	*/
williamr@2: 	IMPORT_C TInt CreateModelBank( TModelBankID& aModelBankID );
williamr@2: 
williamr@2: 	/**
williamr@2: 	Removes the specified model bank from the permanent storage.
williamr@2: 
williamr@2: 	Removing a model bank will remove all models within the model bank.
williamr@2: 
williamr@2: 	@param  aModelBankID		
williamr@2: 	        The model bank ID.
williamr@2: 
williamr@2: 	@return An error code indicating if the function call was successful. KErrNone on success, otherwise
williamr@2: 	        another of the system-wide error codes.
williamr@2: 
williamr@2: 	@since	8.0
williamr@2: 	*/
williamr@2: 	IMPORT_C TInt RemoveModelBank( TModelBankID aModelBankID );
williamr@2: 
williamr@2: 	/**
williamr@2: 	Returns the number of models available for training system model storage, based on available 
williamr@2: 	disk space.
williamr@2: 
williamr@2: 	@param  aAvailableStorage	
williamr@2: 	        The number of models that can be contained in available storage.
williamr@2: 
williamr@2: 	@return An error code indicating if the function call was successful. KErrNone on success, otherwise
williamr@2: 	        another of the system-wide error codes.
williamr@2: 
williamr@2: 	@since  8.0
williamr@2: 	*/
williamr@2: 	IMPORT_C TInt GetAvailableStorage( TInt& aAvailableStorage );
williamr@2: 
williamr@2: 	/**
williamr@2: 	Loads the specified parameters into the recognition engine.
williamr@2: 
williamr@2: 	@param  aParameterId		
williamr@2: 	        The array of parameter IDs.
williamr@2: 	@param  aParameterValue		
williamr@2: 	        The array of parameter values.
williamr@2: 
williamr@2: 	@return An error code indicating if the function call was successful. KErrNone on success, otherwise
williamr@2: 	        another of the system-wide error codes.
williamr@2: 
williamr@2: 	@since  8.0
williamr@2: 	*/
williamr@2: 	IMPORT_C TInt LoadEngineParameters( const RArray<TInt>& aParameterId,
williamr@2: 					const RArray<TInt>& aParameterValue );
williamr@2: 
williamr@2: 	/**
williamr@2: 	Sets the audio priority and preference for train, playback and recognition.
williamr@2: 
williamr@2: 	@param  aPriority				
williamr@2: 	        The priority for voice recognition.
williamr@2: 	@param  aTrainPreference		
williamr@2: 	        The preference for training.
williamr@2: 	@param  aPlaybackPreference		
williamr@2: 	        The preference for playback.
williamr@2: 	@param  aRecognitionPreference	
williamr@2: 	        The preference for recognition.
williamr@2: 
williamr@2: 	@return An error code indicating if the function call was successful. KErrNone on success, otherwise
williamr@2: 	        another of the system-wide error codes.
williamr@2: 
williamr@2: 	@since  8.0
williamr@2: 
williamr@2: 	*/
williamr@2: 	IMPORT_C TInt SetAudioPriority( TInt aPriority, TInt aTrainPreference,
williamr@2: 		TInt aPlaybackPreference, TInt aRecognitionPreference );
williamr@2: 
williamr@2: private:
williamr@2: 	/**
williamr@2: 	Private C++ constructor for this class.
williamr@2: 
williamr@2: 	@since  8.0
williamr@2: 	*/
williamr@2: 	CSpeechRecognitionUtility();
williamr@2: 
williamr@2: 	/**
williamr@2: 	Second phase constructor for this class.
williamr@2: 
williamr@2: 	@param  aSpeechRecognitionUtilityObserver		
williamr@2: 	        A reference to the event observer class.
williamr@2: 
williamr@2: 	@since  8.0
williamr@2: 	*/
williamr@2: 	void ConstructL(MSpeechRecognitionUtilityObserver& aSpeechRecognitionUtilityObserver);
williamr@2: 
williamr@2: private:
williamr@2: 	CBody* iBody;
williamr@2: 	friend class CBody;
williamr@2: };
williamr@2: 
williamr@2: #endif	// of __SPEECHRECOGNITIONUTILITY_H__
williamr@2: 
williamr@2: 	// End of File