IAPCSpeech::QueryFeedbackLevel

This method retrieves a description of the amount of information and detail provided in the feedback for key response and for voice commands.

Syntax

HRESULT IAPCSpeech::QueryFeedbackLevel( DWORD *pKeyFeedback, DWORD *pVoiceFeedback, DWORD *pReserved, DWORD dwFlag );-

Parameters

pKeyFeedback
Pointer to a DWORD that receives a description of the amount of information and detail provided in the feedback for key response. It is one of the following values.
APCSPCH_FB_MORE
Provides a greater amount of feedback than APCSPCH_FB_LESS, usually adding either text-to speech (TTS) feedback or prerecorded speech feedback after the speech recognition tone. This additional feedback usually consists of application-specific information or the name of the application currently in use.
APCSPCH_FB_LESS
Provides minimal feedback.
pVoiceFeedback
Pointer to a DWORD that receives a description of the amount of information and detail provided in the feedback for voice commands. It is one of the following values.
APCSPCH_FB_MORE
Provides a greater amount of feedback than APCSPCH_FB_LESS, usually adding either text-to speech (TTS) feedback or prerecorded speech feedback after the speech recognition tone. This additional feedback usually consists of application-specific information or the name of the application currently in use.
APCSPCH_FB_LESS
Provides minimal feedback.
pReserved
Reserved for future use; set to 0.
dwFlag
Reserved for future use; set to 0.

Return Values

NOERROR indicates success. If an error occurs, the appropriate HRESULT value is returned.

Remarks

An application does not need to call this method every time the application provides speech feedback. Instead, an application should only call this method during the initialization of the application. If the feedback level changes, the application receives a WM_SETTINGCHANGE message that has a wParam value equal to SPI_SETAPCFEEDBACK and a lParam value equal to NULL. An application should call IAPCSpeech::QueryFeedbackLevel again when the application receives this WM_SETTINGCHANGE message.

The IAPCSpeech interface always plays the feedback tone when hearing a voice command. When the application receives notification of the voice command, the application should play a text-to-speech (TTS) phrase or prerecorded speech if pVoiceFeedback is APCSPCH_FB_MORE.

For version 1.0, an application usually does not need to call this method to provide appropriate feedback information, because the shell and the form manager provide most of the feedback for the application. Additionally, the application receives a WM_SPCH_FEEDBACK message containing the feedback level in the low order word of the wParam of the message.

See Also

IfmManage, IASControl::Speak, WM_SPCH_FEEDBACK, WM_SETTINGCHANGE