RSISpeechRecognitionCustomCommands Class Reference

class RSISpeechRecognitionCustomCommands : public RMMFCustomCommandsBase

This is the main class of NSS Speaker Independent Speech Recognition Custom Commands

nsssispeechrecognitioncustomcommands.lib
Since
2.8

Inherits from

Public Member Functions
RSISpeechRecognitionCustomCommands ( RMMFController &)
IMPORT_C TInt ActivateGrammar ( TSIGrammarID )
IMPORT_C TInt Adapt (const CSIClientResultSet &, TInt )
IMPORT_C TInt AddPronunciation ( TSILexiconID , const TDesC &, TLanguage , TSIPronunciationID &)
IMPORT_C TInt AddRule ( TSIGrammarID , TSILexiconID , TSIPronunciationID , TSIRuleID &)
IMPORT_C TInt AddRuleVariant ( TSIGrammarID , TSILexiconID , const RArray < TSIPronunciationID > &, TSIRuleID , TSIRuleVariantID &)
IMPORT_C TInt AddVoiceTag (const MDesCArray &, const RArray < TLanguage > &, TSILexiconID , TSIGrammarID , TSIRuleID &)
IMPORT_C TInt AddVoiceTag (const MDesCArray &, const RArray < RLanguageArray > &, TSILexiconID , TSIGrammarID , TSIRuleID &)
IMPORT_C TInt AddVoiceTags (const RPointerArray < MDesCArray > &, const RArray < TLanguage > &, TSILexiconID , TSIGrammarID , RArray < TSIRuleID > &)
IMPORT_C TInt AddVoiceTags (const RPointerArray < MDesCArray > &, const RArray < RLanguageArray > &, TSILexiconID , TSIGrammarID , RArray < TSIRuleID > &)
IMPORT_C void Cancel ()
IMPORT_C TInt CommitChanges ()
IMPORT_C TInt CreateGrammar ( TSIGrammarID &)
IMPORT_C TInt CreateLexicon ( TSILexiconID &)
IMPORT_C TInt CreateModelBank ( TSIModelBankID &)
IMPORT_C TInt CreateRule ( TSIGrammarID , TSIRuleID &)
IMPORT_C TInt DeactivateGrammar ( TSIGrammarID )
IMPORT_C TInt EndRecSession ()
IMPORT_C TInt EndRecord ()
IMPORT_C TInt GetAllClientGrammarIDs ()
IMPORT_C TInt GetAllClientLexiconIDs ()
IMPORT_C TInt GetAllClientModelBankIDs ()
IMPORT_C TInt GetAllGrammarIDs ()
IMPORT_C TInt GetAllLexiconIDs ()
IMPORT_C TInt GetAllModelBankIDs ()
IMPORT_C TInt GetAllModelIDs ( TSIModelBankID )
IMPORT_C TInt GetAllPronunciationIDs ( TSILexiconID )
IMPORT_C TInt GetAllRuleIDs ( TSIGrammarID )
IMPORT_C TInt GetEngineProperties (const RArray < TInt > &, RArray < TInt > &)
IMPORT_C void GetGrammarIDArrayL ( RArray < TSIGrammarID > &)
IMPORT_C void GetLexiconIDArrayL ( RArray < TSILexiconID > &)
IMPORT_C void GetModelBankIDArrayL ( RArray < TSIModelBankID > &)
IMPORT_C TInt GetModelCount ( TSIModelBankID , TInt &)
IMPORT_C void GetModelIDArrayL ( RArray < TSIModelID > &)
IMPORT_C void GetPronunciationIDArrayL ( RArray < TSIPronunciationID > &)
IMPORT_C void GetRuleIDArrayL ( RArray < TSIRuleID > &)
IMPORT_C TInt GetRuleValidity ( TSIGrammarID , TSIRuleID , TBool &)
IMPORT_C void GetSIResultSetL ( CSIClientResultSet &)
IMPORT_C TInt LoadEngineParameters (const RArray < TInt > &, const RArray < TInt > &)
IMPORT_C TInt LoadGrammar ( TSIGrammarID )
IMPORT_C TInt LoadLexicon ( TSILexiconID )
IMPORT_C TInt LoadModels ( TSIModelBankID )
IMPORT_C TInt PreStartSampling ()
IMPORT_C TInt Recognize ( CSIClientResultSet &)
IMPORT_C TInt Record ( TTimeIntervalMicroSeconds32 )
IMPORT_C TInt RemoveGrammar ( TSIGrammarID )
IMPORT_C TInt RemoveLexicon ( TSILexiconID )
IMPORT_C TInt RemoveModel ( TSIModelBankID , TSIModelID )
IMPORT_C TInt RemoveModelBank ( TSIModelBankID )
IMPORT_C TInt RemovePronunciation ( TSILexiconID , TSIPronunciationID )
IMPORT_C TInt RemoveRule ( TSIGrammarID , TSIRuleID )
IMPORT_C TInt RemoveRules ( TSIGrammarID , RArray < TSIRuleID > &)
IMPORT_C TInt SetClientUid ( TUid )
IMPORT_C TInt StartRecSession ( TNSSRecognitionMode )
IMPORT_C TInt UnloadGrammar ( TSIGrammarID )
IMPORT_C TInt UnloadRule ( TSIGrammarID , TSIRuleID )
Private Member Functions
void DoGetEnginePropertiesL (const RArray < TInt > &, RArray < TInt > &)
void DoLoadEngineParametersL (const RArray < TInt > &, const RArray < TInt > &)
void DoRecognizeL (CSDClientResultSet &)
void DoRecognizeSIL ( CSIClientResultSet &)
CBufFlat * ExternalizeIntArrayL (const RArray < TInt > &)
void InternalizeIntArrayL ( TDes8 &, TInt , RArray < TInt > &)
Inherited Functions
RMMFCustomCommandsBase::RMMFCustomCommandsBase(RMMFController &,TUid)
Private Attributes
TAny * iReservedPtr_1
TAny * iReservedPtr_2
Inherited Attributes
RMMFCustomCommandsBase::iController
RMMFCustomCommandsBase::iDestinationPckg

Constructor & Destructor Documentation

RSISpeechRecognitionCustomCommands(RMMFController &)

IMPORT_C RSISpeechRecognitionCustomCommands ( RMMFController & aController )

Public C++ constructor for RSpeechRecognitionCustomCommands class.

Since
2.8

Parameters

RMMFController & aController reference to RMMFController object

Member Functions Documentation

ActivateGrammar(TSIGrammarID)

IMPORT_C TInt ActivateGrammar ( TSIGrammarID aGrammarID )

Activates a loaded and deactivated grammar.

Since
2.8

Parameters

TSIGrammarID aGrammarID grammar Id

Adapt(const CSIClientResultSet &, TInt)

IMPORT_C TInt Adapt ( const CSIClientResultSet & aResultSet,
TInt aCorrect
)

Adapts speaker independent models according using a correct recognition result.

Since
2.8

Parameters

const CSIClientResultSet & aResultSet The result N-Best containing feature vectors aCorrect The correct index
TInt aCorrect

AddPronunciation(TSILexiconID, const TDesC &, TLanguage, TSIPronunciationID &)

IMPORT_C TInt AddPronunciation ( TSILexiconID aLexiconID,
const TDesC & aTrainText,
TLanguage aLanguage,
TSIPronunciationID & aPronunciationID
)

Adds a pronunciation to the given lexicon.

Since
2.8

Parameters

TSILexiconID aLexiconID The lexicon Id
const TDesC & aTrainText Text to be pronounced
TLanguage aLanguage Pronunciation language
TSIPronunciationID & aPronunciationID Reference where a new pronunciation Id is assigned to.

AddRule(TSIGrammarID, TSILexiconID, TSIPronunciationID, TSIRuleID &)

IMPORT_C TInt AddRule ( TSIGrammarID aGrammarID,
TSILexiconID aLexiconID,
TSIPronunciationID aPronunciationID,
TSIRuleID & aRuleID
)
Adds a new rule for the given pronunciation into the specified grammar.
Since
2.0

Parameters

TSIGrammarID aGrammarID grammar Id, where the new rule is added to
TSILexiconID aLexiconID lexicon Id
TSIPronunciationID aPronunciationID pronunciation Id
TSIRuleID & aRuleID reference where a new rule Id is assigned to

AddRuleVariant(TSIGrammarID, TSILexiconID, const RArray< TSIPronunciationID > &, TSIRuleID, TSIRuleVariantID &)

IMPORT_C TInt AddRuleVariant ( TSIGrammarID aGrammarID,
TSILexiconID aLexiconID,
const RArray < TSIPronunciationID > & aPronunciationIDs,
TSIRuleID aRuleID,
TSIRuleVariantID & aRuleVariantID
)

Adds a rule variant to a grammar.

Since
2.8

Parameters

TSIGrammarID aGrammarID Grammar identifier
TSILexiconID aLexiconID
const RArray < TSIPronunciationID > & aPronunciationIDs
TSIRuleID aRuleID Rule identifier; variant is added here.
TSIRuleVariantID & aRuleVariantID Reference where the new variant identifier is assigned to.

AddVoiceTag(const MDesCArray &, const RArray< TLanguage > &, TSILexiconID, TSIGrammarID, TSIRuleID &)

IMPORT_C TInt AddVoiceTag ( const MDesCArray & aTrainArray,
const RArray < TLanguage > & aLanguageArray,
TSILexiconID aLexiconID,
TSIGrammarID aGrammarID,
TSIRuleID & aRuleID
)

Trains a voice tag. Adds the text to the lexicon, and creates the required rules and rule variants.

Since
2.8

Parameters

const MDesCArray & aTrainArray The phrase to be trained, split into subwords
const RArray < TLanguage > & aLanguageArray The pronunciaiton languages
TSILexiconID aLexiconID Lexicon identifier
TSIGrammarID aGrammarID Grammar identifier
TSIRuleID & aRuleID Reference, where the new rule identifier is assigned to.

AddVoiceTag(const MDesCArray &, const RArray< RLanguageArray > &, TSILexiconID, TSIGrammarID, TSIRuleID &)

IMPORT_C TInt AddVoiceTag ( const MDesCArray & aTrainArray,
const RArray < RLanguageArray > & aLanguageArray,
TSILexiconID aLexiconID,
TSIGrammarID aGrammarID,
TSIRuleID & aRuleID
)

Trains a voice tag. Adds the text to the lexicon, and creates the required rules and rule variants.

Since
3.1

Parameters

const MDesCArray & aTrainArray The phrase to be trained, split into subwords
const RArray < RLanguageArray > & aLanguageArray The pronunciaiton languages
TSILexiconID aLexiconID Lexicon identifier
TSIGrammarID aGrammarID Grammar identifier
TSIRuleID & aRuleID Reference, where the new rule identifier is assigned to.

AddVoiceTags(const RPointerArray< MDesCArray > &, const RArray< TLanguage > &, TSILexiconID, TSIGrammarID, RArray< TSIRuleID > &)

IMPORT_C TInt AddVoiceTags ( const RPointerArray < MDesCArray > & aTrainArray,
const RArray < TLanguage > & aLanguageArray,
TSILexiconID aLexiconID,
TSIGrammarID aGrammarID,
RArray < TSIRuleID > & aRuleID
)

Trains voice tags. If the training fails for some of the names (but not all), it is signaled by setting the Rule ID to KInvalidRuleID.

Since
2.8

Parameters

const RPointerArray < MDesCArray > & aTrainArray The phrase to be trained, split into subwords
const RArray < TLanguage > & aLanguageArray The pronunciation languages
TSILexiconID aLexiconID Lexicon identifier
TSIGrammarID aGrammarID Grammar identifier
RArray < TSIRuleID > & aRuleID Referenceto an array, where the new Rule identifiers are assigned to.

AddVoiceTags(const RPointerArray< MDesCArray > &, const RArray< RLanguageArray > &, TSILexiconID, TSIGrammarID, RArray< TSIRuleID > &)

IMPORT_C TInt AddVoiceTags ( const RPointerArray < MDesCArray > & aTrainArray,
const RArray < RLanguageArray > & aLanguageArray,
TSILexiconID aLexiconID,
TSIGrammarID aGrammarID,
RArray < TSIRuleID > & aRuleID
)

Trains voice tags. If the training fails for some of the names (but not all), it is signaled by setting the Rule ID to KInvalidRuleID.

Since
3.1

Parameters

const RPointerArray < MDesCArray > & aTrainArray The phrase to be trained, split into subwords
const RArray < RLanguageArray > & aLanguageArray The pronunciation languages
TSILexiconID aLexiconID Lexicon identifier
TSIGrammarID aGrammarID Grammar identifier
RArray < TSIRuleID > & aRuleID Referenceto an array, where the new Rule identifiers are assigned to.

Cancel()

IMPORT_C void Cancel ( )
Cancels the current operation
Since
2.0

CommitChanges()

IMPORT_C TInt CommitChanges ( )
Saves the current changes into permanent storage.
Since
2.0

CreateGrammar(TSIGrammarID &)

IMPORT_C TInt CreateGrammar ( TSIGrammarID & aGrammarID )
Creates a new grammar.
Since
2.0

Parameters

TSIGrammarID & aGrammarID reference where grammar ID is stored

CreateLexicon(TSILexiconID &)

IMPORT_C TInt CreateLexicon ( TSILexiconID & aLexiconID )
Creates a new lexicon.
Since
2.0

Parameters

TSILexiconID & aLexiconID reference where lexicon ID is stored

CreateModelBank(TSIModelBankID &)

IMPORT_C TInt CreateModelBank ( TSIModelBankID & aModelBankID )
Creates a new model bank.
Since
2.0

Parameters

TSIModelBankID & aModelBankID reference where a new model bank Id is assigned to

CreateRule(TSIGrammarID, TSIRuleID &)

IMPORT_C TInt CreateRule ( TSIGrammarID aGrammarID,
TSIRuleID & aRuleID
)

Creates a new rule.

Since
2.8

Parameters

TSIGrammarID aGrammarID Grammar identifier
TSIRuleID & aRuleID Reference where rule ID is stored

DeactivateGrammar(TSIGrammarID)

IMPORT_C TInt DeactivateGrammar ( TSIGrammarID aGrammarID )

Deactivates a loaded grammar so that it is not recognized.

Since
2.8

Parameters

TSIGrammarID aGrammarID grammar Id

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

void DoGetEnginePropertiesL ( const RArray < TInt > & aPropertyId,
RArray < TInt > & aPropertyValue
) [private]
Returns the engine properties specified by the engine property ID array. On return aPropertyValue contains an array of engine properties. This function does the actual work.
Since
2.0

Parameters

const RArray < TInt > & aPropertyId constant reference to array of engine property Ids
RArray < TInt > & aPropertyValue reference to array of engine property values

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

void DoLoadEngineParametersL ( const RArray < TInt > & aParameterId,
const RArray < TInt > & aParameterValue
) [private]
Uploads the specified parameters into the engine. This function does the actual work.
Since
2.0

Parameters

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

DoRecognizeL(CSDClientResultSet &)

void DoRecognizeL ( CSDClientResultSet & aResultSet ) [private]
Initiates recognition; performed following loading of model bank, lexicon, and grammar. This function does the actual work and is trapped by the public Recognize() function.
Since
2.0

Parameters

CSDClientResultSet & aResultSet reference where the recognition result is set

DoRecognizeSIL(CSIClientResultSet &)

void DoRecognizeSIL ( CSIClientResultSet & aResultSet ) [private]
Initiates speaker independent recognition; performed following loading of model bank, lexicon, and grammar. This function does the actual work and is trapped by the public Recognize() function.
Since
2.8

Parameters

CSIClientResultSet & aResultSet reference where the recognition result is set

EndRecSession()

IMPORT_C TInt EndRecSession ( )
Ends the current recognition session. Resources allocated for recognition are freed.
Since
2.0

EndRecord()

IMPORT_C TInt EndRecord ( )

Stops recognition. Unlike Cancel() , this function gives the recognition result, if it can be guessed.

Since
2.8

ExternalizeIntArrayL(const RArray< TInt > &)

CBufFlat * ExternalizeIntArrayL ( const RArray < TInt > & aArray ) [private]
Externalize an integer array.
Since
2.0

Parameters

const RArray < TInt > & aArray array to externalize

GetAllClientGrammarIDs()

IMPORT_C TInt GetAllClientGrammarIDs ( )
Returns all grammar Ids that belong to the current client.
Since
2.0

GetAllClientLexiconIDs()

IMPORT_C TInt GetAllClientLexiconIDs ( )
Returns all lexicon Ids that belong to the current client.
Since
2.0

GetAllClientModelBankIDs()

IMPORT_C TInt GetAllClientModelBankIDs ( )
Returns all model bank Ids that belong to the current client.
Since
2.0

GetAllGrammarIDs()

IMPORT_C TInt GetAllGrammarIDs ( )
Returns all grammar Ids that exist (for all clients).
Since
2.0

GetAllLexiconIDs()

IMPORT_C TInt GetAllLexiconIDs ( )
Returns all lexicon Ids that exist (for all clients).
Since
2.0

GetAllModelBankIDs()

IMPORT_C TInt GetAllModelBankIDs ( )
Returns all model bank Ids that exist (for all clients).
Since
2.0

GetAllModelIDs(TSIModelBankID)

IMPORT_C TInt GetAllModelIDs ( TSIModelBankID aModelBankID )
Returns all model Ids that exist in the specified model bank.
Since
2.0

Parameters

TSIModelBankID aModelBankID model bank Id

GetAllPronunciationIDs(TSILexiconID)

IMPORT_C TInt GetAllPronunciationIDs ( TSILexiconID aLexiconID )
Returns all pronunciation Ids that exist in the specified lexicon.
Since
2.0

Parameters

TSILexiconID aLexiconID lexicon Id

GetAllRuleIDs(TSIGrammarID)

IMPORT_C TInt GetAllRuleIDs ( TSIGrammarID aGrammarID )
Returns all rule Ids that exist in the specified grammar.
Since
2.0

Parameters

TSIGrammarID aGrammarID grammar Id

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

IMPORT_C TInt GetEngineProperties ( const RArray < TInt > & aPropertyId,
RArray < TInt > & aPropertyValue
)
Returns the engine properties specified by the engine property ID array. On return aPropertyValue contains an array of engine properties.
Since
2.0

Parameters

const RArray < TInt > & aPropertyId constant reference to array of engine property Ids
RArray < TInt > & aPropertyValue reference to array of engine property values

GetGrammarIDArrayL(RArray< TSIGrammarID > &)

IMPORT_C void GetGrammarIDArrayL ( RArray < TSIGrammarID > & aGrammarIDs )
Get the grammar ID array. On return aGrammarIDs contains an array of rule IDs.
Since
2.0

Parameters

RArray < TSIGrammarID > & aGrammarIDs

GetLexiconIDArrayL(RArray< TSILexiconID > &)

IMPORT_C void GetLexiconIDArrayL ( RArray < TSILexiconID > & aLexiconIDs )
Get the lexicon ID array. On return aLexiconIDs contains an array of lexicon IDs.
Since
2.0

Parameters

RArray < TSILexiconID > & aLexiconIDs

GetModelBankIDArrayL(RArray< TSIModelBankID > &)

IMPORT_C void GetModelBankIDArrayL ( RArray < TSIModelBankID > & aModelBankIDs )
Get the model bank ID array. On return aModelBankIDs contains an array of model bank IDs.
Since
2.0

Parameters

RArray < TSIModelBankID > & aModelBankIDs

GetModelCount(TSIModelBankID, TInt &)

IMPORT_C TInt GetModelCount ( TSIModelBankID aModelBankID,
TInt & aModelCount
)
Returns the number of models in the specified model bank.
Since
2.0

Parameters

TSIModelBankID aModelBankID model bank Id
TInt & aModelCount

GetModelIDArrayL(RArray< TSIModelID > &)

IMPORT_C void GetModelIDArrayL ( RArray < TSIModelID > & aModelIDs )
Get the model ID array. On return aModelIDs contains an array of model IDs.
Since
2.0

Parameters

RArray < TSIModelID > & aModelIDs array of model IDs

GetPronunciationIDArrayL(RArray< TSIPronunciationID > &)

IMPORT_C void GetPronunciationIDArrayL ( RArray < TSIPronunciationID > & aPronunciationIDs )
Get the pronunciation ID array. On return aPronunciationIDs contains an array of pronunciation IDs.
Since
2.0

Parameters

RArray < TSIPronunciationID > & aPronunciationIDs array of pronunciation IDs

GetRuleIDArrayL(RArray< TSIRuleID > &)

IMPORT_C void GetRuleIDArrayL ( RArray < TSIRuleID > & aRuleIDs )
Get the rule ID array. On return aRuleIDs contains an array of rule IDs.
Since
2.0

Parameters

RArray < TSIRuleID > & aRuleIDs array of rule IDs

GetRuleValidity(TSIGrammarID, TSIRuleID, TBool &)

IMPORT_C TInt GetRuleValidity ( TSIGrammarID aGrammarID,
TSIRuleID aRuleID,
TBool & aValid
)
Checks if the rule is valid or not.
Since
2.0

Parameters

TSIGrammarID aGrammarID grammar Id
TSIRuleID aRuleID rule Id
TBool & aValid reference where the validity of the rule is set

GetSIResultSetL(CSIClientResultSet &)

IMPORT_C void GetSIResultSetL ( CSIClientResultSet & aResultSet )
Get the client result set. This function should be called after recognition. On return aResultSet contains client result set.
Since
2.8

Parameters

CSIClientResultSet & aResultSet Result set to be populated.

InternalizeIntArrayL(TDes8 &, TInt, RArray< TInt > &)

void InternalizeIntArrayL ( TDes8 & aDes,
TInt aNumberElements,
RArray < TInt > & aArray
) [private]
Internalize an integer array.
Since
2.0

Parameters

TDes8 & aDes descriptor containing the data to internalize
TInt aNumberElements number of elements to internalize
RArray < TInt > & aArray contains the internalized array on exit

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

IMPORT_C TInt LoadEngineParameters ( const RArray < TInt > & aParameterId,
const RArray < TInt > & aParameterValue
)
Uploads the specified parameters into the engine.
Since
2.0

Parameters

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

LoadGrammar(TSIGrammarID)

IMPORT_C TInt LoadGrammar ( TSIGrammarID aGrammarID )

Loads a grammar. Grammars are loaded between StartRecSession() and Recognize()

Since
2.0

Parameters

TSIGrammarID aGrammarID grammar Id

LoadLexicon(TSILexiconID)

IMPORT_C TInt LoadLexicon ( TSILexiconID aLexiconID )
Loads the specified lexicon into the recognizer; done prior to recognition.
Since
2.0

Parameters

TSILexiconID aLexiconID lexicon ID

LoadModels(TSIModelBankID)

IMPORT_C TInt LoadModels ( TSIModelBankID aModelBankID )
Loads the specified model bank into the recognizer; done prior to recognition..
Since
2.0

Parameters

TSIModelBankID aModelBankID model bank Id

PreStartSampling()

IMPORT_C TInt PreStartSampling ( )

Pre-starts recording before Record() call.

Since
3.2

Recognize(CSIClientResultSet &)

IMPORT_C TInt Recognize ( CSIClientResultSet & aResultSet )

Starts recognition

Since
2.8

Parameters

CSIClientResultSet & aResultSet Recognition result is placed here, when ready.

Record(TTimeIntervalMicroSeconds32)

IMPORT_C TInt Record ( TTimeIntervalMicroSeconds32 aRecordTime )
Records uder utterance for training and recognition.
Since
2.0

Parameters

TTimeIntervalMicroSeconds32 aRecordTime recording time in microseconds

RemoveGrammar(TSIGrammarID)

IMPORT_C TInt RemoveGrammar ( TSIGrammarID aGrammarID )
Removes the specified grammar from the permanent storage. Removing a grammar will remove all rules within the grammar.
Since
2.0

Parameters

TSIGrammarID aGrammarID grammar Id

RemoveLexicon(TSILexiconID)

IMPORT_C TInt RemoveLexicon ( TSILexiconID aLexiconID )
Removes the specified lexicon from the permanent storage. Removing a lexicon will remove all pronunciations within the lexicon.
Since
2.0

Parameters

TSILexiconID aLexiconID lexicon Id

RemoveModel(TSIModelBankID, TSIModelID)

IMPORT_C TInt RemoveModel ( TSIModelBankID aModelBankID,
TSIModelID aModelID
)
Removes the specified model from the specified model bank permanently.
Since
2.0

Parameters

TSIModelBankID aModelBankID model bank Id
TSIModelID aModelID model Id

RemoveModelBank(TSIModelBankID)

IMPORT_C TInt RemoveModelBank ( TSIModelBankID aModelBankID )
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

TSIModelBankID aModelBankID model bank Id

RemovePronunciation(TSILexiconID, TSIPronunciationID)

IMPORT_C TInt RemovePronunciation ( TSILexiconID aLexiconID,
TSIPronunciationID aPronunciationID
)
Removes the specified pronunciation from the specified lexicon permanently.
Since
2.0

Parameters

TSILexiconID aLexiconID lexicon Id
TSIPronunciationID aPronunciationID pronunciation Id

RemoveRule(TSIGrammarID, TSIRuleID)

IMPORT_C TInt RemoveRule ( TSIGrammarID aGrammarID,
TSIRuleID aRuleID
)
Removes the specified rule from the specified grammar permanently.
Since
2.0

Parameters

TSIGrammarID aGrammarID grammar Id
TSIRuleID aRuleID rule Id

RemoveRules(TSIGrammarID, RArray< TSIRuleID > &)

IMPORT_C TInt RemoveRules ( TSIGrammarID aGrammarID,
RArray < TSIRuleID > & aRuleIDs
)
Removes the specified rule from the specified grammar permanently.
Since
2.8

Parameters

TSIGrammarID aGrammarID grammar Id
RArray < TSIRuleID > & aRuleIDs array of rule ids

SetClientUid(TUid)

IMPORT_C TInt SetClientUid ( TUid aClientUid )
Sets the client's UID for data ownership identification.
Since
2.0

Parameters

TUid aClientUid client's UID

StartRecSession(TNSSRecognitionMode)

IMPORT_C TInt StartRecSession ( TNSSRecognitionMode aMode )
Starts a new recognition session.
Since
2.0

Parameters

TNSSRecognitionMode aMode recognition mode

UnloadGrammar(TSIGrammarID)

IMPORT_C TInt UnloadGrammar ( TSIGrammarID aGrammarID )

Deactivates a grammar.

Since
2.8

Parameters

TSIGrammarID aGrammarID Grammar identifier

UnloadRule(TSIGrammarID, TSIRuleID)

IMPORT_C TInt UnloadRule ( TSIGrammarID aGrammarID,
TSIRuleID aRuleID
)
Unloads the specified rule from the specified grammar in temporary memory, previously loaded with LoadGrammarL. The rule in the permanent storage remains intact.
Since
2.0

Parameters

TSIGrammarID aGrammarID grammar Id
TSIRuleID aRuleID rule Id

Member Data Documentation

TAny * iReservedPtr_1

TAny * iReservedPtr_1 [private]

TAny * iReservedPtr_2

TAny * iReservedPtr_2 [private]