Platform SDK: Agent

IAgentSpeechInputProperties

IAgentSpeechInputProperties provides access to the speech input properties maintained by the server. Most of the properties are read-only for client applications, but the user can change them in the Microsoft Agent property sheet. The Microsoft Agent server returns values only if a compatible speech engine has been installed and is enabled. Querying these properties attempts to start the speech engine.

Methods in Vtable Order

IAgentSpeechInputProperties Methods Description
GetEnabled Returns whether the speech recognition engine is enabled.
GetHotKey Returns the current key assignment of the Listening key.
GetListeningTip Returns whether the Listening Tip is enabled.

GetInstalled, GetLCID, GetEngine, and SetEngine methods (supported in earlier versions of Microsoft Agent) are still supported for backward compatibility. However, the methods are not stubbed and do not return useful values. Use GetSRModeID and SetSRModeID to query and set the speech recognition engine to be used with the character. Keep in mind that the engine must match the character's current language setting.