UVoxtaClient Class Reference

UVoxtaClient Main public-facing subsystem for Voxta integration. More...

#include <VoxtaClient.h>

Inheritance diagram for UVoxtaClient:

Public Member Functions
	DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam (FVoxtaClientStateChanged, VoxtaClientState, newState)
	Delegate fired when the VoxtaClient state changes.
	DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam (FVoxtaClientCharacterRegistered, const FAiCharData &, charData)
	Delegate fired when a character is registered.
	DECLARE_DYNAMIC_MULTICAST_DELEGATE_TwoParams (FVoxtaClientCharMessageAdded, const FBaseCharData &, sender, const FChatMessage &, message)
	Delegate fired when a chat message is added.
	DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam (FVoxtaClientCharMessageRemoved, const FChatMessage &, message)
	Delegate fired when a chat message is removed.
	DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam (FVoxtaClientSpeechTranscribed, const FString &, message)
	Delegate fired when speech is transcribed.
	DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam (FVoxtaClientChatSessionStarted, const FChatSession &, chatSession)
	Delegate fired when a chat session starts.
	DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam (FVoxtaClientChatSessionStopped, const FChatSession &, chatSession)
	Delegate fired when a chat session stops.
	DECLARE_DYNAMIC_MULTICAST_DELEGATE_TwoParams (FVoxtaClientAudioPlaybackRegistered, const UVoxtaAudioPlayback *, playbackHandler, const FGuid &, characterId)
	Delegate fired when an audio playback handler is registered.
	DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam (FVoxtaClientChatContextUpdated, const FString &, newContext)
	Delegate fired when the context of a chatsession is updated.
	DECLARE_MULTICAST_DELEGATE_OneParam (FVoxtaClientStateChangedNative, VoxtaClientState)
	Native C++ delegates for the above events.
	DECLARE_MULTICAST_DELEGATE_OneParam (FVoxtaClientCharacterRegisteredNative, const FAiCharData &)
	DECLARE_MULTICAST_DELEGATE_TwoParams (FVoxtaClientCharMessageAddedNative, const FBaseCharData &, const FChatMessage &)
	DECLARE_MULTICAST_DELEGATE_OneParam (FVoxtaClientCharMessageRemovedNative, const FChatMessage &)
	DECLARE_MULTICAST_DELEGATE_OneParam (FVoxtaClientSpeechTranscribedNative, const FString &)
	DECLARE_MULTICAST_DELEGATE_OneParam (FVoxtaClientChatSessionStartedNative, const FChatSession &)
	DECLARE_MULTICAST_DELEGATE_OneParam (FVoxtaClientChatSessionStoppedNative, const FChatSession &)
	DECLARE_MULTICAST_DELEGATE_TwoParams (FVoxtaClientAudioPlaybackRegisteredNative, const UVoxtaAudioPlayback *, const FGuid &)
	DECLARE_MULTICAST_DELEGATE_OneParam (FVoxtaClientChatContextUpdatedNative, const FString &)
virtual void	Initialize (FSubsystemCollectionBase &collection) override
	Initialization of the instance of the system.
virtual void	Deinitialize () override
	Deinitialization of the instance of the system.
void	StartConnection (const FString &ipv4Address, int port)
	Start the VoxtaClient and connect to the Voxta SignalR hub.
void	Disconnect (bool silent=false)
	Disconnect from the VoxtaServer and clean up all resources.
void	StartChatWithCharacter (const FGuid &charId, const FString &context=TEXT(""))
	Tell the server to initiate a chat session with the character of the provided ID.
void	SetGlobalAudioFallbackEnabled (bool newState)
	Enable or disable the global audio fallback handler (for characters without a specific handler).
bool	IsGlobalAudioFallbackActive () const
void	StopActiveChat ()
	Tell the server to stop the ongoing chat session and clean up the relevant dependencies.
void	UpdateChatContext (const FString &newContext)
	Update the context of the current chat session.
void	SendUserInput (const FString &inputText, bool generateReply=true, bool characterActionInference=false)
	Send user input text to the server as part of the current chat session.
const FString &	GetServerAddress () const
int	GetServerPort () const
UVoxtaAudioInput *	GetVoiceInputHandler () const
VoxtaClientState	GetCurrentState () const
FGuid	GetUserId () const
FString	GetBrowserUrlForCharacter (const FGuid &aiCharacterId) const
	Get the browser URL for a given AI character.
FGuid	GetMainAssistantId () const
void	TryFetchAndCacheCharacterThumbnail (const FGuid &baseCharacterId, FDownloadedTextureDelegateNative onThumbnailFetched)
	Asynchronously fetch and cache the thumbnail for a character.
const UVoxtaAudioPlayback *	GetRegisteredAudioPlaybackHandlerForID (const FGuid &characterId) const
	Try to retrieve a pointer to the UVoxtaAudioPlayback that has claimed playback for the provided characterId.
FAiCharData	GetAiCharacterDataCopyById (const FGuid &characterId) const
	Try to retrieve a copy of the characterData for the provided characterId.
TArray< FAiCharData >	GetAvailableAiCharactersCopy () const
bool	TryRegisterPlaybackHandler (const FGuid &characterId, TWeakObjectPtr< UVoxtaAudioPlayback > playbackHandler)
	Register the playback handler for this specific character, this is needed as we need to know if we want to wait for the audio playback to be completed, or if there's no audio playback and we can just skip it.
bool	TryUnregisterPlaybackHandler (const FGuid &characterId)
	Unregister the audio playback handler for a character.
FChatSession	GetChatSessionCopy () const
FVoxtaVersionData	GetServerVersionCopy () const
bool	IsMatchingAPIVersion () const
const FChatSession *	GetChatSession () const
TWeakPtr< Audio2FaceRESTHandler >	GetA2FHandler () const
void	SetCensoredLogs (bool isCensorActive)
	Enable or disable log censoring for sensitive logs.
bool	IsLogCensorActive () const

Public Attributes
FVoxtaClientStateChanged	VoxtaClientStateChangedEvent
	Event fired when the internal VoxtaClient has finished transitioning to a different state.
FVoxtaClientStateChangedNative	VoxtaClientStateChangedEventNative
	Static Event variation of VoxtaClientStateChangedEvent.
FVoxtaClientCharacterRegistered	VoxtaClientCharacterRegisteredEvent
	Event fired when the internal VoxtaClient has loaded the metadata of an AiCharData.
FVoxtaClientCharacterRegisteredNative	VoxtaClientCharacterRegisteredEventNative
	Static Event variation of VoxtaClientCharacterRegisteredEvent.
FVoxtaClientCharMessageAdded	VoxtaClientCharMessageAddedEvent
	Event fired when the VoxtaClient is notified by the server that a message is added.
FVoxtaClientCharMessageAddedNative	VoxtaClientCharMessageAddedEventNative
	Static Event variation of VoxtaClientCharMessageAddedEvent.
FVoxtaClientCharMessageRemoved	VoxtaClientCharMessageRemovedEvent
	Event fired when the server has notified the client that a message has been removed.
FVoxtaClientCharMessageRemovedNative	VoxtaClientCharMessageRemovedEventNative
	Static Event variation of VoxtaClientCharMessageRemovedEvent.
FVoxtaClientSpeechTranscribed	VoxtaClientSpeechTranscribedPartialEvent
	Event fired when the server is in progress of transcribing speech, it contains the current version of the transcription.
FVoxtaClientSpeechTranscribedNative	VoxtaClientSpeechTranscribedPartialEventNative
	Static Event variation of VoxtaClientSpeechTranscribedPartialEvent.
FVoxtaClientSpeechTranscribed	VoxtaClientSpeechTranscribedCompleteEvent
	Event fired when the server has finished transcribing speech, it contains the final version of whatever the user said.
FVoxtaClientSpeechTranscribedNative	VoxtaClientSpeechTranscribedCompleteEventNative
	Static Event variation of VoxtaClientSpeechTranscribedCompleteEvent.
FVoxtaClientChatContextUpdated	VoxtaClientChatContextUpdatedEvent
	Event fired when the server has finished transcribing speech, it contains the final version of whatever the user said.
FVoxtaClientChatContextUpdatedNative	VoxtaClientChatContextUpdatedEventNative
	Static Event variation of VoxtaClientSpeechTranscribedCompleteEvent.
FVoxtaClientChatSessionStarted	VoxtaClientChatSessionStartedEvent
	Event fired when the chat session has begun.
FVoxtaClientChatSessionStartedNative	VoxtaClientChatSessionStartedEventNative
	Static Event variation of VoxtaClientChatSessionStartedEvent.
FVoxtaClientChatSessionStopped	VoxtaClientChatSessionStoppedEvent
	Event fired when the chat session has ended.
FVoxtaClientChatSessionStoppedNative	VoxtaClientChatSessionStoppedEventNative
	Static Event variation of VoxtaClientChatSessionStoppedEvent.
FVoxtaClientAudioPlaybackRegistered	VoxtaClientAudioPlaybackRegisteredEvent
	Event fired when a playbackHandler has registered itself & claimed audioplayback for that character.
FVoxtaClientAudioPlaybackRegisteredNative	VoxtaClientAudioPlaybackRegisteredEventNative
	Static Event variation of VoxtaClientAudioPlaybackRegisteredEvent.

Detailed Description

UVoxtaClient Main public-facing subsystem for Voxta integration.

Manages the stateful connection to the VoxtaServer, handles chat session lifecycle, audio input/output, character and message management, and event broadcasting. Provides a singleton-like API for Blueprints and C++ to interact with Voxta features.

Use GetWorld()->GetGameInstance()->GetSubsystem<UVoxtaClient>() to access the instance.

Member Function Documentation

DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam() [1/7]

UVoxtaClient::DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam	(	FVoxtaClientCharacterRegistered	,
		const FAiCharData &	,
		charData	)

Delegate fired when a character is registered.

DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam() [2/7]

UVoxtaClient::DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam	(	FVoxtaClientCharMessageRemoved	,
		const FChatMessage &	,
		message	)

Delegate fired when a chat message is removed.

DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam() [3/7]

UVoxtaClient::DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam	(	FVoxtaClientChatContextUpdated	,
		const FString &	,
		newContext	)

Delegate fired when the context of a chatsession is updated.

DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam() [4/7]

UVoxtaClient::DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam	(	FVoxtaClientChatSessionStarted	,
		const FChatSession &	,
		chatSession	)

Delegate fired when a chat session starts.

DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam() [5/7]

UVoxtaClient::DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam	(	FVoxtaClientChatSessionStopped	,
		const FChatSession &	,
		chatSession	)

Delegate fired when a chat session stops.

DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam() [6/7]

UVoxtaClient::DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam	(	FVoxtaClientSpeechTranscribed	,
		const FString &	,
		message	)

Delegate fired when speech is transcribed.

DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam() [7/7]

UVoxtaClient::DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam	(	FVoxtaClientStateChanged	,
		VoxtaClientState	,
		newState	)

Delegate fired when the VoxtaClient state changes.

DECLARE_DYNAMIC_MULTICAST_DELEGATE_TwoParams() [1/2]

UVoxtaClient::DECLARE_DYNAMIC_MULTICAST_DELEGATE_TwoParams	(	FVoxtaClientAudioPlaybackRegistered	,
		const UVoxtaAudioPlayback *	,
		playbackHandler	,
		const FGuid &	,
		characterId	)

Delegate fired when an audio playback handler is registered.

DECLARE_DYNAMIC_MULTICAST_DELEGATE_TwoParams() [2/2]

UVoxtaClient::DECLARE_DYNAMIC_MULTICAST_DELEGATE_TwoParams	(	FVoxtaClientCharMessageAdded	,
		const FBaseCharData &	,
		sender	,
		const FChatMessage &	,
		message	)

Delegate fired when a chat message is added.

DECLARE_MULTICAST_DELEGATE_OneParam() [1/7]

UVoxtaClient::DECLARE_MULTICAST_DELEGATE_OneParam	(	FVoxtaClientCharacterRegisteredNative	,
		const FAiCharData &	)

DECLARE_MULTICAST_DELEGATE_OneParam() [2/7]

UVoxtaClient::DECLARE_MULTICAST_DELEGATE_OneParam	(	FVoxtaClientCharMessageRemovedNative	,
		const FChatMessage &	)

DECLARE_MULTICAST_DELEGATE_OneParam() [3/7]

UVoxtaClient::DECLARE_MULTICAST_DELEGATE_OneParam	(	FVoxtaClientChatContextUpdatedNative	,
		const FString &	)

DECLARE_MULTICAST_DELEGATE_OneParam() [4/7]

UVoxtaClient::DECLARE_MULTICAST_DELEGATE_OneParam	(	FVoxtaClientChatSessionStartedNative	,
		const FChatSession &	)

DECLARE_MULTICAST_DELEGATE_OneParam() [5/7]

UVoxtaClient::DECLARE_MULTICAST_DELEGATE_OneParam	(	FVoxtaClientChatSessionStoppedNative	,
		const FChatSession &	)

DECLARE_MULTICAST_DELEGATE_OneParam() [6/7]

UVoxtaClient::DECLARE_MULTICAST_DELEGATE_OneParam	(	FVoxtaClientSpeechTranscribedNative	,
		const FString &	)

DECLARE_MULTICAST_DELEGATE_OneParam() [7/7]

UVoxtaClient::DECLARE_MULTICAST_DELEGATE_OneParam	(	FVoxtaClientStateChangedNative	,
		VoxtaClientState	)

Native C++ delegates for the above events.

DECLARE_MULTICAST_DELEGATE_TwoParams() [1/2]

UVoxtaClient::DECLARE_MULTICAST_DELEGATE_TwoParams	(	FVoxtaClientAudioPlaybackRegisteredNative	,
		const UVoxtaAudioPlayback *	,
		const FGuid &	)

DECLARE_MULTICAST_DELEGATE_TwoParams() [2/2]

UVoxtaClient::DECLARE_MULTICAST_DELEGATE_TwoParams	(	FVoxtaClientCharMessageAddedNative	,
		const FBaseCharData &	,
		const FChatMessage &	)

Deinitialize()

void UVoxtaClient::Deinitialize ( )

overridevirtual

Deinitialization of the instance of the system.

Called when the subsystem is destroyed.

Disconnect()

void UVoxtaClient::Disconnect

(

bool

silent = false

)

Disconnect from the VoxtaServer and clean up all resources.

Only call if you intend to stop using Voxta for the rest of the session.

Parameters

silent

If true, do not broadcast a notification for the state-change .

GetA2FHandler()

TWeakPtr< Audio2FaceRESTHandler > UVoxtaClient::GetA2FHandler

(

)

const

Returns

Get a weak pointer to the Audio2Face REST handler. Should probably be moved elsewhere, idk yet.

GetAiCharacterDataCopyById()

FAiCharData UVoxtaClient::GetAiCharacterDataCopyById

(

const FGuid &

characterId

)

const

Try to retrieve a copy of the characterData for the provided characterId.

Parameters

characterId

The character of which you want to retrieve a character-data.

Returns

A copy of the characterdata

GetAvailableAiCharactersCopy()

TArray< FAiCharData > UVoxtaClient::GetAvailableAiCharactersCopy

(

)

const

Returns

An copy of every available AIcharacter data.

GetBrowserUrlForCharacter()

FString UVoxtaClient::GetBrowserUrlForCharacter

(

const FGuid &

aiCharacterId

)

const

Get the browser URL for a given AI character.

Parameters

aiCharacterId

The character's unique ID.

Returns

The browser URL as a string.

GetChatSession()

const FChatSession * UVoxtaClient::GetChatSession

(

)

const

Returns

An immutable pointer to the current chat session, or nullptr if no chat is active.

GetChatSessionCopy()

FChatSession UVoxtaClient::GetChatSessionCopy

(

)

const

Returns

A copy of the current chat session.

GetCurrentState()

VoxtaClientState UVoxtaClient::GetCurrentState

(

)

const

Returns

The current VoxtaClient state.

GetMainAssistantId()

FGuid UVoxtaClient::GetMainAssistantId

(

)

const

Returns

The main assistant's unique ID.

GetRegisteredAudioPlaybackHandlerForID()

const UVoxtaAudioPlayback * UVoxtaClient::GetRegisteredAudioPlaybackHandlerForID

(

const FGuid &

characterId

)

const

Try to retrieve a pointer to the UVoxtaAudioPlayback that has claimed playback for the provided characterId.

Parameters

characterID

The character for which you want to retrieve a pointer to the AudioPlayback to.

Returns

An immutable pointer to the UVoxtaAudioPlayback component, or nullptr if it doesn't exist.

GetServerAddress()

const FString & UVoxtaClient::GetServerAddress

(

)

const

Returns

The ipv4 address where this client expects the Voxta server to be hosted.

GetServerPort()

int UVoxtaClient::GetServerPort

(

)

const

Returns

The HTTP port where this client expects the Voxta server to be hosted.

GetServerVersionCopy()

FVoxtaVersionData UVoxtaClient::GetServerVersionCopy

(

)

const

Returns

A copy of the server version data.

GetUserId()

FGuid UVoxtaClient::GetUserId

(

)

const

Returns

The current user's ID, or an invalid Guid if not authenticated.

GetVoiceInputHandler()

UVoxtaAudioInput * UVoxtaClient::GetVoiceInputHandler

(

)

const

Returns

An pointer to the VoxtaAudioInput handler, for microphone capture and streaming.

Initialize()

void UVoxtaClient::Initialize ( FSubsystemCollectionBase & collection )

overridevirtual

Initialization of the instance of the system.

Called when the subsystem is created.

IsGlobalAudioFallbackActive()

bool UVoxtaClient::IsGlobalAudioFallbackActive

(

)

const

Returns

True if the global audio fallback is active.

IsLogCensorActive()

bool UVoxtaClient::IsLogCensorActive

(

)

const

Returns

True if log censoring is active.

IsMatchingAPIVersion()

bool UVoxtaClient::IsMatchingAPIVersion

(

)

const

Returns

True if the API version matches the server.

SendUserInput()

void UVoxtaClient::SendUserInput	(	const FString &	inputText,
		bool	generateReply = true,
		bool	characterActionInference = false )

Send user input text to the server as part of the current chat session.

Triggers an AI reply if generateReply is true.

Parameters

inputText	The user's input text.
generateReply	Whether to trigger an AI reply.
characterActionInference	Whether to enable character action inference.

SetCensoredLogs()

void UVoxtaClient::SetCensoredLogs

(

bool

isCensorActive

)

Enable or disable log censoring for sensitive logs.

Parameters

isCensorActive

True to enable censoring, false to disable.

SetGlobalAudioFallbackEnabled()

void UVoxtaClient::SetGlobalAudioFallbackEnabled

(

bool

newState

)

Enable or disable the global audio fallback handler (for characters without a specific handler).

Parameters

newState

True to enable, false to disable.

StartChatWithCharacter()

void UVoxtaClient::StartChatWithCharacter	(	const FGuid &	charId,
		const FString &	context = TEXT("") )

Tell the server to initiate a chat session with the character of the provided ID.

Note: The id must match the id of an already registered character in the client.

Parameters

charId	The character's unique ID.
context	Optional context string for the chat.

StartConnection()

void UVoxtaClient::StartConnection	(	const FString &	ipv4Address,
		int	port )

Start the VoxtaClient and connect to the Voxta SignalR hub.

Only supports cold-start; restart is not supported.

Parameters

ipv4Address	The IPv4 address or hostname of the VoxtaServer.
port	The HTTP port of the VoxtaServer.

StopActiveChat()

void UVoxtaClient::StopActiveChat

(

)

Tell the server to stop the ongoing chat session and clean up the relevant dependencies.

TryFetchAndCacheCharacterThumbnail()

void UVoxtaClient::TryFetchAndCacheCharacterThumbnail	(	const FGuid &	baseCharacterId,
		FDownloadedTextureDelegateNative	onThumbnailFetched )

Asynchronously fetch and cache the thumbnail for a character.

Parameters

baseCharacterId	The character's unique ID.
onThumbnailFetched	Delegate to call when the thumbnail is fetched.

TryRegisterPlaybackHandler()

bool UVoxtaClient::TryRegisterPlaybackHandler	(	const FGuid &	characterId,
		TWeakObjectPtr< UVoxtaAudioPlayback >	playbackHandler )

Register the playback handler for this specific character, this is needed as we need to know if we want to wait for the audio playback to be completed, or if there's no audio playback and we can just skip it.

Parameters

characterId	The VoxtaServer assigned id of the character that is being registered for.
playbackHandler	The audioPlayback component for the specified characterId.

Returns

True if the character was registered successfully, false if duplicate or invalid.

TryUnregisterPlaybackHandler()

bool UVoxtaClient::TryUnregisterPlaybackHandler

(

const FGuid &

characterId

)

Unregister the audio playback handler for a character.

Parameters

characterId

The character for which we will remove the weakPointer to whatever audioplayback was registered for it.

Returns

True if unregistered, false if not found.

UpdateChatContext()

void UVoxtaClient::UpdateChatContext

(

const FString &

newContext

)

Update the context of the current chat session.

Parameters

newContext

The new context string to send to the server.

Member Data Documentation

VoxtaClientAudioPlaybackRegisteredEvent

FVoxtaClientAudioPlaybackRegistered UVoxtaClient::VoxtaClientAudioPlaybackRegisteredEvent

Event fired when a playbackHandler has registered itself & claimed audioplayback for that character.

VoxtaClientAudioPlaybackRegisteredEventNative

FVoxtaClientAudioPlaybackRegisteredNative UVoxtaClient::VoxtaClientAudioPlaybackRegisteredEventNative

Static Event variation of VoxtaClientAudioPlaybackRegisteredEvent.

VoxtaClientCharacterRegisteredEvent

FVoxtaClientCharacterRegistered UVoxtaClient::VoxtaClientCharacterRegisteredEvent

Event fired when the internal VoxtaClient has loaded the metadata of an AiCharData.

VoxtaClientCharacterRegisteredEventNative

FVoxtaClientCharacterRegisteredNative UVoxtaClient::VoxtaClientCharacterRegisteredEventNative

Static Event variation of VoxtaClientCharacterRegisteredEvent.

VoxtaClientCharMessageAddedEvent

FVoxtaClientCharMessageAdded UVoxtaClient::VoxtaClientCharMessageAddedEvent

Event fired when the VoxtaClient is notified by the server that a message is added.

Note: This is triggered for both AI and user messages!

VoxtaClientCharMessageAddedEventNative

FVoxtaClientCharMessageAddedNative UVoxtaClient::VoxtaClientCharMessageAddedEventNative

Static Event variation of VoxtaClientCharMessageAddedEvent.

VoxtaClientCharMessageRemovedEvent

FVoxtaClientCharMessageRemoved UVoxtaClient::VoxtaClientCharMessageRemovedEvent

Event fired when the server has notified the client that a message has been removed.

VoxtaClientCharMessageRemovedEventNative

FVoxtaClientCharMessageRemovedNative UVoxtaClient::VoxtaClientCharMessageRemovedEventNative

Static Event variation of VoxtaClientCharMessageRemovedEvent.

VoxtaClientChatContextUpdatedEvent

FVoxtaClientChatContextUpdated UVoxtaClient::VoxtaClientChatContextUpdatedEvent

Event fired when the server has finished transcribing speech, it contains the final version of whatever the user said.

VoxtaClientChatContextUpdatedEventNative

FVoxtaClientChatContextUpdatedNative UVoxtaClient::VoxtaClientChatContextUpdatedEventNative

Static Event variation of VoxtaClientSpeechTranscribedCompleteEvent.

VoxtaClientChatSessionStartedEvent

FVoxtaClientChatSessionStarted UVoxtaClient::VoxtaClientChatSessionStartedEvent

Event fired when the chat session has begun.

Note: This is triggered right after the configuration is set, and before the first initial AI message is received.

VoxtaClientChatSessionStartedEventNative

FVoxtaClientChatSessionStartedNative UVoxtaClient::VoxtaClientChatSessionStartedEventNative

Static Event variation of VoxtaClientChatSessionStartedEvent.

VoxtaClientChatSessionStoppedEvent

FVoxtaClientChatSessionStopped UVoxtaClient::VoxtaClientChatSessionStoppedEvent

Event fired when the chat session has ended.

Note: The chat object provided in the parameters will be destroyed immediatly after this call.

VoxtaClientChatSessionStoppedEventNative

FVoxtaClientChatSessionStoppedNative UVoxtaClient::VoxtaClientChatSessionStoppedEventNative

Static Event variation of VoxtaClientChatSessionStoppedEvent.

VoxtaClientSpeechTranscribedCompleteEvent

FVoxtaClientSpeechTranscribed UVoxtaClient::VoxtaClientSpeechTranscribedCompleteEvent

Event fired when the server has finished transcribing speech, it contains the final version of whatever the user said.

VoxtaClientSpeechTranscribedCompleteEventNative

FVoxtaClientSpeechTranscribedNative UVoxtaClient::VoxtaClientSpeechTranscribedCompleteEventNative

Static Event variation of VoxtaClientSpeechTranscribedCompleteEvent.

VoxtaClientSpeechTranscribedPartialEvent

FVoxtaClientSpeechTranscribed UVoxtaClient::VoxtaClientSpeechTranscribedPartialEvent

Event fired when the server is in progress of transcribing speech, it contains the current version of the transcription.

VoxtaClientSpeechTranscribedPartialEventNative

FVoxtaClientSpeechTranscribedNative UVoxtaClient::VoxtaClientSpeechTranscribedPartialEventNative

Static Event variation of VoxtaClientSpeechTranscribedPartialEvent.

VoxtaClientStateChangedEvent

FVoxtaClientStateChanged UVoxtaClient::VoxtaClientStateChangedEvent

Event fired when the internal VoxtaClient has finished transitioning to a different state.

VoxtaClientStateChangedEventNative

FVoxtaClientStateChangedNative UVoxtaClient::VoxtaClientStateChangedEventNative

Static Event variation of VoxtaClientStateChangedEvent.

---

The documentation for this class was generated from the following files:

• VoxtaClient.h
• VoxtaClient.cpp