ISpRecognizer::EmulateRecognition
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 method emulates a recognition from a specified phrase rather than from spoken content.
This can be used for testing by simulating user speech, and can be used by applications where users have the option to type or speak a command. The phrase can be generated by creating a phrase builder object and then adding elements representing the text to it. See the SDK Sample Simple Recognition (Reco.exe) for the function CreatePhraseFromText as an example of using ISpPhraseBuilder.
All the events will be fired back to the application exactly as if a typical recognition had taken place. The result phrase will have the semantic properties set in the same way a real result would. A recognition event will only be produced if the text actually parses through the active rules (if dictation is active, any text will parse). Another application or ISpRecoContext containing an active rule that can parse the text can receive the emulated recognition.
Syntax
HRESULT EmulateRecognition(
ISpPhrase* pPhrase
);
Parameters
- pPhrase
[in] Pointer to an object implementing ISpPhrase that represents the phrase to emulate.
Return Value
The following table shows the possible return values.
| Value | Description |
|---|---|
S_OK |
Function completed successfully. |
SP_NO_PARSE_FOUND |
Function completed successfully but the phrase does not parse through any active rule. |
SP_NO_RULES_ACTIVE |
Function completed successfully but there are no active rules to parse. |
E_POINTER |
ppCoMemPhrase is invalid or bad. |
SPERR_UNINITIALIZED |
Phrase is uninitialized. |
E_OUTOFMEMORY |
Exceeded available memory. |
FAILED(hr) |
Appropriate error message. |
Remarks
In the case of ambiguous rules or CFG paths, this method uses an arbitrary rule or path. For example, if a grammar has two ambiguous rules, the first containing the phrase "a b c", and the second containing only a dictation tag (such as <DICTATION/>), the rule recognized at run time may not be consistent.
Requirements
| Header | sapi.h, sapi.idl |
| Library | sapilib.lib |
| Windows Embedded CE | Windows CE .NET 4.1 and later |