Platform SDK: Agent

ListenStart Event

Description
Occurs when Listening mode (speech recognition) begins.
Syntax
Sub agent.ListenStart (ByVal CharacterID)
Part Description
CharacterID Returns the ID of the listening character as a string.

Remarks

This event is sent to all clients when Listening mode begins because the user pressed the Listening key or the input-active client called the Listen method with True. You can use this event to avoid having your character speak while the Listening mode is on.

If you turn on Listening mode with the Listen method and then the user presses the Listening key, the Listening mode resets and continues until the Listening key time-out completes, the Listening key is released, or the user finishes speaking, whichever is later. In this situation, when Listening mode is already on, you will not get an additional ListenStart event when the user presses the Listening key.

The event returns the character to the clients that currently have this character loaded. All other clients receive a null character (empty string).

See Also

ListenComplete event, Listen method