IAgentCharacter
[Microsoft Agent is deprecated as of Windows 7, and may be unavailable in subsequent versions of Windows.]
IAgentCharacter defines an interface that allows applications to query character properties and play animations. These functions are also available from IAgentCharacterEx. You can use some method return request IDs to track their status in the character's queue and to synchronize your code with the character's current animation state.
Methods in Vtable Order
| IAgentCharacter Methods | Description |
|---|---|
| GetVisible | Returns whether the character (frame) is currently visible. |
| SetPosition | Sets the position of the character frame. |
| GetPosition | Returns the position of the character frame. |
| SetSize | Sets the size of the character frame. |
| GetSize | Returns the size of the character frame. |
| GetName | Returns the name of the character. |
| GetDescription | Returns the description for the character. |
| GetTTSSpeed | Returns the current TTS output speed setting for the character. |
| GetTTSPitch | Returns the current TTS pitch setting for the character. |
| Activate | Sets whether a client is active or a character is topmost. |
| SetIdleOn | Sets the server's idle processing. |
| GetIdleOn | Returns the setting of the server's idle processing. |
| Prepare | Retrieves animation data for the character. |
| Play | Plays a specified animation. |
| Stop | Stops an animation for a character. |
| StopAll | Stops all animations for a character. |
| Wait | Holds the character's animation queue. |
| Interrupt | Interrupts a character's animation. |
| Show | Displays the character and plays the character's Showing state animation. |
| Hide | Plays the character's Hiding state animation and hides the character's frame. |
| Speak | Plays spoken output for the character. |
| MoveTo | Moves the character frame to the specified location. |
| GestureAt | Plays a gesturing animation based on the specified location. |
| GetMoveCause | Retrieves the cause of the character's last move. |
| GetVisibilityCause | Retrieves the cause of the last change to the character's visibility state. |
| HasOtherClients | Retrieves whether the character has other current clients. |
| SetSoundEffectsOn | Determines whether a character animation's sound effects play. |
| GetSoundEffectsOn | Retrieves whether a character's sound effects setting is enabled. |
| SetName | Sets the character's name. |
| SetDescription | Sets the character's description. |
| GetExtraData | Retrieves additional data stored with the character. |