ISpRecognizer
Other versions of this page are also available for the following:
.gif "A hyphen indicates that the information in this topic is not relevant for this platform, or that the platform does not support the API that is listed.")
.gif "A checkmark indicates that the information in this topic is relevant for this platform, and that any API listed is also supported on this platform.")
8/28/2008
This interface enables applications to control aspects of an SR engine and its audio input. Each object implementing this interface represents a recognizer for a single engine. A standard application may not need to call many of the methods on this interface, as SAPI tries to set up the engine sensibly by default.
Each recognizer object is connected to one or more recognition contexts (ISpRecoContext). Through the contexts, the recognizer can control the recognition grammars to be used, start and stop recognition, and receive events and recognition results.
There are two implementations of ISpRecognizer in SAPI. One is for in-process (InProc) recognition, for which the SR engine is created in the same process as the application and only this application can connect to the recognizer. The other implementation is the shared-recognizer implementation, for which the SR engine is created in a separate process. Only one shared engine will run on a system, and all applications using the shared engine connect to the same recognizer. This implementation allows several speech applications to work simultaneously, and allows the user to speak to any application, as recognition is done from the grammars of all applications.
For desktop-based speech applications, it is recommended to use the shared-recognizer implementation of ISpRecognizer, since it allows multiple SAPI applications to work at once. The InProc recognizer implementation should be used for other application types, such as an application recognizing from wave files or a telephony server application requiring multiple SR engines.
When to Implement
This interface is implemented by SAPI. Application developers use this interface but do not implement it.
There are two objects that implement this interface. These are created by applications by creating a COM object with either of the following CLSIDs:
- SpInprocRecognizer (CLSID_SpInprocRecognizer)
- SpSharedRecognizer (CLSID_SpSharedRecognizer)
Alternatively, the shared recognizer can be created by creating a SpSharedRecoContext (CLSID_SpSharedRecoContext), and then calling ISpRecoContext::GetRecognizer on this object to get a reference to the SpSharedRecognizer object.
When to Use
Your application can call methods of the ISpRecognizer interface to configure or retrieve the attributes of the SR engine.
Methods
The following table lists methods for the ISpRecognizer interface.
| Methods | Description |
|---|---|
Creates a recognition context for the SR engine object. |
|
Displays a user interface component. |
|
Emulates a recognition from a text phrase rather than from spoken audio. |
|
Gets the format of the current audio input. |
|
Gets the input token object for the stream. |
|
Gets the input stream. |
|
Identifies the SR engine that is currently being used with the recognizer. |
|
Gets the current recognition profile token. |
|
Gets the state of the recognition engine. |
|
Gets current status information for the engine. |
|
Determines if the recognizer is the shared or InProc implementation. |
|
Checks if the SR engine supports a particular user interface component. |
|
Specifies which input stream the SR engine should use. |
|
Sets the SR engine to use with the recognizer. |
|
Sets the recognition profile for the recognizer to use. |
|
Sets the state of the recognizer to reflect the SR engine state. |
Requirements
| Header | sapi.h, sapi.idl |
| Library | sapilib.lib |
| Windows Embedded CE | Windows CE .NET 4.1 and later |