ISpRecognizer::SetRecoState

Microsoft Speech SDK

The Microsoft.com Speech website Microsoft Speech SDK SAPI 5.1

ISpRecognizer::SetRecoState

ISpRecognizer::SetRecoState sets the state of the recognition engine.

HRESULT SetRecoState(
   SPRECOSTATE   NewState
);

Parameters

NewState
[in] One of the flags contained in the SPRECOSTATE enumeration.

Return values

Value Description
S_OK Function completed successfully.
FAILED(hr) Appropriate error message.
E_INVALIDARG One or more parameters are invalid.

Remarks

This method should not be called when the engine is currently processing audio. Calling ::SetRecoProfile with an active recognition engine can cause unexpected results, depending on how and when the SR engine reads the profile information.

A recognition profile represents a single user and training sessions on the system. The user can create, delete, and set the current profile using Speech properties in Control Panel. SAPI will always create the engine using the current default profile. This method can be used to set the SR engine to use a profile other than the default.

When using the shared recognizer, the recognizer state is a global setting. If one application changes the recognizer state, it will affect all other applications connected to the shared recognizer. For this reason, applications using a shared recognizer should take great caution before calling SetRecoState.

Changing the recognition state leads to a SPEI_RECO_STATE_CHANGE event for all interested recognition contexts.