Edit

Get Method

  • Article

[Microsoft Agent is deprecated as of Windows 7, and may be unavailable in subsequent versions of Windows.]

Description

Retrieves specified animation data for the specified character.

Syntax

agent**.Characters ("CharacterID").Get** Type, Name, [Queue]

Part Description
Type Required. A string value that indicates the animation data type to load. "Animation" A character's animation data.
"State" A character's state data.
"WaveFile" A character's audio (for spoken output) file.
Name Required. A string that indicates the name of the animation type. "name" The name of the animation or state.
For animations, the name is based on that defined for the character when saved using the Microsoft Agent Character Editor.
For states, the following values can be used:
"Gesturing" To get all Gesturing state animations.
"GesturingDown" To get the GesturingDown animation.
"GesturingLeft" To get the GesturingLeft animation.
"GesturingRight" To get the GesturingRight animation.
"GesturingUp" To get the GesturingUp animation.
"Hiding" To get the Hiding state animation.
"Hearing" To get the Hearing state animation.
"Idling" To get all Idling state animations.
"IdlingLevel1" To get all IdlingLevel1 animations.
"IdlingLevel2" To get all IdlingLevel2 animations.
"IdlingLevel3" To get all IdlingLevel3 animations.
"Listening" To get the Listening state animation.
"Moving" To get all Moving state animations.
"MovingDown" To get the MovingDown animation.
"MovingLeft" To get the MovingLeft animation.
"MovingRight" To get the MovingRight animation.
"MovingUp" To get the MovingUp animation.
"Showing" To get the Showing state animation.
"Speaking" To get the Speaking state animation.
You can specify multiple animations and states by separating them with commas. However, you cannot mix types in the same Get statement.
"URL or filespec" The specification for the sound (.WAV or .LWV) file. If the specification is not complete, it is interpreted as being relative to the specification used in the Load method.
Queue Optional. A Boolean expression specifying whether the server queues the Get request. True (Default) Queues the Get request. Any animation request that follows the Get request (for the same character) waits until the animation data is loaded.
False Does not queue the Get request.

Remarks

If you load a character using the HTTP protocol (an .ACF file), you must use the Get method to retrieve animation data before you can play the animation. You do not use this method if you loaded the character using the UNC protocol (an .ACS file). You also cannot retrieve HTTP data for a character using Get if you loaded that character using the UNC protocol (.ACS character file).

If you declare an object reference and set it to this method, it returns a Request object. If the associated animation fails to load, the server sets the Request object's Status property to "failed" with an appropriate error number. You can use the RequestComplete event to check the status and determine what action to take.

Animation or sound data retrieved with the Get method is stored in the browser's cache. Subsequent calls will check the cache, and if the animation data is already there, the control loads the data directly from the cache. Once loaded, the animation or sound data can be played with the Play or Speak methods.

See Also

Load method