Symbian^3 Application Developer Library >

MNssRecognitionHandler Class Reference

class MNssRecognitionHandler

The MNssRecognitionHandler class performs the recognition function. CNssRecognitionHandler class.

NssVASApi.lib
Since
2.8
Public Member Functions
TNssRecognitionResult Cancel ()
MNssAdaptationItem * GetAdaptationItemL ()
TNssRecognitionResult PreStartSampling ( MNssRecognizeInitCompleteHandler *)
TNssRecognitionResult Recognize ( MNssRecognizeEventHandler *)
TNssRecognitionResult RecognizeInitL ( MNssRecognizeInitCompleteHandler *, TInt )
TNssRecognitionResult RecognizeInitL ( MNssRecognizeInitCompleteHandler *, const CArrayPtrFlat < MNssContext > &, TInt )
TNssRecognitionResult RejectTagL ( MNssRejectTagCompleteHandler *, CArrayPtrFlat < MNssTag > *)
TNssRecognitionResult SelectTagL ( MNssTag *)
TNssRecognitionResult SelectTagL ( MNssTag *, TBool )
Public Member Enumerations
enum TNssRecognitionResult {
EVasErrorNone , EVasRecognitionInitFailed , EVasRecognitionFailed , EVasSelectTagFailed , EVasRejectTagFailed , EVasUnexpectedRequest , EVasInvalidParameter
}

Member Functions Documentation

Cancel()

TNssRecognitionResult Cancel ( ) [pure virtual]
Cancel the last recognition function.
Since
2.0

GetAdaptationItemL()

MNssAdaptationItem * GetAdaptationItemL ( ) [pure virtual]
Get adaptation item to allow later adaptation.
Since
2.0

PreStartSampling(MNssRecognizeInitCompleteHandler *)

TNssRecognitionResult PreStartSampling ( MNssRecognizeInitCompleteHandler * aInitCompleteHandler ) [pure virtual]

Starts sampling already before RecognizeInitL and Recognize calls. This is used to ensure that there is no delay between user notification and sampling start. Asynchronous: MNssRecognizeInitCompleteHandler::HandlePreSamplingStarted will be called when ready.

Since
3.2

Parameters

MNssRecognizeInitCompleteHandler * aInitCompleteHandler Callback handler

Recognize(MNssRecognizeEventHandler *)

TNssRecognitionResult Recognize ( MNssRecognizeEventHandler * aEventHandler ) [pure virtual]
Perform the recognize function.
Since
2.0

Parameters

MNssRecognizeEventHandler * aEventHandler The event call back to receive recognize events.

RecognizeInitL(MNssRecognizeInitCompleteHandler *, TInt)

TNssRecognitionResult RecognizeInitL ( MNssRecognizeInitCompleteHandler * aInitCompleteHandler,
TInt aMaxResults
) [pure virtual]
Perform initialization for the recognize funtion.
Since
2.0

Parameters

MNssRecognizeInitCompleteHandler * aInitCompleteHandler The event call back to receive recognize init events.
TInt aMaxResults The maximum number of voice tags to be recognized.

RecognizeInitL(MNssRecognizeInitCompleteHandler *, const CArrayPtrFlat< MNssContext > &, TInt)

TNssRecognitionResult RecognizeInitL ( MNssRecognizeInitCompleteHandler * aInitCompleteHandler,
const CArrayPtrFlat < MNssContext > & aContextArray,
TInt aMaxResults
) [pure virtual]
Perform initialization for the recognize function.
Since
2.0

Parameters

MNssRecognizeInitCompleteHandler * aInitCompleteHandler The event call back to receive recognize init events.
const CArrayPtrFlat < MNssContext > & aContextArray The list of contexts to be active in recognition, i.e. recognition vocabulary.
TInt aMaxResults The maximum number of voice tags to be recognized.

RejectTagL(MNssRejectTagCompleteHandler *, CArrayPtrFlat< MNssTag > *)

TNssRecognitionResult RejectTagL ( MNssRejectTagCompleteHandler * aRejectTagCompleteHandler,
CArrayPtrFlat < MNssTag > * aClientTagList
) [pure virtual]
Request Reject Tag, i.e. blacklisting.
Since
2.0

Parameters

MNssRejectTagCompleteHandler * aRejectTagCompleteHandler
CArrayPtrFlat < MNssTag > * aClientTagList The list of voice tags which is to be rejected, i.e. blacklisted. The tag list is owned by the client.

SelectTagL(MNssTag *)

TNssRecognitionResult SelectTagL ( MNssTag * aClientTag ) [pure virtual]
Initiate the Select Tag event.
Since
2.0

Parameters

MNssTag * aClientTag The voice tag which was selected. The tag is owned by the client.

SelectTagL(MNssTag *, TBool)

TNssRecognitionResult SelectTagL ( MNssTag * aClientTag,
TBool aNotifyHandlers
) [pure virtual]
Initiate the Select Tag event.
Since
2.0

Parameters

MNssTag * aClientTag The voice tag which was selected. The tag is owned by the client.
TBool aNotifyHandlers

Member Enumerations Documentation

Enum TNssRecognitionResult

Enumerators

EVasErrorNone
EVasRecognitionInitFailed
EVasRecognitionFailed
EVasSelectTagFailed
EVasRejectTagFailed
EVasUnexpectedRequest
EVasInvalidParameter

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.