::SetRecoState

ISpRecognizer::SetRecoState (SAPI 5.4)

Speech API 5.4
Microsoft Speech API 5.4

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

ValueDescription
S_OKFunction completed successfully.
FAILED(hr)Appropriate error message.
E_INVALIDARGOne or more parameters are invalid.

Remarks

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.

Show:
© 2016 Microsoft