VHuman BML Messages
From smartbody
Contents |
VHuman BML Messages
The BML messages are currently under a transition. The first half of this page documents the current practice using vrSpeak, while the second half details early implementations of the new vrAgentBML messages.
vrSpeak
This requests a BML performance, including non-verbal BML (despite the message header).
vrSpeak <character-id> <audience-id> <message-id> <XML-act>
Where...
| <character-id> | Character identifier |
| <audience-id> | Unused recipient or audience identifier |
| <message-id> | Per-character unique message identifier |
| <BML> | Either BML starting with the XML prolog (<?xml .. ?>), or the path to the file containing the BML (absolute or relative to the current working directory) |
vrSpeak will soon be deprecated in favor of the vrAgentBML ... request messages implemented in [1].
vrSpeakFailed
Signals a failure to realize a BML request.
vrSpeakFailed <character-id> <audience-id> <message-id> <text>
Where...
| <character-id> | Character identifier, matching initial BML request |
| <audience-id> | Unused recipient or audience identifier |
| <message-id> | Per-character unique message identifier, matching initial BML request |
| <text> | Text of speech. Technically, not used, but makes logs more readable. |
vrSpeakFailed will soon be deprecated in favor of the vrAgentBML .. end error messages implemented in [2].
vrSpoke
Notifies the completion of a BML speech element.
vrSpoke <character-id> <audience-id> <message-id> <text>
Where...
| <character-id> | Character identifier, matching initial BML request |
| <audience-id> | Unused recipient or audience identifier |
| <message-id> | Per-character unique message identifier, matching initial BML request |
| <text> | Text of speech. Technically, not used, but makes logs more readable. |
This message is not automatically generated by SBM, but rather inserted by NVBG via an <sbm:event> behavior.
vrAgentBML
Replacement to the vrSpeak and vrSpeakFailed messages, implemented in [3].
request
Request to SBM for a new BML performance, similar to vrSpeak.
vrAgentBML <character-id> <message-id> request <XML-act>
Where...
| <character-id> | Character identifier |
| <message-id> | Per-character unique message identifier |
| <XML-act> | Either BML starting with the XML prolog (<?xml .. ?>), or the path to the file containing the BML (absolute or relative to the current working directory) |
start
Signals SBM has begun performance a BML request.
vrAgentBML <character-id> <message-id> start
Where...
| <character-id> | Character identifier |
| <message-id> | Per-character unique message identifier |
end
Signals SBM has halted processing of a BML request. This could be because the perfromance completed normally, was interrupted, or caused an error during processing.
vrAgentBML <character-id> <message-id> end <reason-id> <reason-description>
Where...
| <character-id> | Character identifier |
| <message-id> | Per-character unique message identifier |
| <reason-id> | One of complete, interrupted, or error |
If reason is error, additional text can be appended to describe the error. This text is unprocessed, and is only intended for human consumption via the logs.
