MSpeechRecognitionCustomCommandImplementor Class Reference

#include <mmf/common/speechrecognitioncustomcommandimplementor.h>

class MSpeechRecognitionCustomCommandImplementor

Public Member Functions
pure virtual void	MSrAddPronunciationL(TLexiconID, TModelBankID, TModelID, TPronunciationID &)
pure virtual void	MSrAddRuleL(TGrammarID, TLexiconID, TPronunciationID, TRuleID &)
pure virtual void	MSrCancel()
pure virtual void	MSrCommitChangesL()
pure virtual void	MSrCreateGrammarL(TGrammarID &)
pure virtual void	MSrCreateLexiconL(TLexiconID &)
pure virtual void	MSrCreateModelBankL(TModelBankID &)
pure virtual void	MSrEndRecSessionL()
pure virtual void	MSrGetAllClientGrammarIDsL(RArray< TGrammarID > &)
pure virtual void	MSrGetAllClientLexiconIDsL(RArray< TLexiconID > &)
pure virtual void	MSrGetAllClientModelBankIDsL(RArray< TModelBankID > &)
pure virtual void	MSrGetAllGrammarIDsL(RArray< TGrammarID > &)
pure virtual void	MSrGetAllLexiconIDsL(RArray< TLexiconID > &)
pure virtual void	MSrGetAllModelBankIDsL(RArray< TModelBankID > &)
pure virtual void	MSrGetAllModelIDsL(TModelBankID, RArray< TModelID > &)
pure virtual void	MSrGetAllPronunciationIDsL(TLexiconID, RArray< TPronunciationID > &)
pure virtual void	MSrGetAllRuleIDsL(TGrammarID, RArray< TRuleID > &)
pure virtual void	MSrGetAvailableStorageL(TInt &)
pure virtual void	MSrGetEnginePropertiesL(const RArray< TInt > &, RArray< TInt > &)
pure virtual void	MSrGetModelCountL(TModelBankID, TInt &)
pure virtual void	MSrGetRuleValidityL(TGrammarID, TRuleID, TBool &)
pure virtual void	MSrGetUtteranceDurationL(TModelBankID, TModelID, TTimeIntervalMicroSeconds32 &)
pure virtual void	MSrLoadEngineParametersL(const RArray< TInt > &, const RArray< TInt > &)
pure virtual void	MSrLoadGrammarL(TGrammarID)
pure virtual void	MSrLoadLexiconL(TLexiconID)
pure virtual void	MSrLoadModelsL(TModelBankID)
pure virtual void	MSrPlayUtteranceL(TModelBankID, TModelID)
pure virtual void	MSrRecognizeL(CSDClientResultSet &)
pure virtual void	MSrRecordL(TTimeIntervalMicroSeconds32)
pure virtual void	MSrRemoveGrammarL(TGrammarID)
pure virtual void	MSrRemoveLexiconL(TLexiconID)
pure virtual void	MSrRemoveModelBankL(TModelBankID)
pure virtual void	MSrRemoveModelL(TModelBankID, TModelID)
pure virtual void	MSrRemovePronunciationL(TLexiconID, TPronunciationID)
pure virtual void	MSrRemoveRuleL(TGrammarID, TRuleID)
pure virtual void	MSrSetClientUid(TUid)
pure virtual void	MSrStartRecSessionL(TRecognitionMode)
pure virtual void	MSrTrainL(TModelBankID, TModelID &)
pure virtual void	MSrUnloadRuleL(TGrammarID, TRuleID)

Detailed Description

This is the main class of Speech Recognition Custom Commands Implementor.

Since: 8.0

Member Function Documentation

MSrAddPronunciationL ( TLexiconID, TModelBankID, TModelID, TPronunciationID & )

void	MSrAddPronunciationL	(	TLexiconID	aLexiconID,
			TModelBankID	aModelBankID,
			TModelID	aModelID,
			TPronunciationID &	aPronunciationID
		)	[pure virtual]

Adds a new pronunciation for the given model into the specified lexicon.

Since: 8.0

Parameters
aLexiconID	The lexicon ID to where the new pronunciation is added.
aModelBankID	The model bank ID.
aModelID	The model ID.
aPronunciationID	A reference to where a new pronunciation ID is assigned.

MSrAddRuleL ( TGrammarID, TLexiconID, TPronunciationID, TRuleID & )

void	MSrAddRuleL	(	TGrammarID	aGrammarID,
			TLexiconID	aLexiconID,
			TPronunciationID	aPronunciationID,
			TRuleID &	aRuleID
		)	[pure virtual]

Adds a new rule for the given pronunciation into the specified grammar.

Since: 8.0

Parameters
aGrammarID	The grammar ID, where the new rule is added to
aLexiconID	The lexicon ID.
aPronunciationID	The pronunciation ID.
aRuleID	A reference where a new rule ID is assigned to.

MSrCancel ( )

void

MSrCancel

(

)

[pure virtual]

Cancels the current operation.

Since: 8.0

MSrCommitChangesL ( )

void

MSrCommitChangesL

(

)

[pure virtual]

Commit uncommited changes to the database.

Since: 8.0

MSrCreateGrammarL ( TGrammarID & )

void

MSrCreateGrammarL

(

TGrammarID &

aGrammarID

)

[pure virtual]

Creates a new grammar.

Since: 8.0

Parameters
aGrammarID	A reference where the grammar ID is stored.

MSrCreateLexiconL ( TLexiconID & )

void

MSrCreateLexiconL

(

TLexiconID &

aLexiconID

)

[pure virtual]

Creates a new lexicon.

Since: 8.0

Parameters
aLexiconID	A reference where the lexicon ID is stored.

MSrCreateModelBankL ( TModelBankID & )

void

MSrCreateModelBankL

(

TModelBankID &

aModelBankID

)

[pure virtual]

Creates a new model bank.

Since: 8.0

Parameters
aModelBankID	A reference to where a new model bank ID is assigned.

MSrEndRecSessionL ( )

void

MSrEndRecSessionL

(

)

[pure virtual]

Ends the current recognition session. Resources allocated for recognition are freed.

Since: 8.0

MSrGetAllClientGrammarIDsL ( RArray< TGrammarID > & )

void

MSrGetAllClientGrammarIDsL

(

RArray< TGrammarID > &

aGrammarIDs

)

[pure virtual]

Returns all grammar IDs that are owned by the client.

Since: 8.0

Parameters
aGrammarIDs	A reference where grammar IDs are stored.

MSrGetAllClientLexiconIDsL ( RArray< TLexiconID > & )

void

MSrGetAllClientLexiconIDsL

(

RArray< TLexiconID > &

aLexiconIDs

)

[pure virtual]

Returns all lexicon IDs that are owned by the client.

Since: 8.0

Parameters
aLexiconIDs	A reference where the lexicon IDs are stored.

MSrGetAllClientModelBankIDsL ( RArray< TModelBankID > & )

void

MSrGetAllClientModelBankIDsL

(

RArray< TModelBankID > &

aModelBankIDs

)

[pure virtual]

Returns all modelbank IDs that are owned by the client.

Since: 8.0

Parameters
aModelBankIDs	A reference where model bank IDs are stored.

MSrGetAllGrammarIDsL ( RArray< TGrammarID > & )

void

MSrGetAllGrammarIDsL

(

RArray< TGrammarID > &

aGrammarIDs

)

[pure virtual]

Returns all grammar IDs.

Parameters
aGrammarIDs	A reference where grammar IDs are stored.

MSrGetAllLexiconIDsL ( RArray< TLexiconID > & )

void

MSrGetAllLexiconIDsL

(

RArray< TLexiconID > &

aLexiconIDs

)

[pure virtual]

Returns all lexicon IDs.

Parameters
aLexiconIDs	A reference where lexicon IDs are stored.

MSrGetAllModelBankIDsL ( RArray< TModelBankID > & )

void

MSrGetAllModelBankIDsL

(

RArray< TModelBankID > &

aModelBankIDs

)

[pure virtual]

Returns all modelbank IDs.

Since: 8.0

Parameters
aModelBankIDs	A reference where the model bank IDs are stored.

MSrGetAllModelIDsL ( TModelBankID, RArray< TModelID > & )

void	MSrGetAllModelIDsL	(	TModelBankID	aModelBankID,
			RArray< TModelID > &	aModelIDs
		)	[pure virtual]

Returns all model IDs that exist in the specified model bank.

Since: 8.0

Parameters
aModelBankID	The model bank ID.
aModelIDs	A reference where model IDs are stored.

MSrGetAllPronunciationIDsL ( TLexiconID, RArray< TPronunciationID > & )

void	MSrGetAllPronunciationIDsL	(	TLexiconID	aLexiconID,
			RArray< TPronunciationID > &	aPronunciationIDs
		)	[pure virtual]

Returns all pronunciation IDs that exist in the specified lexicon.

Since: 8.0

Parameters
aLexiconID	The lexicon ID.
aPronunciationIDs	A reference where pronunciation IDs are stored.

MSrGetAllRuleIDsL ( TGrammarID, RArray< TRuleID > & )

void	MSrGetAllRuleIDsL	(	TGrammarID	aGrammarID,
			RArray< TRuleID > &	aRuleIDs
		)	[pure virtual]

Returns all rule IDs that exist in the specified grammar.

Since: 8.0

Parameters
aGrammarID	The grammar ID.
aRuleIDs	A reference where rule IDs are stored.

MSrGetAvailableStorageL ( TInt & )

void

MSrGetAvailableStorageL

(

TInt &

aCount

)

[pure virtual]

Returns the number of models available for training system wide, based on available disk space.

Since: 8.0

Parameters
aCount	A reference where the number of available models is set.

MSrGetEnginePropertiesL ( const RArray< TInt > &, RArray< TInt > & )

void	MSrGetEnginePropertiesL	(	const RArray< TInt > &	aPropertyId,
			RArray< TInt > &	aPropertyValue
		)	[pure virtual]

Returns the engine properties specified by the engine property ID array.

On return aPropertyValue contains an array of engine properties.

Since: 8.0

Parameters
aPropertyId	A constant reference to an array of engine property IDs.
aPropertyValue	A reference to an array of engine property values.

MSrGetModelCountL ( TModelBankID, TInt & )

void	MSrGetModelCountL	(	TModelBankID	aModelBankID,
			TInt &	aCount
		)	[pure virtual]

Returns the number of models in the specified model bank.

Since: 8.0

Parameters
aModelBankID	The model bank ID.
aCount	A reference where the number of models is set.

MSrGetRuleValidityL ( TGrammarID, TRuleID, TBool & )

void	MSrGetRuleValidityL	(	TGrammarID	aGrammarID,
			TRuleID	aRuleID,
			TBool &	aValid
		)	[pure virtual]

Checks if the rule is valid or not.

Since: 8.0

Parameters
aGrammarID	The grammar ID.
aRuleID	The rule ID.
aValid	A reference where the validity of the rule is set.

MSrGetUtteranceDurationL ( TModelBankID, TModelID, TTimeIntervalMicroSeconds32 & )

void	MSrGetUtteranceDurationL	(	TModelBankID	aModelBankID,
			TModelID	aModelID,
			TTimeIntervalMicroSeconds32 &	aDuration
		)	[pure virtual]

Returns the duration of the utterance for the specified model.

Since: 8.0

Parameters
aModelBankID	The model bank ID.
aModelID	The model ID.
aDuration	A reference where the duration of utterance is set.

MSrLoadEngineParametersL ( const RArray< TInt > &, const RArray< TInt > & )

void	MSrLoadEngineParametersL	(	const RArray< TInt > &	aParameterId,
			const RArray< TInt > &	aParameterValue
		)	[pure virtual]

Unloads the specified parameters to the engine.

Since: 8.0

Parameters
aParameterId	An array of parameter IDs.
aParameterValue	An array of parameter values.

MSrLoadGrammarL ( TGrammarID )

void

MSrLoadGrammarL

(

TGrammarID

aGrammarID

)

[pure virtual]

Loads the specified grammar in into the recognizer; done prior to recognition.

Since: 8.0

Parameters
aGrammarID	The grammar ID.

MSrLoadLexiconL ( TLexiconID )

void

MSrLoadLexiconL

(

TLexiconID

aLexiconID

)

[pure virtual]

Loads the specified lexicon into the recognizer; done prior to recognition.

Since: 8.0

Parameters
aLexiconID	The lexicon ID.

MSrLoadModelsL ( TModelBankID )

void

MSrLoadModelsL

(

TModelBankID

aModelBankID

)

[pure virtual]

Loads the specified model bank into the recognizer; done prior to recognition.

Since: 8.0

Parameters
aModelBankID	The model bank ID.

MSrPlayUtteranceL ( TModelBankID, TModelID )

void	MSrPlayUtteranceL	(	TModelBankID	aModelBankID,
			TModelID	aModelID
		)	[pure virtual]

Plays the previously trained utterance.

Since: 8.0

Parameters
aModelBankID	The model bank ID.
aModelID	The model ID, whose utterance is played.

MSrRecognizeL ( CSDClientResultSet & )

void

MSrRecognizeL

(

CSDClientResultSet &

aResultSet

)

[pure virtual]

Initiates recognition; performed following loading of model bank, lexicon, and grammar.

Since: 8.0

Parameters
aResultSet	A reference where the recognition result is set.

MSrRecordL ( TTimeIntervalMicroSeconds32 )

void

MSrRecordL

(

TTimeIntervalMicroSeconds32

aRecordTime

)

[pure virtual]

Records user utterance for training and recognition.

Since: 8.0

Parameters
aRecordTime	A recording time in microseconds.

MSrRemoveGrammarL ( TGrammarID )

void

MSrRemoveGrammarL

(

TGrammarID

aGrammarID

)

[pure virtual]

Removes the specified grammar from the permanent storage.

Removing a grammar will remove all rules within the grammar.

Since: 8.0

Parameters
aGrammarID	The grammar ID.

MSrRemoveLexiconL ( TLexiconID )

void

MSrRemoveLexiconL

(

TLexiconID

aLexiconID

)

[pure virtual]

Removes the specified lexicon from the permanent storage.

Removing a lexicon will remove all pronunciations within the lexicon.

Since: 8.0

Parameters
aLexiconID	The lexicon ID.

MSrRemoveModelBankL ( TModelBankID )

void

MSrRemoveModelBankL

(

TModelBankID

aModelBankID

)

[pure virtual]

Removes the specified model bank from the permanent storage.

Removing a model bank will remove all models within the model bank.

Since: 8.0

Parameters
aModelBankID	The model bank ID.

MSrRemoveModelL ( TModelBankID, TModelID )

void	MSrRemoveModelL	(	TModelBankID	aModelBankID,
			TModelID	aModelID
		)	[pure virtual]

Removes the specified model from the specified model bank permanently.

Since: 8.0

Parameters
aModelBankID	The model bank ID.
aModelID	The model ID.

MSrRemovePronunciationL ( TLexiconID, TPronunciationID )

void	MSrRemovePronunciationL	(	TLexiconID	aLexiconID,
			TPronunciationID	aPronunciationID
		)	[pure virtual]

Removes the specified pronunciation from the specified lexicon permanently.

Since: 8.0

Parameters
aLexiconID	The lexicon ID.
aPronunciationID	The pronunciation ID.

MSrRemoveRuleL ( TGrammarID, TRuleID )

void	MSrRemoveRuleL	(	TGrammarID	aGrammarID,
			TRuleID	aRuleID
		)	[pure virtual]

Removes the specified rule from the specified grammar permanently.

Since: 8.0

Parameters
aGrammarID	The grammar ID.
aRuleID	The rule ID.

MSrSetClientUid ( TUid )

void

MSrSetClientUid

(

TUid

aClientUid

)

[pure virtual]

Sets the specified grammar client UID.

Parameters
aClientUid	The client UID.

MSrStartRecSessionL ( TRecognitionMode )

void

MSrStartRecSessionL

(

TRecognitionMode

aMode

)

[pure virtual]

Starts a new recognition session.

Since: 8.0

Parameters
aMode	The recognition mode.

MSrTrainL ( TModelBankID, TModelID & )

void	MSrTrainL	(	TModelBankID	aModelBankID,
			TModelID &	aModelID
		)	[pure virtual]

Trains a new model into the specified model bank.

Since: 8.0

Parameters
aModelBankID	The model bank ID.
aModelID	A reference to where the new model ID is assigned.

MSrUnloadRuleL ( TGrammarID, TRuleID )

void	MSrUnloadRuleL	(	TGrammarID	aGrammarID,
			TRuleID	aRuleID
		)	[pure virtual]

Unloads the specified rule from the specified grammar in temporary memory, previously loaded with LoadGrammarL().

The rule in the permanent storage remains intact.

Since: 8.0

Parameters
aGrammarID	The grammar ID.
aRuleID	The rule ID.