Symbian^3 Application Developer Library >

CSpeechRecognitionCustomCommandParser Class Reference

class CSpeechRecognitionCustomCommandParser : public CMMFCustomCommandParserBase

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

Since
8.0

Inherits from

Public Member Functions
~CSpeechRecognitionCustomCommandParser ()
void HandleRequest ( TMMFMessage &)
IMPORT_C CSpeechRecognitionCustomCommandParser * NewL ( MSpeechRecognitionCustomCommandImplementor &)
Private Member Functions
CSpeechRecognitionCustomCommandParser ( MSpeechRecognitionCustomCommandImplementor &)
void DoAddPronunciationL ( TMMFMessage &)
void DoAddRuleL ( TMMFMessage &)
void DoCancel ()
void DoCommitChangesL ()
void DoCopyGrammarIDArrayL ( TMMFMessage &)
void DoCopyIntArrayL ( TMMFMessage &, const RArray < TInt > &)
void DoCopyLexiconIDArrayL ( TMMFMessage &)
void DoCopyModelBankIDArrayL ( TMMFMessage &)
void DoCopyModelIDArrayL ( TMMFMessage &)
void DoCopyPronunciationIDArrayL ( TMMFMessage &)
void DoCopyResultSetL ( TMMFMessage &)
void DoCopyRuleIDArrayL ( TMMFMessage &)
void DoCreateGrammarL ( TMMFMessage &)
void DoCreateLexiconL ( TMMFMessage &)
void DoCreateModelBankL ( TMMFMessage &)
void DoEndRecSessionL ()
void DoExternalizeResultSetL ()
void DoExtractIntArrayFromData1L ( TMMFMessage &, RArray < TInt > &)
void DoExtractIntArrayFromData2L ( TMMFMessage &, RArray < TInt > &)
void DoExtractIntArrayL ( TDes8 &, RArray < TInt > &)
void DoGetAllClientGrammarIDsL ()
void DoGetAllClientLexiconIDsL ()
void DoGetAllClientModelBankIDsL ()
void DoGetAllGrammarIDsL ()
void DoGetAllLexiconIDsL ()
void DoGetAllModelBankIDsL ()
void DoGetAllModelIDsL ( TMMFMessage &)
void DoGetAllPronunciationIDsL ( TMMFMessage &)
void DoGetAllRuleIDsL ( TMMFMessage &)
void DoGetAvailableStorageL ( TMMFMessage &)
void DoGetEnginePropertiesL ( TMMFMessage &)
void DoGetModelCountL ( TMMFMessage &)
void DoGetRuleValidityL ( TMMFMessage &)
void DoGetUtteranceDurationL ( TMMFMessage &)
void DoHandleRequestL ( TMMFMessage &)
void DoLoadEngineParametersL ( TMMFMessage &)
void DoLoadGrammarL ( TMMFMessage &)
void DoLoadLexiconL ( TMMFMessage &)
void DoLoadModelsL ( TMMFMessage &)
void DoPlayUtteranceL ( TMMFMessage &)
void DoRecognizeL ( TMMFMessage &)
void DoRecordL ( TMMFMessage &)
void DoRemoveGrammarL ( TMMFMessage &)
void DoRemoveLexiconL ( TMMFMessage &)
void DoRemoveModelBankL ( TMMFMessage &)
void DoRemoveModelL ( TMMFMessage &)
void DoRemovePronunciationL ( TMMFMessage &)
void DoRemoveRuleL ( TMMFMessage &)
void DoSetClientUidL ( TMMFMessage &)
void DoStartRecSessionL ( TMMFMessage &)
void DoTrainL ( TMMFMessage &)
void DoUnloadRuleL ( TMMFMessage &)
Inherited Functions
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()
CMMFCustomCommandParserBase::CMMFCustomCommandParserBase(TUid)
CMMFCustomCommandParserBase::InterfaceId()
CMMFCustomCommandParserBase::~CMMFCustomCommandParserBase()
Private Attributes
RArray < TGrammarID > iGrammarIDs
MSpeechRecognitionCustomCommandImplementor & iImplementor
RArray < TLexiconID > iLexiconIDs
RArray < TModelBankID > iModelBankIDs
RArray < TModelID > iModelIDs
RArray < TPronunciationID > iPronunciationIDs
CBufFlat * iResultCopyBuffer
CSDClientResultSet * iResultSet
RArray < TRuleID > iRuleIDs

Constructor & Destructor Documentation

CSpeechRecognitionCustomCommandParser(MSpeechRecognitionCustomCommandImplementor &)

CSpeechRecognitionCustomCommandParser ( MSpeechRecognitionCustomCommandImplementor & aImplementor ) [private]

C++ constructor for a CSpeechRecognitionCustomCommandParser class.

Since
8.0

Parameters

MSpeechRecognitionCustomCommandImplementor & aImplementor A reference to a custom commands implementor.

~CSpeechRecognitionCustomCommandParser()

IMPORT_C ~CSpeechRecognitionCustomCommandParser ( )

Destructor.

Since
8.0

Member Functions Documentation

DoAddPronunciationL(TMMFMessage &)

void DoAddPronunciationL ( TMMFMessage & aMessage ) [private]

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

Since
8.0

Parameters

TMMFMessage & aMessage The message containing the information of the request.

DoAddRuleL(TMMFMessage &)

void DoAddRuleL ( TMMFMessage & aMessage ) [private]

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

Since
8.0

Parameters

TMMFMessage & aMessage The message containing the information of the request.

DoCancel()

void DoCancel ( ) [private]

Cancels the current operation.

Since
8.0

DoCommitChangesL()

void DoCommitChangesL ( ) [private]

Commits uncommitted database operations to the database.

Since
8.0

DoCopyGrammarIDArrayL(TMMFMessage &)

void DoCopyGrammarIDArrayL ( TMMFMessage & aMessage ) [private]

Copies the grammar ID array stored by a previous GetAllGrammarIDs call.

Since
8.0

Parameters

TMMFMessage & aMessage The message containing the information of the request.

DoCopyIntArrayL(TMMFMessage &, const RArray< TInt > &)

void DoCopyIntArrayL ( TMMFMessage & aMessage,
const RArray < TInt > & aArray
) [private]

Copies the specified integer array given into a TMMFMessage .

Since
8.0

Parameters

TMMFMessage & aMessage The message to copy the array into.
const RArray < TInt > & aArray The array to copy from.

DoCopyLexiconIDArrayL(TMMFMessage &)

void DoCopyLexiconIDArrayL ( TMMFMessage & aMessage ) [private]

Copies the lexicon ID array stored by a previous GetAllLexiconIDs call.

Since
8.0

Parameters

TMMFMessage & aMessage The message containing the information of the request.

DoCopyModelBankIDArrayL(TMMFMessage &)

void DoCopyModelBankIDArrayL ( TMMFMessage & aMessage ) [private]

Copies the modelBank ID array stored by a previous GetAllModelBankIDs call.

Since
8.0

Parameters

TMMFMessage & aMessage The message containing the information of the request.

DoCopyModelIDArrayL(TMMFMessage &)

void DoCopyModelIDArrayL ( TMMFMessage & aMessage ) [private]

Copy the model ID array stored by a previous GetAllModelIDs call.

Since
8.0

Parameters

TMMFMessage & aMessage The message containing the information of the request.

DoCopyPronunciationIDArrayL(TMMFMessage &)

void DoCopyPronunciationIDArrayL ( TMMFMessage & aMessage ) [private]

Copies the pronunciation ID array stored by a previous GetAllPronunciationIDs call.

Since
8.0

Parameters

TMMFMessage & aMessage The message containing the information of the request.

DoCopyResultSetL(TMMFMessage &)

void DoCopyResultSetL ( TMMFMessage & aMessage ) [private]

Copies the previously externalised result set into a message. The message must be the same size as the stored externalized result set.

Parameters

TMMFMessage & aMessage

DoCopyRuleIDArrayL(TMMFMessage &)

void DoCopyRuleIDArrayL ( TMMFMessage & aMessage ) [private]

Copies the rule ID array stored by a previous GetAllRuleIDs call.

Since
8.0

Parameters

TMMFMessage & aMessage The message containing the information of the request.

DoCreateGrammarL(TMMFMessage &)

void DoCreateGrammarL ( TMMFMessage & aMessage ) [private]

Creates a new grammar.

Since
8.0

Parameters

TMMFMessage & aMessage A message containing the information of the request.

DoCreateLexiconL(TMMFMessage &)

void DoCreateLexiconL ( TMMFMessage & aMessage ) [private]

Creates a new lexicon.

Since
8.0

Parameters

TMMFMessage & aMessage The message containing the information of the request.

DoCreateModelBankL(TMMFMessage &)

void DoCreateModelBankL ( TMMFMessage & aMessage ) [private]

Creates a new model bank.

Since
8.0

Parameters

TMMFMessage & aMessage The message containing the information of the request.

DoEndRecSessionL()

void DoEndRecSessionL ( ) [private]

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

Since
8.0

DoExternalizeResultSetL()

void DoExternalizeResultSetL ( ) [private]

Externalises the result set into a descriptor, so that it can be copied into an array.

DoExtractIntArrayFromData1L(TMMFMessage &, RArray< TInt > &)

void DoExtractIntArrayFromData1L ( TMMFMessage & aMessage,
RArray < TInt > & aArray
) [private]

Extracts an array from first parameter of TMMFMessage .

Since
8.0

Parameters

TMMFMessage & aMessage The message to copy the array from.
RArray < TInt > & aArray The array to copy into.

DoExtractIntArrayFromData2L(TMMFMessage &, RArray< TInt > &)

void DoExtractIntArrayFromData2L ( TMMFMessage & aMessage,
RArray < TInt > & aArray
) [private]

Extracts an array from second parameter of TMMFMessage .

Since
8.0

Parameters

TMMFMessage & aMessage The message to copy array from.
RArray < TInt > & aArray The array to copy into.

DoExtractIntArrayL(TDes8 &, RArray< TInt > &)

void DoExtractIntArrayL ( TDes8 & aDescriptor,
RArray < TInt > & aArray
) [private]

Extracts an integer array from the descriptor.

Since
8.0

Parameters

TDes8 & aDescriptor The descriptor containing an integer.
RArray < TInt > & aArray The array to copy into.

DoGetAllClientGrammarIDsL()

void DoGetAllClientGrammarIDsL ( ) [private]

Returns all grammar IDs that belong to the current client, whose UID was set with SetClientUid().

Since
8.0

DoGetAllClientLexiconIDsL()

void DoGetAllClientLexiconIDsL ( ) [private]

Returns all lexicon IDs that belong to the current client, whose UID was set with SetClientUid().

Since
8.0

DoGetAllClientModelBankIDsL()

void DoGetAllClientModelBankIDsL ( ) [private]

Returns all model bank IDs that belong to the current client, whose UID was set with SetClientUid().

Since
8.0

DoGetAllGrammarIDsL()

void DoGetAllGrammarIDsL ( ) [private]

Returns all grammar IDs that exist (for all clients).

Since
8.0

DoGetAllLexiconIDsL()

void DoGetAllLexiconIDsL ( ) [private]

Returns all lexicon IDs that exist (for all clients).

Since
8.0

DoGetAllModelBankIDsL()

void DoGetAllModelBankIDsL ( ) [private]

Returns all model bank IDs that exist (for all clients).

Since
8.0

DoGetAllModelIDsL(TMMFMessage &)

void DoGetAllModelIDsL ( TMMFMessage & aMessage ) [private]

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

Since
8.0

Parameters

TMMFMessage & aMessage The message containing the information of the request.

DoGetAllPronunciationIDsL(TMMFMessage &)

void DoGetAllPronunciationIDsL ( TMMFMessage & aMessage ) [private]

Returns all pronunciation IDs that exist in the specified lexicon.

Since
8.0

Parameters

TMMFMessage & aMessage The message containing the information of the request.

DoGetAllRuleIDsL(TMMFMessage &)

void DoGetAllRuleIDsL ( TMMFMessage & aMessage ) [private]

Returns all rule IDs that exist in the specified grammar.

Since
8.0

Parameters

TMMFMessage & aMessage The message containing the information of the request.

DoGetAvailableStorageL(TMMFMessage &)

void DoGetAvailableStorageL ( TMMFMessage & aMessage ) [private]

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

Since
8.0

Parameters

TMMFMessage & aMessage The message containing the information of the request.

DoGetEnginePropertiesL(TMMFMessage &)

void DoGetEnginePropertiesL ( TMMFMessage & aMessage ) [private]

Returns the engine properties.

Since
8.0

Parameters

TMMFMessage & aMessage The message containing the information of the request.

DoGetModelCountL(TMMFMessage &)

void DoGetModelCountL ( TMMFMessage & aMessage ) [private]

Returns the number of models in the specified model bank.

Since
8.0

Parameters

TMMFMessage & aMessage The message containing the information of the request.

DoGetRuleValidityL(TMMFMessage &)

void DoGetRuleValidityL ( TMMFMessage & aMessage ) [private]

Checks if the rule is valid or not.

Since
8.0

Parameters

TMMFMessage & aMessage The message containing the information of the request.

DoGetUtteranceDurationL(TMMFMessage &)

void DoGetUtteranceDurationL ( TMMFMessage & aMessage ) [private]

Returns the duration of the utterance for the specified model.

Since
8.0

Parameters

TMMFMessage & aMessage The message containing the information of the request.

DoHandleRequestL(TMMFMessage &)

void DoHandleRequestL ( TMMFMessage & aMessage ) [private]

Private method to handle the request from the client.

Since
8.0

Parameters

TMMFMessage & aMessage The message containing the information of the request.

DoLoadEngineParametersL(TMMFMessage &)

void DoLoadEngineParametersL ( TMMFMessage & aMessage ) [private]

Loads the specified parameters into the engine.

Since
8.0

Parameters

TMMFMessage & aMessage The message containing the information of the request.

DoLoadGrammarL(TMMFMessage &)

void DoLoadGrammarL ( TMMFMessage & aMessage ) [private]

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

Since
8.0

Parameters

TMMFMessage & aMessage The message containing the information of the request.

DoLoadLexiconL(TMMFMessage &)

void DoLoadLexiconL ( TMMFMessage & aMessage ) [private]

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

Since
8.0

Parameters

TMMFMessage & aMessage The message containing the information of the request.

DoLoadModelsL(TMMFMessage &)

void DoLoadModelsL ( TMMFMessage & aMessage ) [private]

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

Since
8.0

Parameters

TMMFMessage & aMessage The message containing the information of the request.

DoPlayUtteranceL(TMMFMessage &)

void DoPlayUtteranceL ( TMMFMessage & aMessage ) [private]

Plays the previously trained utterance.

Since
8.0

Parameters

TMMFMessage & aMessage The message containing the information of the request.

DoRecognizeL(TMMFMessage &)

void DoRecognizeL ( TMMFMessage & aMessage ) [private]

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

Since
8.0

Parameters

TMMFMessage & aMessage The message containing the information of the request.

DoRecordL(TMMFMessage &)

void DoRecordL ( TMMFMessage & aMessage ) [private]

Records user utterance for training and recognition.

Since
8.0

Parameters

TMMFMessage & aMessage The message containing the information of the request.

DoRemoveGrammarL(TMMFMessage &)

void DoRemoveGrammarL ( TMMFMessage & aMessage ) [private]

Removes the specified grammar from the permanent storage.

Removing a grammar will remove all rules within the grammar.

Since
8.0

Parameters

TMMFMessage & aMessage The message containing the information of the request.

DoRemoveLexiconL(TMMFMessage &)

void DoRemoveLexiconL ( TMMFMessage & aMessage ) [private]

Removes the specified lexicon from the permanent storage.

Removing a lexicon will remove all pronunciations within the lexicon.

Since
8.0

Parameters

TMMFMessage & aMessage The message containing the information of the request.

DoRemoveModelBankL(TMMFMessage &)

void DoRemoveModelBankL ( TMMFMessage & aMessage ) [private]

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

TMMFMessage & aMessage The message containing the information of the request.

DoRemoveModelL(TMMFMessage &)

void DoRemoveModelL ( TMMFMessage & aMessage ) [private]

Removes the specified model from the specified model bank permanently.

Since
8.0

Parameters

TMMFMessage & aMessage The message containing the information of the request.

DoRemovePronunciationL(TMMFMessage &)

void DoRemovePronunciationL ( TMMFMessage & aMessage ) [private]

Removes the specified pronunciation from the specified lexicon permanently.

Since
8.0

Parameters

TMMFMessage & aMessage The message containing the information of the request.

DoRemoveRuleL(TMMFMessage &)

void DoRemoveRuleL ( TMMFMessage & aMessage ) [private]

Removes the specified rule from the specified grammar permanently.

Since
8.0

Parameters

TMMFMessage & aMessage The message containing the information of the request.

DoSetClientUidL(TMMFMessage &)

void DoSetClientUidL ( TMMFMessage & aMessage ) [private]

Sets the UID of the client.

Since
8.0

Parameters

TMMFMessage & aMessage The message containing the information of the request.

DoStartRecSessionL(TMMFMessage &)

void DoStartRecSessionL ( TMMFMessage & aMessage ) [private]

Starts a new recognition session.

Since
8.0

Parameters

TMMFMessage & aMessage The message containing the information of the request.

DoTrainL(TMMFMessage &)

void DoTrainL ( TMMFMessage & aMessage ) [private]

Trains a new model into the specified model bank.

Since
8.0

Parameters

TMMFMessage & aMessage The message containing the information of the request.

DoUnloadRuleL(TMMFMessage &)

void DoUnloadRuleL ( TMMFMessage & aMessage ) [private]

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

TMMFMessage & aMessage The message containing the information of the request.

HandleRequest(TMMFMessage &)

void HandleRequest ( TMMFMessage & aMessage ) [virtual]

Handles the request from the client.

Since
8.0

Parameters

TMMFMessage & aMessage The message containing the information of the request.

NewL(MSpeechRecognitionCustomCommandImplementor &)

IMPORT_C CSpeechRecognitionCustomCommandParser * NewL ( MSpeechRecognitionCustomCommandImplementor & aImplementor ) [static]

Factory function for creating this class.

Since
8.0

Parameters

MSpeechRecognitionCustomCommandImplementor & aImplementor A reference to a custom commands implementor.

Member Data Documentation

RArray< TGrammarID > iGrammarIDs

RArray < TGrammarID > iGrammarIDs [private]

MSpeechRecognitionCustomCommandImplementor & iImplementor

MSpeechRecognitionCustomCommandImplementor & iImplementor [private]

RArray< TLexiconID > iLexiconIDs

RArray < TLexiconID > iLexiconIDs [private]

RArray< TModelBankID > iModelBankIDs

RArray < TModelBankID > iModelBankIDs [private]

RArray< TModelID > iModelIDs

RArray < TModelID > iModelIDs [private]

RArray< TPronunciationID > iPronunciationIDs

RArray < TPronunciationID > iPronunciationIDs [private]

CBufFlat * iResultCopyBuffer

CBufFlat * iResultCopyBuffer [private]

CSDClientResultSet * iResultSet

CSDClientResultSet * iResultSet [private]

RArray< TRuleID > iRuleIDs

RArray < TRuleID > iRuleIDs [private]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.