RecognitionCompleteEvent Class

RecognitionCompleteEvent Class

Abstract:  Yes
Raised by:  Not applicable
Base Class:  RecognitionBaseEvent
Derived Classes:  BabbleTimeoutEvent, OnNoRecoEvent, OnRecoEvent, OnSilenceEvent 

The abstract RecognitionCompleteEvent class defines an event type to log whenever Speech Engine Services (SES) receives a recognition result from SAPI. The derived classes then specify the SAPI result.

Note  This and all other event classes derived from RecognitionBaseEvent, are gathered only in the DetailedSRMessages category, and are intended primarily for internal use by Microsoft, to tune recognition engine effectiveness.

RecognitionCompleteEvent has the following properties:

Property

Type

Description

RecognitionID

String

The identifier for the recognition session. This property is consistently used across all recognition result events, SAPI and Engine events, and audio and grammar events.

GrammarData

GrammarArray

A customized array consisting of one entry for each grammar specified, including grammars referenced by this grammar, if any.

InlineGrammar

InlineGrammarArray

A customized array consisting of one entry for each inline grammar specified, including grammars referenced by this grammar, if any.

SPEventWParam

Integer

Contains encoded information within the wParam of the SAPI SPEVENT structure.

SPPhrase

ByteArray

The serialized SPPHRASE element from SAPI.

SREngine

String

The recognition engine that received the result.

See Also

Event Logging Class Hierarchy | Logging and Analyzing Events | CommonEvent