ISpRecognizer::GetRecoState (Microsoft Speech Platform)

Microsoft Speech Platform SDK 11

Microsoft Speech Platform

ISpRecognizer::GetRecoState

ISpRecognizer::GetRecoState retrieves the current state of the recognition engine.

HRESULT GetRecoState(
   SPRECOSTATE   *pState
);

Parameters

pState
[out] One of the input state flags contained in the SPRECOSTATE enumeration.

Return values

Value Description
S_OK Function completed successfully.
E_INVALIDARG Invalid pointer.
FAILED(hr) Appropriate error message.

Remarks

This method determines whether audio is currently being read from the audio input stream and passed to the SR engine.

See also ISpRecognizer::SetRecoState

The default recognizer state is SPRST_ACTIVE, which means SAPI will activate the audio input stream only when at least one top-level rule is active.

To be notified when the recognizer state changes (e.g. another application changes the shared SR engine's recognizer state), rather than polling the state with ::GetRecoState, call ISpEventSource::SetInterest with SPEI_RECO_STATE

.