ISpEventSource

Other versions of this page are also available for the following:

Windows Mobile Not SupportedWindows Embedded CE Supported

8/28/2008

This interface provides the mechanism to filter and queue events. It inherits from the ISpNotifySource interface, which allows an application to specify the mechanism for receiving notifications.

By default, an application (really an ISpNotifySink) receives no notifications from the SpVoice object, until ISpEventSource::SetInterest has been called to specify on which events to notify or queue. For the SpRecoContext object, the default event interest is set to queue only recognition events.

When an application is notified of an event that is not queued, the application takes measures based on the event sink that receives the notification. From context, an application may know exactly what it needs to do, or it may need to interact with the components that sent the notifications. If an application is notified of a queued event, then the application calls ISpEventSource::GetEvents to retrieve the actual events that caused a notification.

When to Implement

The following list shows what entities implement this interface.

  • SpRecoContext
  • SpSharedRecoContext
  • SpVoice
  • SpMMAudioIn
  • SpMMAudioOut
  • SpStreamFormatConverter

Methods

The following table lists the methods for the ISpEventSource interface.

Method Description

GetEvents

Gets and removes the queued events.

GetInfo

Gets information about the event queue.

SetInterest

Sets the type of events the client is interested in.

Requirements

Header sapi.h, sapi.idl
Library sapilib.lib
Windows Embedded CE Windows CE .NET 4.1 and later

See Also

Reference

SAPI Interfaces