Skip to main content

ControlPacket

Module: Inworld.AI. Namespace: Inworld.Packet. Inherited from InworldPacket

This packet is used for controlling interactions, such as starting or stopping the reception of audio for a character.

Variables	Description
control	The ControlEvent of the packet.

Properties	Description
Action	Get the ControlType of the packet.

Function	Description	Parameters
UpdateRouting	Search the live session data to compost the routing of the packet.

ControlEventDeserializer

Module: Inworld.AI. Namespace: Inworld.Packet. Inherited from JsonConverter

Properties	Description
CanWrite	Overwrote to always return false, as we'll use its default serializer.

Function	Description	Parameters
WriteJson	Not used. Just overwrote the default one.	writer: the JsonWriter. value: the object. serializer: the JsonSerializer.
ReadJson	The deserializing method to allocate into child classes.	reader: the JsonReader. value: the object. serializer: the JsonSerializer.
CanConvert	Check if the json can be converted into this class.	objectType: the Type to convert.

ControlEvent

Module: Inworld.AI. Namespace: Inworld.Packet.

Variables	Description
action	The actual control command
description	The description of the command.

AudioControlEvent

Module: Inworld.AI. Namespace: Inworld.Packet. Inherited from ControlEvent

Variables	Description
audioSessionStart	The detailed AudioSessionPayload of the action.

AudioSessionPayload

Module: Inworld.AI. Namespace: Inworld.Packet.

Variables	Description
mode	The MicrophoneMode for the audio session.

ConversationControlEvent

Module: Inworld.AI. Namespace: Inworld.Packet. Inherited from ControlEvent

Variables	Description
conversationUpdate	The detailed ConversationUpdatePayload of the action.

ConversationUpdatePayload

Module: Inworld.AI. Namespace: Inworld.Packet.

Variables	Description
participants	The list of the Source joining this conversation.

SessionControlEvent

Module: Inworld.AI. Namespace: Inworld.Packet. Inherited from ControlEvent

Variables	Description
sessionConfiguration	The detailed SessionConfigurationPayload of the action.

SessionConfigurationPayload

Module: Inworld.AI. Namespace: Inworld.Packet.

Variables	Description
sessionConfiguration	The SessionData to load.
userConfiguration	The UserRequest to load.
clientConfiguration	The ClientRequest to load.
capabilitiesConfiguration	The Capabilities to load.
continuation	The Previous chat history to load.

CurrentSceneStatusEvent

Module: Inworld.AI. Namespace: Inworld.Packet. Inherited from ControlEvent

Variables	Description
currentSceneStatus	The detailed CurrentSceneStatusPayload returned by the server.

CurrentSceneStatusPayload

Module: Inworld.AI. Namespace: Inworld.Packet.

Variables	Description
agents	The list of the InworldCharacterData returned by the server.
sceneName	the full name of the InworldScene.
sceneDescription	the description of the InworldScene.
sceneDisplayName	the display name of the InworldScene.

Related Classes