| Platform SDK: Agent |
| Part | Description |
|---|---|
| CharacterID | Returns the ID of the listening character as a string. |
| Cause | Returns the cause of the complete event as an integer that may be one of the following:
1 Listening mode was turned off by program code. 2 Listening mode (turned on by program code) timed out. 3 Listening mode (turned on by the Listening key) timed out. 4 Listening mode was turned off because the user released the Listening key. 5 Listening mode ended because the user finished speaking. 6 Listening mode ended because the input-active client was deactivated. 7 Listening mode ended because the default character was changed. 8 Listening mode ended because the user disabled speech input. |
This event is sent to all clients when the Listening mode time-out ends, after the user releases the Listening key, when the input active client calls the Listen method with False, or the user finished speaking. You can use this event to determine when to resume character spoken (audio) output.
If you turn on Listening mode using 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, you will not receive a ListenComplete event until the listening key's mode completes.
The event returns the character to the clients that currently have this character loaded. All other clients receive a null character (empty string).