Skip to main content

Enums

Module: Inworld.AI. Namespace: Inworld.

These are the enums that used in Inworld Unity SDK.

File Reference

EnumDescriptionValues
InworldConnectionStatusThe connection status of the InworldClient.Idle: Initial State
Initializing: Used at getting runtime token.
Initialized: Getting runtime Token Completed.
Connecting: Start Session with Inworld Server by runtime token.
Connected: Controller is connected to World-Engine and ready to work.
Exhausted: Received when user is running out of quota.
Error: Some error occured.
InworldMessageThe extra message sent by Inworld server.None
GoalEnable
GoalDisable
GoalComplete
RelationUpdate
ConversationNextTurn
Error
Critical
GoAway
IncompleteInteraction
ErrorTypeThe error type returned by Inworld Server.UNDEFINED = -2
CLIENT_ERROR = -1
SESSION_TOKEN_EXPIRED = 0
SESSION_TOKEN_INVALID = 1: Session token is completely invalid.
SESSION_RESOURCES_EXHAUSTED = 2: Session's resources are temporarily exhausted.
BILLING_TOKENS_EXHAUSTED = 3: Billing tokens are exhausted -- client should buy more time or wait till end of billing period.
ACCOUNT_DISABLED = 4: Developer account is completely disabled, either due to a ToS violation or for some other reason.
SESSION_INVALID = 5: Session is invalid due to missing agents or some other reason.
RESOURCE_NOT_FOUND = 6: Resource id is invalid or otherwise could not be found.
SAFETY_VIOLATION = 7: Safety policies have been violated.
ReconnectionTypeThe instructions of how to reconnect received by Inworld server.UNDEFINED = 0
NO_RETRY = 1: Client should not try to reconnect.
IMMEDIATE = 2: Client can try to reconnect immediately
TIMEOUT = 3: Client can try to reconnect after given period, specified in InworldStatus.reconnect_time.
FeedbackTypeThe type of the feedbacks.INTERACTION_DISLIKE_TYPE_UNSPECIFIED = 0
INTERACTION_DISLIKE_TYPE_IRRELEVANT = 1: The content is irrelevant
INTERACTION_DISLIKE_TYPE_UNSAFE = 2: The content is unsafe
INTERACTION_DISLIKE_TYPE_UNTRUE = 3: The content is untrue.
INTERACTION_DISLIKE_TYPE_INCORRECT_USE_KNOWLEDGE = 4: The content uses knowledge incorrectly.
INTERACTION_DISLIKE_TYPE_UNEXPECTED_ACTION = 5: The content contains unexpected action.
INTERACTION_DISLIKE_TYPE_UNEXPECTED_GOAL_BEHAVIOR = 6: The content contains unexpected goal behaviour
INTERACTION_DISLIKE_TYPE_REPETITION = 7: The content contains repetition issue.
MicrophoneModeThe type of the microphone sampling mode.UNSPECIFIED
OPEN_MIC: For auto push
EXPECT_AUDIO_END: For push to talk.
ControlTypeThe type of the ControlEvents.UNKNOWN = 0
AUDIO_SESSION_START = 1:Speech activity starts, server should expect DataChunk, TextEvent and EmotionEvent packets after that.
AUDIO_SESSION_END = 2: Speech activity ended.
INTERACTION_END = 3: Indicates that the server has already sent all TextEvent response packets for the given interaction, and there won't be any more. Other types of packets can still be received by the client after it has received this packet.
TTS_PLAYBACK_START = 4: TTS response playback starts on the client.
TTS_PLAYBACK_END = 5: TTS Response playback ends on the client.
TTS_PLAYBACK_MUTE = 6: TTS response playback is muted on the client.
TTS_PLAYBACK_UNMUTE = 7: TTS response playback is unmuted on the client.
WARNING = 8: Contains warning for client.
SESSION_END = 9: Indicates that server is going to close the connection.
CONVERSATION_START = 10: Start a conversation (deprecated)
CONVERSATION_UPDATE = 12: Update conversation settings. Uses payload_structured type ConversationUpdatePayload
CONVERSATION_STARTED = 13: Server message to client with conversation id (deprecated).
CONVERSATION_EVENT = 14: Conversation events. Contains payload_structured type ConversationEventPayload
CURRENT_SCENE_STATUS = 15: Contains info about currently loaded scene. For example, scene name, description, loaded agents.
SESSION_CONFIGURATION = 16: Session configuration. Uses payload_structured type SessionConfigurationEvent.
SpaffCodeThe enum used to describe emotions in Inworld.NEUTRAL
DISGUST
CONTEMPT
BELLIGERENCE
DOMINEERING
CRITICISM
ANGER
TENSION
TENSE_HUMOR
DEFENSIVENESS
WHINING
SADNESS
STONEWALLING
INTEREST
VALIDATION
AFFECTION
** HUMOR**
SURPRISE
JOY
StrengthEach SpaffCode has three different degrees.WEAK
NEUTRAL
STRONG
ConversationEventTypeThe status of the current conversationEVICTED
STARTED
UPDATED
SourceTypeDetermines the type of the source or the targets.NONE
AGENT
PLAYER
WORLD
PacketTypeThe type of the InworldPackets.UNKNOWN
TEXT
CONTROL
AUDIO
GESTURE
CUSTOM
CANCEL_RESPONSE
MUTATION
EMOTION
ACTION
RELATION
SESSION_CONTROL
SESSION_RESPONSE
DataTypeThe type of the data chunk. Currently in Unity, only Audio is used.UNSPECIFIED = 0
AUDIO = 1: Chunk contains audio data.
STATE = 4: Chunk with state data (bytes).
INSPECT = 7: Inspect data for active session which sent as data chunk.
MicSampleModeThe mode of the microphone sampling.NO_MIC
NO_FILTER
PUSH_TO_TALK
AEC
TURN_BASED
CharSelectingMethodThe mode for selecting characters.Manual
KeyCode
SightAngle
AutoChat