Platform SDK: Agent

GlobalVoiceCommandsEnabled Property

Description
Returns or sets whether voice is enabled for Agent's global commands.
Syntax
agent.Characters ("CharacterID").Commands.GlobalVoiceCommandsEnabled
[ = boolean]
Part Description
boolean A Boolean expression that indicates whether voice parameters for Agent's global commands are enabled.

True (Default) Voice parameters are enabled.

False Voice parameters are disabled.


Remarks

Microsoft Agent automatically adds voice parameters (grammar) for opening and closing the Voice Commands Window and for showing and hiding the character. If you set GlobalVoiceCommandsEnabled to False, Agent disables any voice parameters for these commands as well as the voice parameters for the Caption of other client's Commands objects. This enables you to eliminate these from your client's current active grammar. However, because this potentially blocks voice access to other clients, reset this property to True after processing the user's voice input.

Disabling the property does not affect the character's pop-up menu. The global commands added by the server will still appear. You cannot remove them from the pop-up menu.