LiveInfo
Module: Inworld.AI. Namespace: Inworld.Interactions.
This class is used for caching the current conversation and audio session.
Properties
| Properties | Description |
|---|---|
| Character | The target InworldCharacterData. |
| Conversation | The current Conversation status. |
| AudioSession | The current AudioSession status. |
| IsConversation | Get/Set the conversation mode. |
| Name | The current target. It's the current InworldCharacterData's given name or The chat group if it's in group chat mode. |
API
| Function | Description | Parameters |
|---|---|---|
| UpdateLiveInfo | Update the current status based on the incoming characters or conversation. | brainName: the full name of the InworldCharacterData, or set to null if it's a conversation. |
| UpdateMultiTargets | Used only in the group chat mode. Update the target characters that are in the chat group. | conversationID: the target ID of the Conversation, by default it's InworldCharacterHandler's ConversationID. brainNames: the list of the full name of the InworldCharacterData in the conversation. |
| UpdateSingleTarget | Used only in the single character mode. Update the target character. | brainName: the full name of the InworldCharacterData. |
| StartAudioSession | Update the status of the audio session to be started. | packetID: the PacketID of the AudioPacket. |
| StopAudioSession | Remove the current cached audio session ID and its target or targets. |
Related Classes
Conversation
Module: Inworld.AI. Namespace: Inworld.Interactions.
This class is used for caching the current status of the conversation mode (group chat mode).
| Properties | Description |
|---|---|
| ID | The ID of the conversation. |
| Status | The status of the current conversation, by default is EVICTED. |
| BrainNames | The list of the brainNames of the InworldCharacters that are in the chat group. |
AudioSession
Module: Inworld.AI. Namespace: Inworld.Interactions.
This class is used for caching the current status of the audio session. Because in Inworld, currently we can only support one AudioSession per connection.
| Properties | Description |
|---|---|
| ID | The ID of the audio session. |
| IsConversation | Determine if this audio session is based on a conversation. |
| Target | Either character's brain Name or ConversationID. |
| HasStarted | If the audio session has started. Server will not send any callback for the AudioEvents, so we need to track on our own. |
| Function | Description | Parameters |
|---|---|---|
| IsSameSession | Get if the target is the same session, to avoid starting the same session twice, which will cause exception in our back end. | brainName: the target full name of the InworldCharacter |