ISpRecognizer::SetRecognizer (Microsoft Speech Platform)

Microsoft Speech Platform SDK 11

Microsoft Speech Platform

ISpRecognizer::SetRecognizer

ISpRecognizer::SetRecognizer specifies the particular speech recognition engine to be used.

HRESULT SetRecognizer(
   ISpObjectToken   *pEngineToken
);

Parameters

pEngineToken
[in] The object token referring to the speech recognition engine to be used.

Return values

Value Description
S_OK Function completed successfully.
E_INVALIDARG pEngineToken is invalid or bad.
SPERR_ENGINE_BUSY Recognition is currently running or other applications are connected to the shared recognizer.
FAILED(hr) Appropriate error message.

Remarks

This method allows the application to select a particular engine object token to be used (For example, the method SpFindBestToken could be used to find an engine supporting certain attributes, and the resulting token could be passed to this method).

If this method is not called, SAPI will use the current default SR engine.

If this method is passed NULL, SAPI will switch to the current default SR engine.

This method cannot be called when the current SR engine is already running and processing audio. In addition, when using the shared recognizer, it cannot be called if another application is also using the shared recognizer.