SapiEvent Class

SapiEvent Class

Raised by:  SES
Base Class:  RecognitionBaseEvent
Derived Classes:  EngineEvent, SapiBinaryEvent, SapiStringEvent 

SapiEvent defines a way to send events to the Trace log when Speech Engine Services (SES) receives a SAPI event. The derived classes specify the type of SAPI event.

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.

SapiEvent 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.

EventID

Integer

The eEventId value.

AudioStreamOffset

Integer

The ullAudioStreamOffset value.

WParam

Integer

Contains encoded information that may be of use.

See Also

Event Logging Class Hierarchy | Logging and Analyzing Events | CommonEvent