#include <SpeechRecognitionCustomCommandImplementor.h>

This item is not part of the S60 5th Edition SDK

Class `MSpeechRecognitionCustomCommandImplementor`

class MSpeechRecognitionCustomCommandImplementor;

Description

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

Members

Defined in MSpeechRecognitionCustomCommandImplementor:

MSrAddPronunciationL(TLexiconID,TModelBankID,TModelID,TPronunciationID &)Adds a new pronunciation for the given model into the specified lexicon.
MSrAddRuleL(TGrammarID,TLexiconID,TPronunciationID,TRuleID &)Adds a new rule for the given pronunciation into the specified grammar.
MSrCancel()Cancels the current operation.
MSrCommitChangesL()Commit uncommited changes to the database.
MSrCreateGrammarL(TGrammarID &)Creates a new grammar.
MSrCreateLexiconL(TLexiconID &)Creates a new lexicon.
MSrCreateModelBankL(TModelBankID &)Creates a new model bank.
MSrEndRecSessionL()Ends the current recognition session. Resources allocated for recognition are fr...
MSrGetAllClientGrammarIDsL(RArray< TGrammarID > &)Returns all grammar IDs that are owned by the client.
MSrGetAllClientLexiconIDsL(RArray< TLexiconID > &)Returns all lexicon IDs that are owned by the client.
MSrGetAllClientModelBankIDsL(RArray< TModelBankID > &)Returns all modelbank IDs that are owned by the client.
MSrGetAllGrammarIDsL(RArray< TGrammarID > &)Returns all grammar IDs.
MSrGetAllLexiconIDsL(RArray< TLexiconID > &)Returns all lexicon IDs.
MSrGetAllModelBankIDsL(RArray< TModelBankID > &)Returns all modelbank IDs.
MSrGetAllModelIDsL(TModelBankID,RArray< TModelID > &)Returns all model IDs that exist in the specified model bank.
MSrGetAllPronunciationIDsL(TLexiconID,RArray< TPronunciationID > &)Returns all pronunciation IDs that exist in the specified lexicon.
MSrGetAllRuleIDsL(TGrammarID,RArray< TRuleID > &)Returns all rule IDs that exist in the specified grammar.
MSrGetAvailableStorageL(TInt &)Returns the number of models available for training system wide, based on availa...
MSrGetEnginePropertiesL(const RArray< TInt > &,RArray< TInt > &)Returns the engine properties specified by the engine property ID array.
MSrGetModelCountL(TModelBankID,TInt &)Returns the number of models in the specified model bank.
MSrGetRuleValidityL(TGrammarID,TRuleID,TBool &)Checks if the rule is valid or not.
MSrGetUtteranceDurationL(TModelBankID,TModelID,TTimeIntervalMicroSeconds32 &)Returns the duration of the utterance for the specified model.
MSrLoadEngineParametersL(const RArray< TInt > &,const RArray< TInt > &)Unloads the specified parameters to the engine.
MSrLoadGrammarL(TGrammarID)Loads the specified grammar in into the recognizer; done prior to recognition.
MSrLoadLexiconL(TLexiconID)Loads the specified lexicon into the recognizer; done prior to recognition.
MSrLoadModelsL(TModelBankID)Loads the specified model bank into the recognizer; done prior to recognition.
MSrPlayUtteranceL(TModelBankID,TModelID)Plays the previously trained utterance.
MSrRecognizeL(CSDClientResultSet &)Initiates recognition; performed following loading of model bank, lexicon, and g...
MSrRecordL(TTimeIntervalMicroSeconds32)Records user utterance for training and recognition.
MSrRemoveGrammarL(TGrammarID)Removes the specified grammar from the permanent storage.
MSrRemoveLexiconL(TLexiconID)Removes the specified lexicon from the permanent storage.
MSrRemoveModelBankL(TModelBankID)Removes the specified model bank from the permanent storage.
MSrRemoveModelL(TModelBankID,TModelID)Removes the specified model from the specified model bank permanently.
MSrRemovePronunciationL(TLexiconID,TPronunciationID)Removes the specified pronunciation from the specified lexicon permanently.
MSrRemoveRuleL(TGrammarID,TRuleID)Removes the specified rule from the specified grammar permanently.
MSrSetClientUid(TUid)Sets the specified grammar client UID.
MSrStartRecSessionL(TRecognitionMode)Starts a new recognition session.
MSrTrainL(TModelBankID,TModelID &)Trains a new model into the specified model bank.
MSrUnloadRuleL(TGrammarID,TRuleID)Unloads the specified rule from the specified grammar in temporary memory, previ...

Member functions

`MSrAddPronunciationL(TLexiconID,TModelBankID,TModelID,TPronunciationID &)`

virtual void MSrAddPronunciationL(TLexiconID aLexiconID, TModelBankID aModelBankID, TModelID aModelID, TPronunciationID &aPronunciationID)=0;

Description

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

Parameters

`TLexiconID aLexiconID`	The lexicon ID to where the new pronunciation is added.
`TModelBankID aModelBankID`	The model bank ID.
`TModelID aModelID`	The model ID.
`TPronunciationID &aPronunciationID`	A reference to where a new pronunciation ID is assigned.

`MSrAddRuleL(TGrammarID,TLexiconID,TPronunciationID,TRuleID &)`

virtual void MSrAddRuleL(TGrammarID aGrammarID, TLexiconID aLexiconID, TPronunciationID aPronunciationID, TRuleID &aRuleID)=0;

Description

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

Parameters

`TGrammarID aGrammarID`	The grammar ID, where the new rule is added to
`TLexiconID aLexiconID`	The lexicon ID.
`TPronunciationID aPronunciationID`	The pronunciation ID.
`TRuleID &aRuleID`	A reference where a new rule ID is assigned to.

`MSrCancel()`

virtual void MSrCancel()=0;

Description

Cancels the current operation.

`MSrCommitChangesL()`

virtual void MSrCommitChangesL()=0;

Description

Commit uncommited changes to the database.

`MSrCreateGrammarL(TGrammarID &)`

virtual void MSrCreateGrammarL(TGrammarID &aGrammarID)=0;

Description

Creates a new grammar.

Parameters


                                 						TGrammarID &aGrammarID

A reference where the grammar ID is stored.

`MSrCreateLexiconL(TLexiconID &)`

virtual void MSrCreateLexiconL(TLexiconID &aLexiconID)=0;

Description

Creates a new lexicon.

Parameters


                                 						TLexiconID &aLexiconID

A reference where the lexicon ID is stored.

`MSrCreateModelBankL(TModelBankID &)`

virtual void MSrCreateModelBankL(TModelBankID &aModelBankID)=0;

Description

Creates a new model bank.

Parameters


                                 						TModelBankID &aModelBankID

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

`MSrEndRecSessionL()`

virtual void MSrEndRecSessionL()=0;

Description

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

`MSrGetAllClientGrammarIDsL(RArray< TGrammarID > &)`

virtual void MSrGetAllClientGrammarIDsL(RArray< TGrammarID > &aGrammarIDs)=0;

Description

Returns all grammar IDs that are owned by the client.

Parameters


                                 						RArray< TGrammarID > &aGrammarIDs

A reference where grammar IDs are stored.

`MSrGetAllClientLexiconIDsL(RArray< TLexiconID > &)`

virtual void MSrGetAllClientLexiconIDsL(RArray< TLexiconID > &aLexiconIDs)=0;

Description

Returns all lexicon IDs that are owned by the client.

Parameters


                                 						RArray< TLexiconID > &aLexiconIDs

A reference where the lexicon IDs are stored.

`MSrGetAllClientModelBankIDsL(RArray< TModelBankID > &)`

virtual void MSrGetAllClientModelBankIDsL(RArray< TModelBankID > &aModelBankIDs)=0;

Description

Returns all modelbank IDs that are owned by the client.

Parameters


                                 						RArray< TModelBankID > &aModelBankIDs

A reference where model bank IDs are stored.

`MSrGetAllGrammarIDsL(RArray< TGrammarID > &)`

virtual void MSrGetAllGrammarIDsL(RArray< TGrammarID > &aGrammarIDs)=0;

Description

Returns all grammar IDs.

Parameters


                                 						RArray< TGrammarID > &aGrammarIDs

A reference where grammar IDs are stored.

`MSrGetAllLexiconIDsL(RArray< TLexiconID > &)`

virtual void MSrGetAllLexiconIDsL(RArray< TLexiconID > &aLexiconIDs)=0;

Description

Returns all lexicon IDs.

Parameters


                                 						RArray< TLexiconID > &aLexiconIDs

A reference where lexicon IDs are stored.

`MSrGetAllModelBankIDsL(RArray< TModelBankID > &)`

virtual void MSrGetAllModelBankIDsL(RArray< TModelBankID > &aModelBankIDs)=0;

Description

Returns all modelbank IDs.

Parameters


                                 						RArray< TModelBankID > &aModelBankIDs

A reference where the model bank IDs are stored.

`MSrGetAllModelIDsL(TModelBankID,RArray< TModelID > &)`

virtual void MSrGetAllModelIDsL(TModelBankID aModelBankID, RArray< TModelID > &aModelIDs)=0;

Description

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

Parameters

`TModelBankID aModelBankID`	The model bank ID.
`RArray< TModelID > &aModelIDs`	A reference where model IDs are stored.

`MSrGetAllPronunciationIDsL(TLexiconID,RArray< TPronunciationID > &)`

virtual void MSrGetAllPronunciationIDsL(TLexiconID aLexiconID, RArray< TPronunciationID > &aPronunciationIDs)=0;

Description

Returns all pronunciation IDs that exist in the specified lexicon.

Parameters

`TLexiconID aLexiconID`	The lexicon ID.
`RArray< TPronunciationID > &aPronunciationIDs`	A reference where pronunciation IDs are stored.

`MSrGetAllRuleIDsL(TGrammarID,RArray< TRuleID > &)`

virtual void MSrGetAllRuleIDsL(TGrammarID aGrammarID, RArray< TRuleID > &aRuleIDs)=0;

Description

Returns all rule IDs that exist in the specified grammar.

Parameters

`TGrammarID aGrammarID`	The grammar ID.
`RArray< TRuleID > &aRuleIDs`	A reference where rule IDs are stored.

`MSrGetAvailableStorageL(TInt &)`

virtual void MSrGetAvailableStorageL(TInt &aCount)=0;

Description

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

Parameters


                                 						TInt &aCount

A reference where the number of available models is set.

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

virtual void MSrGetEnginePropertiesL(const RArray< TInt > &aPropertyId, RArray< TInt > &aPropertyValue)=0;

Description

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

On return aPropertyValue contains an array of engine properties.

Parameters

`const RArray< TInt > &aPropertyId`	A constant reference to an array of engine property IDs.
`RArray< TInt > &aPropertyValue`	A reference to an array of engine property values.

`MSrGetModelCountL(TModelBankID,TInt &)`

virtual void MSrGetModelCountL(TModelBankID aModelBankID, TInt &aCount)=0;

Description

Returns the number of models in the specified model bank.

Parameters

`TModelBankID aModelBankID`	The model bank ID.
`TInt &aCount`	A reference where the number of models is set.

`MSrGetRuleValidityL(TGrammarID,TRuleID,TBool &)`

virtual void MSrGetRuleValidityL(TGrammarID aGrammarID, TRuleID aRuleID, TBool &aValid)=0;

Description

Checks if the rule is valid or not.

Parameters

`TGrammarID aGrammarID`	The grammar ID.
`TRuleID aRuleID`	The rule ID.
`TBool &aValid`	A reference where the validity of the rule is set.

`MSrGetUtteranceDurationL(TModelBankID,TModelID,TTimeIntervalMicroSeconds32 &)`

virtual void MSrGetUtteranceDurationL(TModelBankID aModelBankID, TModelID aModelID, TTimeIntervalMicroSeconds32 &aDuration)=0;

Description

Returns the duration of the utterance for the specified model.

Parameters

`TModelBankID aModelBankID`	The model bank ID.
`TModelID aModelID`	The model ID.
`TTimeIntervalMicroSeconds32 &aDuration`	A reference where the duration of utterance is set.

`MSrLoadGrammarL(TGrammarID)`

virtual void MSrLoadGrammarL(TGrammarID aGrammarID)=0;

Description

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

Parameters


                                 						TGrammarID aGrammarID

The grammar ID.

`MSrLoadLexiconL(TLexiconID)`

virtual void MSrLoadLexiconL(TLexiconID aLexiconID)=0;

Description

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

Parameters


                                 						TLexiconID aLexiconID

The lexicon ID.

`MSrLoadModelsL(TModelBankID)`

virtual void MSrLoadModelsL(TModelBankID aModelBankID)=0;

Description

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

Parameters


                                 						TModelBankID aModelBankID

The model bank ID.

`MSrPlayUtteranceL(TModelBankID,TModelID)`

virtual void MSrPlayUtteranceL(TModelBankID aModelBankID, TModelID aModelID)=0;

Description

Plays the previously trained utterance.

Parameters

`TModelBankID aModelBankID`	The model bank ID.
`TModelID aModelID`	The model ID, whose utterance is played.

`MSrRecognizeL(CSDClientResultSet &)`

virtual void MSrRecognizeL(CSDClientResultSet &aResultSet)=0;

Description

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

Parameters


                                 						CSDClientResultSet &aResultSet

A reference where the recognition result is set.

`MSrRecordL(TTimeIntervalMicroSeconds32)`

virtual void MSrRecordL(TTimeIntervalMicroSeconds32 aRecordTime)=0;

Description

Records user utterance for training and recognition.

Parameters


                                 						TTimeIntervalMicroSeconds32 aRecordTime

A recording time in microseconds.

`MSrRemoveGrammarL(TGrammarID)`

virtual void MSrRemoveGrammarL(TGrammarID aGrammarID)=0;

Description

Removes the specified grammar from the permanent storage.

Removing a grammar will remove all rules within the grammar.

Parameters


                                 						TGrammarID aGrammarID

The grammar ID.

`MSrRemoveLexiconL(TLexiconID)`

virtual void MSrRemoveLexiconL(TLexiconID aLexiconID)=0;

Description

Removes the specified lexicon from the permanent storage.

Removing a lexicon will remove all pronunciations within the lexicon.

Parameters


                                 						TLexiconID aLexiconID

The lexicon ID.

`MSrRemoveModelBankL(TModelBankID)`

virtual void MSrRemoveModelBankL(TModelBankID aModelBankID)=0;

Description

Removes the specified model bank from the permanent storage.

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

Parameters


                                 						TModelBankID aModelBankID

The model bank ID.

`MSrRemoveModelL(TModelBankID,TModelID)`

virtual void MSrRemoveModelL(TModelBankID aModelBankID, TModelID aModelID)=0;

Description

Removes the specified model from the specified model bank permanently.

Parameters

`TModelBankID aModelBankID`	The model bank ID.
`TModelID aModelID`	The model ID.

`MSrRemovePronunciationL(TLexiconID,TPronunciationID)`

virtual void MSrRemovePronunciationL(TLexiconID aLexiconID, TPronunciationID aPronunciationID)=0;

Description

Removes the specified pronunciation from the specified lexicon permanently.

Parameters

`TLexiconID aLexiconID`	The lexicon ID.
`TPronunciationID aPronunciationID`	The pronunciation ID.

`MSrRemoveRuleL(TGrammarID,TRuleID)`

virtual void MSrRemoveRuleL(TGrammarID aGrammarID, TRuleID aRuleID)=0;

Description

Removes the specified rule from the specified grammar permanently.

Parameters

`TGrammarID aGrammarID`	The grammar ID.
`TRuleID aRuleID`	The rule ID.

`MSrSetClientUid(TUid)`

virtual void MSrSetClientUid(TUid aClientUid)=0;

Description

Sets the specified grammar client UID.

Parameters


                                 						TUid aClientUid

The client UID.

`MSrStartRecSessionL(TRecognitionMode)`

virtual void MSrStartRecSessionL(TRecognitionMode aMode)=0;

Description

Starts a new recognition session.

Parameters


                                 						TRecognitionMode aMode

The recognition mode.

`MSrTrainL(TModelBankID,TModelID &)`

virtual void MSrTrainL(TModelBankID aModelBankID, TModelID &aModelID)=0;

Description

Trains a new model into the specified model bank.

Parameters

`TModelBankID aModelBankID`	The model bank ID.
`TModelID &aModelID`	A reference to where the new model ID is assigned.

`MSrUnloadRuleL(TGrammarID,TRuleID)`

virtual void MSrUnloadRuleL(TGrammarID aGrammarID, TRuleID aRuleID)=0;

Description

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

The rule in the permanent storage remains intact.

Parameters

`TGrammarID aGrammarID`	The grammar ID.
`TRuleID aRuleID`	The rule ID.

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

virtual void MSrLoadEngineParametersL(const RArray< TInt > &aParameterId, const RArray< TInt > &aParameterValue)=0;

Description

Unloads the specified parameters to the engine.

Parameters

`const RArray< TInt > &aParameterId`	An array of parameter IDs.
`const RArray< TInt > &aParameterValue`	An array of parameter values.

Class MSpeechRecognitionCustomCommandImplementor

Description

Members

Member functions

MSrAddPronunciationL(TLexiconID,TModelBankID,TModelID,TPronunciationID &)

Description

Parameters

MSrAddRuleL(TGrammarID,TLexiconID,TPronunciationID,TRuleID &)

Description

Parameters

MSrCancel()

Description

MSrCommitChangesL()

Description

MSrCreateGrammarL(TGrammarID &)

Description

Parameters

MSrCreateLexiconL(TLexiconID &)

Description

Parameters

MSrCreateModelBankL(TModelBankID &)

Description

Parameters

MSrEndRecSessionL()

Description

MSrGetAllClientGrammarIDsL(RArray< TGrammarID > &)

Description

Parameters

MSrGetAllClientLexiconIDsL(RArray< TLexiconID > &)

Description

Parameters

MSrGetAllClientModelBankIDsL(RArray< TModelBankID > &)

Description

Parameters

MSrGetAllGrammarIDsL(RArray< TGrammarID > &)

Description

Parameters

MSrGetAllLexiconIDsL(RArray< TLexiconID > &)

Description

Parameters

MSrGetAllModelBankIDsL(RArray< TModelBankID > &)

Description

Parameters

MSrGetAllModelIDsL(TModelBankID,RArray< TModelID > &)

Description

Parameters

MSrGetAllPronunciationIDsL(TLexiconID,RArray< TPronunciationID > &)

Description

Parameters

MSrGetAllRuleIDsL(TGrammarID,RArray< TRuleID > &)

Description

Parameters

MSrGetAvailableStorageL(TInt &)

Description

Parameters

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

Description

Parameters

MSrGetModelCountL(TModelBankID,TInt &)

Description

Parameters

MSrGetRuleValidityL(TGrammarID,TRuleID,TBool &)

Description

Parameters

MSrGetUtteranceDurationL(TModelBankID,TModelID,TTimeIntervalMicroSeconds32 &)

Description

Parameters

MSrLoadGrammarL(TGrammarID)

Description

Parameters

MSrLoadLexiconL(TLexiconID)

Description

Parameters

MSrLoadModelsL(TModelBankID)

Description

Parameters

MSrPlayUtteranceL(TModelBankID,TModelID)

Description

Parameters

MSrRecognizeL(CSDClientResultSet &)

Class `MSpeechRecognitionCustomCommandImplementor`

`MSrAddPronunciationL(TLexiconID,TModelBankID,TModelID,TPronunciationID &)`

`MSrAddRuleL(TGrammarID,TLexiconID,TPronunciationID,TRuleID &)`

`MSrCancel()`

`MSrCommitChangesL()`

`MSrCreateGrammarL(TGrammarID &)`

`MSrCreateLexiconL(TLexiconID &)`

`MSrCreateModelBankL(TModelBankID &)`

`MSrEndRecSessionL()`

`MSrGetAllClientGrammarIDsL(RArray< TGrammarID > &)`

`MSrGetAllClientLexiconIDsL(RArray< TLexiconID > &)`

`MSrGetAllClientModelBankIDsL(RArray< TModelBankID > &)`

`MSrGetAllGrammarIDsL(RArray< TGrammarID > &)`

`MSrGetAllLexiconIDsL(RArray< TLexiconID > &)`

`MSrGetAllModelBankIDsL(RArray< TModelBankID > &)`

`MSrGetAllModelIDsL(TModelBankID,RArray< TModelID > &)`

`MSrGetAllPronunciationIDsL(TLexiconID,RArray< TPronunciationID > &)`

`MSrGetAllRuleIDsL(TGrammarID,RArray< TRuleID > &)`

`MSrGetAvailableStorageL(TInt &)`

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

`MSrGetModelCountL(TModelBankID,TInt &)`

`MSrGetRuleValidityL(TGrammarID,TRuleID,TBool &)`

`MSrGetUtteranceDurationL(TModelBankID,TModelID,TTimeIntervalMicroSeconds32 &)`

`MSrLoadGrammarL(TGrammarID)`

`MSrLoadLexiconL(TLexiconID)`

`MSrLoadModelsL(TModelBankID)`

`MSrPlayUtteranceL(TModelBankID,TModelID)`

`MSrRecognizeL(CSDClientResultSet &)`

`MSrRecordL(TTimeIntervalMicroSeconds32)`

`MSrRemoveGrammarL(TGrammarID)`

`MSrRemoveLexiconL(TLexiconID)`

`MSrRemoveModelBankL(TModelBankID)`

`MSrRemoveModelL(TModelBankID,TModelID)`

`MSrRemovePronunciationL(TLexiconID,TPronunciationID)`

`MSrRemoveRuleL(TGrammarID,TRuleID)`

`MSrSetClientUid(TUid)`

`MSrStartRecSessionL(TRecognitionMode)`

`MSrTrainL(TModelBankID,TModelID &)`

`MSrUnloadRuleL(TGrammarID,TRuleID)`

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