SPRECOSTATE
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 enumeration defines engine recognition states.
Syntax
typedef enum SPRECOSTATE{
SPRST_INACTIVE,
SPRST_ACTIVE,
SPRST_ACTIVE_ALWAYS,
SPRST_INACTIVE_WITH_PURGE,
SPRST_NUM_STATES
} SPRECOSTATE;
Elements
- SPRST_INACTIVE
The engine and audio input are inactive and no audio is being read. Even if there are some active rules, recognition will not be started.
- SPRST_ACTIVE
Recognition takes place if there are any active rules. For active rules, audio is read and passed to the SR engine so that recognition can occur. This state is the default.
- SPRST_ACTIVE_ALWAYS
Audio is running regardless of the rule state. Even if there are no active rules, audio is read and passed to the engine. This state can be useful if applications want to receive volume-level events (SPEI_SR_AUDIO_LEVEL), in order to display a VU-meter or similar. See the SPEVENTENUM enumeration.
- SPRST_INACTIVE_WITH_PURGE
Engine state is set to inactive, but all active audio data is purged. This state is used when an application wants to shut an engine down as quickly as possible, without waiting for it to finish processing audio data that is currently buffered.
- SPRST_NUM_STATES
Limit checking.
Requirements
| Header | sapi.h, sapi.idl |
| Windows Embedded CE | Windows CE .NET 4.1 and later |