Collapse all Symbian^3 Product Developer Library

CSISpeechRecognitionCustomCommandParser Class Reference

class CSISpeechRecognitionCustomCommandParser : public CMMFCustomCommandParserBase

This is the main class of Speaker Independent Custom Commands Parser

nsssispeechrecognitioncustomcommands.lib

Since: 2.8

Inherits from

CSISpeechRecognitionCustomCommandParser
- CMMFCustomCommandParserBase
  - CBase

Public Member Functions
	~CSISpeechRecognitionCustomCommandParser()
void	HandleRequest(TMMFMessage &)
IMPORT_C CSISpeechRecognitionCustomCommandParser *	NewL(MSISpeechRecognitionCustomCommandImplementor &)

Private Member Functions
	CSISpeechRecognitionCustomCommandParser(MSISpeechRecognitionCustomCommandImplementor &)
void	DoActivateGrammarL(TMMFMessage &)
void	DoAdaptL(TMMFMessage &)
void	DoAddPronunciationL(TMMFMessage &)
void	DoAddPronunciationSIL(TMMFMessage &)
void	DoAddRuleL(TMMFMessage &)
void	DoAddRuleVariantL(TMMFMessage &)
void	DoAddSindeVoiceTagL(TMMFMessage &)
void	DoAddSindeVoiceTagsL(TMMFMessage &)
void	DoAddVoiceTagL(TMMFMessage &)
void	DoAddVoiceTagsL(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	DoCreateRuleL(TMMFMessage &)
void	DoDeactivateGrammarL(TMMFMessage &)
void	DoEndRecSessionL()
void	DoEndRecordL(TMMFMessage &)
void	DoExternalizeResultSetL()
void	DoExternalizeSIResultSetL()
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	DoPreStartSamplingL(TMMFMessage &)
void	DoRecognizeL(TMMFMessage &)
void	DoRecognizeSIL(TMMFMessage &)
void	DoRecordL(TMMFMessage &)
void	DoRemoveGrammarL(TMMFMessage &)
void	DoRemoveLexiconL(TMMFMessage &)
void	DoRemoveModelBankL(TMMFMessage &)
void	DoRemoveModelL(TMMFMessage &)
void	DoRemovePronunciationL(TMMFMessage &)
void	DoRemoveRuleL(TMMFMessage &)
void	DoRemoveRulesL(TMMFMessage &)
void	DoSetClientUidL(TMMFMessage &)
void	DoStartRecSessionL(TMMFMessage &)
void	DoTrainL(TMMFMessage &)
void	DoUnloadGrammarL(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
CSIClientResultSet *	iAdaptationSet
RArray< TSIGrammarID >	iGrammarIDs
MSISpeechRecognitionCustomCommandImplementor &	iImplementor
RArray< TLanguage >	iLanguageArray
RArray< RLanguageArray >	iLanguageArrayArray
RArray< TSILexiconID >	iLexiconIDs
RArray< TSIModelBankID >	iModelBankIDs
RArray< TSIModelID >	iModelIDs
RArray< TSIPronunciationID >	iPronunciationIDs
TAny *	iReservedPtr_1
TAny *	iReservedPtr_2
CBufFlat *	iResultCopyBuffer
CSDClientResultSet *	iResultSet
RArray< TSIRuleID >	iRuleIDs
CSIClientResultSet *	iSIResultSet
MDesCArray *	iWordArray

Constructor & Destructor Documentation

CSISpeechRecognitionCustomCommandParser(MSISpeechRecognitionCustomCommandImplementor &)

CSISpeechRecognitionCustomCommandParser

(

MSISpeechRecognitionCustomCommandImplementor &

aImplementor

)

[private]

C++ constructor for CSISpeechRecognitionCustomCommandParser class.

Since: 2.0

Parameters

MSISpeechRecognitionCustomCommandImplementor & aImplementor

reference to custom commands implementor

~CSISpeechRecognitionCustomCommandParser()

IMPORT_C

~CSISpeechRecognitionCustomCommandParser

(

)

Destructor

Since: 2.0

Member Functions Documentation

DoActivateGrammarL(TMMFMessage &)

void

DoActivateGrammarL

(

TMMFMessage &

aMessage

)

[private]

Activates a previously deactivated gramamr.

Since: 2.0

Parameters

TMMFMessage & aMessage

message containing the information of the request.

DoAdaptL(TMMFMessage &)

void

DoAdaptL

(

TMMFMessage &

aMessage

)

[private]

Adapts acoustic models to a user's voice.

Since: 2.8

Parameters

TMMFMessage & aMessage

message containing the information of the request.

DoAddPronunciationL(TMMFMessage &)

void

DoAddPronunciationL

(

TMMFMessage &

aMessage

)

[private]

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

Since: 2.0

Parameters

TMMFMessage & aMessage

message containing the information of the request.

DoAddPronunciationSIL(TMMFMessage &)

void

DoAddPronunciationSIL

(

TMMFMessage &

aMessage

)

[private]

Adds a speaker independent pronunciation.

Since: 2.8

Parameters

TMMFMessage & aMessage

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: 2.0

Parameters

TMMFMessage & aMessage

message containing the information of the request.

DoAddRuleVariantL(TMMFMessage &)

void

DoAddRuleVariantL

(

TMMFMessage &

aMessage

)

[private]

Adds a rule variant.

Since: 2.8

Parameters

TMMFMessage & aMessage

message containing the information of the request.

DoAddSindeVoiceTagL(TMMFMessage &)

void

DoAddSindeVoiceTagL

(

TMMFMessage &

aMessage

)

[private]

Adds one SINDE voice tag.

Since: 3.1

Parameters

TMMFMessage & aMessage

Message containing the information of the request.

DoAddSindeVoiceTagsL(TMMFMessage &)

void

DoAddSindeVoiceTagsL

(

TMMFMessage &

aMessage

)

[private]

Adds an array of voice tags.

Since: 3.1

Parameters

TMMFMessage & aMessage

Message containing the information of the request.

DoAddVoiceTagL(TMMFMessage &)

void

DoAddVoiceTagL

(

TMMFMessage &

aMessage

)

[private]

Adds a voice tag.

Since: 2.8

Parameters

TMMFMessage & aMessage

message containing the information of the request.

DoAddVoiceTagsL(TMMFMessage &)

void

DoAddVoiceTagsL

(

TMMFMessage &

aMessage

)

[private]

Adds several voice tags.

Since: 2.8

Parameters

TMMFMessage & aMessage

message containing the information of the request.

DoCancel()

void

DoCancel

(

)

[private]

Cancels the current operation

Since: 2.0

DoCommitChangesL()

void

DoCommitChangesL

(

)

[private]

Saves the current changes into a permanent storage.

Since: 2.0

DoCopyGrammarIDArrayL(TMMFMessage &)

void

DoCopyGrammarIDArrayL

(

TMMFMessage &

aMessage

)

[private]

Copy the grammar ID array to the client.

Since: 2.0

Parameters

TMMFMessage & aMessage

message containing the information of the request.

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

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

Copy data from an RArray to the client.

Since: 2.0

Parameters

TMMFMessage & aMessage	message containing the information of the request.
const RArray< TInt > & aArray	RArray copied to the client.

DoCopyLexiconIDArrayL(TMMFMessage &)

void

DoCopyLexiconIDArrayL

(

TMMFMessage &

aMessage

)

[private]

Copy the lexicon ID array to the client.

Since: 2.0

Parameters

TMMFMessage & aMessage

message containing the information of the request.

DoCopyModelBankIDArrayL(TMMFMessage &)

void

DoCopyModelBankIDArrayL

(

TMMFMessage &

aMessage

)

[private]

Copy the model bank ID array to the client.

Since: 2.0

Parameters

TMMFMessage & aMessage

message containing the information of the request.

DoCopyModelIDArrayL(TMMFMessage &)

void

DoCopyModelIDArrayL

(

TMMFMessage &

aMessage

)

[private]

Copy the model ID array to the client.

Since: 2.0

Parameters

TMMFMessage & aMessage

message containing the information of the request.

DoCopyPronunciationIDArrayL(TMMFMessage &)

void

DoCopyPronunciationIDArrayL

(

TMMFMessage &

aMessage

)

[private]

Copy the pronunciation ID array to the client.

Since: 2.0

Parameters

TMMFMessage & aMessage

message containing the information of the request.

DoCopyResultSetL(TMMFMessage &)

void

DoCopyResultSetL

(

TMMFMessage &

aMessage

)

[private]

Copy the recognition result set to the client.

Since: 2.0

Parameters

TMMFMessage & aMessage

message containing the information of the request.

DoCopyRuleIDArrayL(TMMFMessage &)

void

DoCopyRuleIDArrayL

(

TMMFMessage &

aMessage

)

[private]

Copy the rule ID array to the client.

Since: 2.0

Parameters

TMMFMessage & aMessage

message containing the information of the request.

DoCreateGrammarL(TMMFMessage &)

void

DoCreateGrammarL

(

TMMFMessage &

aMessage

)

[private]

Creates a new grammar.

Since: 2.0

Parameters

TMMFMessage & aMessage

message containing the information of the request.

DoCreateLexiconL(TMMFMessage &)

void

DoCreateLexiconL

(

TMMFMessage &

aMessage

)

[private]

Creates a new lexicon.

Since: 2.0

Parameters

TMMFMessage & aMessage

message containing the information of the request.

DoCreateModelBankL(TMMFMessage &)

void

DoCreateModelBankL

(

TMMFMessage &

aMessage

)

[private]

Creates a new model bank.

Since: 2.0

Parameters

TMMFMessage & aMessage

message containing the information of the request.

DoCreateRuleL(TMMFMessage &)

void

DoCreateRuleL

(

TMMFMessage &

aMessage

)

[private]

Creates an empty rule.

Since: 2.8

Parameters

TMMFMessage & aMessage

message containing the information of the request.

DoDeactivateGrammarL(TMMFMessage &)

void

DoDeactivateGrammarL

(

TMMFMessage &

aMessage

)

[private]

Deactivates a loaded gramamr, so that it is not recognized.

Since: 2.0

Parameters

TMMFMessage & aMessage

message containing the information of the request.

DoEndRecSessionL()

void

DoEndRecSessionL

(

)

[private]

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

Since: 2.0

DoEndRecordL(TMMFMessage &)

void

DoEndRecordL

(

TMMFMessage &

aMessage

)

[private]

Stops recording (recognizing).

Since: 2.8

Parameters

TMMFMessage & aMessage

message containing the information of the request.

DoExternalizeResultSetL()

void

DoExternalizeResultSetL

(

)

[private]

Externalize the recognition result set.

Since: 2.0

DoExternalizeSIResultSetL()

void

DoExternalizeSIResultSetL

(

)

[private]

Externalize the speaker independent recognition result set.

Since: 2.0

DoExtractIntArrayFromData1L(TMMFMessage &, RArray< TInt > &)

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

Extract an integer array from client data 1.

Since: 2.0

Parameters

TMMFMessage & aMessage	message containing the information of the request.
RArray< TInt > & aArray	RArray to contain the data on exit.

DoExtractIntArrayFromData2L(TMMFMessage &, RArray< TInt > &)

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

Extract an integer array from client data 2.

Since: 2.0

Parameters

TMMFMessage & aMessage	message containing the information of the request.
RArray< TInt > & aArray	RArray to contain the data on exit.

DoExtractIntArrayL(TDes8 &, RArray< TInt > &)

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

Extract an integer array from a descriptor into an RArray.

Since: 2.0

Parameters

TDes8 & aDescriptor
RArray< TInt > & aArray	RArray to contain the data on exit.

DoGetAllClientGrammarIDsL()

void

DoGetAllClientGrammarIDsL

(

)

[private]

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

Since: 2.0

DoGetAllClientLexiconIDsL()

void

DoGetAllClientLexiconIDsL

(

)

[private]

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

Since: 2.0

DoGetAllClientModelBankIDsL()

void

DoGetAllClientModelBankIDsL

(

)

[private]

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

Since: 2.0

DoGetAllGrammarIDsL()

void

DoGetAllGrammarIDsL

(

)

[private]

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

Since: 2.0

DoGetAllLexiconIDsL()

void

DoGetAllLexiconIDsL

(

)

[private]

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

Since: 2.0

DoGetAllModelBankIDsL()

void

DoGetAllModelBankIDsL

(

)

[private]

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

Since: 2.0

DoGetAllModelIDsL(TMMFMessage &)

void

DoGetAllModelIDsL

(

TMMFMessage &

aMessage

)

[private]

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

Since: 2.0

Parameters

TMMFMessage & aMessage

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: 2.0

Parameters

TMMFMessage & aMessage

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: 2.0

Parameters

TMMFMessage & aMessage

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: 2.0

Parameters

TMMFMessage & aMessage

message containing the information of the request.

DoGetEnginePropertiesL(TMMFMessage &)

void

DoGetEnginePropertiesL

(

TMMFMessage &

aMessage

)

[private]

Returns the engine properties.

Since: 2.0

Parameters

TMMFMessage & aMessage

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: 2.0

Parameters

TMMFMessage & aMessage

message containing the information of the request.

DoGetRuleValidityL(TMMFMessage &)

void

DoGetRuleValidityL

(

TMMFMessage &

aMessage

)

[private]

Checks if the rule is valid or not.

Since: 2.0

Parameters

TMMFMessage & aMessage

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: 2.0

Parameters

TMMFMessage & aMessage

message containing the information of the request.

DoHandleRequestL(TMMFMessage &)

void

DoHandleRequestL

(

TMMFMessage &

aMessage

)

[private]

Private method to handle the request from the client

Since: 2.0

Parameters

TMMFMessage & aMessage

message containing the information of the request.

DoLoadEngineParametersL(TMMFMessage &)

void

DoLoadEngineParametersL

(

TMMFMessage &

aMessage

)

[private]

Loads the specified parameters into the engine.

Since: 2.0

Parameters

TMMFMessage & aMessage

message containing the information of the request.

DoLoadGrammarL(TMMFMessage &)

void

DoLoadGrammarL

(

TMMFMessage &

aMessage

)

[private]

Loads a gramamr. Grammars must be loaded prior to recognition.

Since: 2.0

Parameters

TMMFMessage & aMessage

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: 2.0

Parameters

TMMFMessage & aMessage

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: 2.0

Parameters

TMMFMessage & aMessage

message containing the information of the request.

DoPlayUtteranceL(TMMFMessage &)

void

DoPlayUtteranceL

(

TMMFMessage &

aMessage

)

[private]

Plays the previously trained utterance.

Since: 2.0

Parameters

TMMFMessage & aMessage

message containing the information of the request.

DoPreStartSamplingL(TMMFMessage &)

void

DoPreStartSamplingL

(

TMMFMessage &

aMessage

)

[private]

Pre-starts sampling

Since: 3.2

Parameters

TMMFMessage & aMessage

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: 2.0

Parameters

TMMFMessage & aMessage

message containing the information of the request.

DoRecognizeSIL(TMMFMessage &)

void

DoRecognizeSIL

(

TMMFMessage &

aMessage

)

[private]

Starts speaker independent recognition.

Since: 2.8

Parameters

TMMFMessage & aMessage

message containing the information of the request.

DoRecordL(TMMFMessage &)

void

DoRecordL

(

TMMFMessage &

aMessage

)

[private]

Records uder utterance for training and recognition.

Since: 2.0

Parameters

TMMFMessage & aMessage

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: 2.0

Parameters

TMMFMessage & aMessage

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: 2.0

Parameters

TMMFMessage & aMessage

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: 2.0

Parameters

TMMFMessage & aMessage

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: 2.0

Parameters

TMMFMessage & aMessage

message containing the information of the request.

DoRemovePronunciationL(TMMFMessage &)

void

DoRemovePronunciationL

(

TMMFMessage &

aMessage

)

[private]

Removes the specified pronunciation from the specified lexicon permanently.

Since: 2.0

Parameters

TMMFMessage & aMessage

message containing the information of the request.

DoRemoveRuleL(TMMFMessage &)

void

DoRemoveRuleL

(

TMMFMessage &

aMessage

)

[private]

Removes the specified rule from the specified grammar permanently.

Since: 2.0

Parameters

TMMFMessage & aMessage

message containing the information of the request.

DoRemoveRulesL(TMMFMessage &)

NewL

(

MSISpeechRecognitionCustomCommandImplementor &

aImplementor

)

[static]

Factory function for creating this class.

Since: 2.0

MDesCArray * iWordArray

MDesCArray *

iWordArray

[private]