UnrealVoxta 0.1.1
 
Loading...
Searching...
No Matches
ServerResponseChatMessageChunk Struct Reference

ServerResponseChatMessageChunk Read-only data struct containing the relevant data of the 'replyChunk' response from the VoxtaServer. More...

#include <ServerResponseChatMessageChunk.h>

Inheritance diagram for ServerResponseChatMessageChunk:
ServerResponseChatMessageBase ServerResponseBase

Public Member Functions

 ServerResponseChatMessageChunk (FGuid messageId, FGuid senderId, FGuid sessionId, int startIndex, int endIndex, FStringView messageText, FStringView audioUrlPath, bool isNarration)
 Construct a chat message chunk response.
 
- Public Member Functions inherited from ServerResponseChatMessageBase
 ServerResponseChatMessageBase (ChatMessageType messageType, FGuid messageId, FGuid sessionId)
 Construct a base chat message response.
 
- Public Member Functions inherited from ServerResponseBase
virtual ~ServerResponseBase ()=default
 
 ServerResponseBase (ServerResponseType responseType)
 

Public Attributes

const FGuid SENDER_ID
 The ID of the sender.
 
const int START_INDEX
 The start index of this chunk in the message.
 
const int END_INDEX
 The end index of this chunk in the message.
 
const FString MESSAGE_TEXT
 The text content of this chunk.
 
const FString AUDIO_URL_PATH
 The audio URL path for this chunk.
 
const bool IS_NARRATION
 Whether this chunk is narration.
 
- Public Attributes inherited from ServerResponseChatMessageBase
const ChatMessageType MESSAGE_TYPE
 The type of this chat message (start, chunk, end, cancelled).
 
const FGuid MESSAGE_ID
 The unique ID of the message.
 
const FGuid SESSION_ID
 The session ID this message belongs to.
 
- Public Attributes inherited from ServerResponseBase
const ServerResponseType RESPONSE_TYPE
 The type of this server response.
 

Additional Inherited Members

- Public Types inherited from ServerResponseChatMessageBase
enum class  ChatMessageType { MessageStart , MessageChunk , MessageEnd , MessageCancelled }
 Contains the possible states of the message that is currently being generated by Voxta. More...
 

Detailed Description

ServerResponseChatMessageChunk Read-only data struct containing the relevant data of the 'replyChunk' response from the VoxtaServer.

Represents a chunk of a chat message, including sender, indices, text, audio path, and narration flag.

Constructor & Destructor Documentation

◆ ServerResponseChatMessageChunk()

ServerResponseChatMessageChunk::ServerResponseChatMessageChunk ( FGuid messageId,
FGuid senderId,
FGuid sessionId,
int startIndex,
int endIndex,
FStringView messageText,
FStringView audioUrlPath,
bool isNarration )
inlineexplicit

Construct a chat message chunk response.

Parameters
messageIdThe unique ID of the message.
senderIdThe ID of the sender.
sessionIdThe session ID this message belongs to.
startIndexThe start index of this chunk in the message.
endIndexThe end index of this chunk in the message.
messageTextThe text content of this chunk.
audioUrlPathThe audio URL path for this chunk.
isNarrationWhether this chunk is narration.

Member Data Documentation

◆ AUDIO_URL_PATH

const FString ServerResponseChatMessageChunk::AUDIO_URL_PATH

The audio URL path for this chunk.

◆ END_INDEX

const int ServerResponseChatMessageChunk::END_INDEX

The end index of this chunk in the message.

◆ IS_NARRATION

const bool ServerResponseChatMessageChunk::IS_NARRATION

Whether this chunk is narration.

◆ MESSAGE_TEXT

const FString ServerResponseChatMessageChunk::MESSAGE_TEXT

The text content of this chunk.

◆ SENDER_ID

const FGuid ServerResponseChatMessageChunk::SENDER_ID

The ID of the sender.

◆ START_INDEX

const int ServerResponseChatMessageChunk::START_INDEX

The start index of this chunk in the message.


The documentation for this struct was generated from the following file: