FCavrnusSpaceConnection

This is the most important object in Cavrnus. It represents a user’s connection to a Space. As such it is used to access Properties, hook Users, etc.

FCavrnusAuthentication

This contains the Token received from the server upon a successful login. You can only ever have one active login at a time. At the moment, outside of just existing, this class doesn’t really “do” anything.

FCavrnusSpaceInfo

This is the live info about a given Space. It can be used to create a Spaces List, like the one provided in Cavrnus by default.

FCavrnusUser

This represents an individual user, and can be used to fetch their properties at runtime.

FCavrnusLiveXPropertyUpdate

This is used to post Transient Updates.

FCavrnusSpawnedObject

This represents an object that was spawned in a synchronized way at runtime using Cavrnus. It is used to manage that objects properties and, if desired, to delete it.

FCavrnusRemoteContent

Represents a file that has been uploaded to the Cavrnus Servers.

FCavrnusInputDevice

This represents a microphone, and can be used to create a Audio/Video selector, like the one provided in Cavrnus by default.

FCavrnusOutputDevice

This represents the speakers the app’s voice and video play out of. NOTE: This only affects the Cavrnus voice chat, not your application’s other sounds.

FCavrnusVideoInputDevice

This represents a Video Source (both Cameras and Desktop Streams), and can be used to create a Audio/Video selector, like the one provided in Cavrnus by default.

AuthenticateWithPassword

Gets user credentials, allowing you to join valid spaces and make other requests

AuthenticateAsGuest

Creates a guest user account with a given name and joins as that user

IsLoggedIn

Checks if you are logged in

AwaitAuthentication

Throws an even when user authentication is complete

FetchJoinableSpaces

Gets a list of all current spaces which can be joined

BindJoinableSpaces

Triggers when spaces become available to you that you can join, or when their metadata changes

IsConnectedToAnySpace

Checks if there is any active connection to a space

JoinSpace

Connects to a Space; joining voice & video and recieving/processing the journal

AwaitAnySpaceBeginLoading

Triggers when you begin attempting to join a space, returning the ID of the space being joined

AwaitAnySpaceConnection

Triggers immediately if you are already in a space, otherwise triggers as soon as you connect

ExitSpace

Disconnects you from a given space.  You will stop recieving property updates, and lose user & voice connections

DefineBoolPropertyDefaultValue

Defines what the application will show if a new prop value has not been assigned

GetBoolPropertyValue

Gets the current property value, whether the default or the one currently set

BindBooleanPropertyValue

Triggers an Event when the property changes, plus an inital event when first bound

BeginTransientBoolPropertyUpdate

Begins a temporary property update. This can be updated with UpdateWithNewData() This will show for everyone in the space, but will not be saved unless you call Finish().

PostBoolPropertyUpdate

Updates the property value at the given path and synchronizes the data to the server

DefineFloatPropertyDefaultValue

Defines what the application will show if a new prop value has not been assigned

GetFloatPropertyValue

Gets the current property value, whether the default or the one currently set

BindFloatPropertyValue

Triggers an Event when the property changes, plus an inital event when first bound

BeginTransientFloatPropertyUpdate

Begins a temporary property update. This can be updated with UpdateWithNewData() This will show for everyone in the space, but will not be saved unless you call Finish().

PostFloatPropertyUpdate

Updates the property value at the given path and synchronizes the data to the server

DefineStringPropertyDefaultValue

Defines what the application will show if a new prop value has not been assigned

GetStringPropertyValue

Gets the current property value, whether the default or the one currently set

BindStringPropertyValue

Triggers an Event when the property changes, plus an inital event when first bound

BeginTransientStringPropertyUpdate

Begins a temporary property update. This can be updated with UpdateWithNewData() This will show for everyone in the space, but will not be saved unless you call Finish().

PostStringPropertyUpdate

Updates the property value at the given path and synchronizes the data to the server

DefineVectorPropertyDefaultValue

Defines what the application will show if a new prop value has not been assigned

GetVectorPropertyValue

Gets the current property value, whether the default or the one currently set

BindVectorPropertyValue

Triggers an Event when the property changes, plus an inital event when first bound

BeginTransientVectorPropertyUpdate

Begins a temporary property update. This can be updated with UpdateWithNewData() This will show for everyone in the space, but will not be saved unless you call Finish().

PostVectorPropertyUpdate

Updates the property value at the given path and synchronizes the data to the server

DefineTransformPropertyDefaultValue

Defines what the application will show if a new prop value has not been assigned

GetTransformPropertyValue

Gets the current property value, whether the default or the one currently set

BindTransformPropertyValue

Triggers an Event when the property changes, plus an inital event when first bound

BeginTransientTransformPropertyUpdate

Begins a temporary property update. This can be updated with UpdateWithNewData() This will show for everyone in the space, but will not be saved unless you call Finish().

PostTransformPropertyUpdate

Updates the property value at the given path and synchronizes the data to the server

DefineColorPropertyDefaultValue

Defines what the application will show if a new prop value has not been assigned

GetColorPropertyValue

Gets the current property value, whether the default or the one currently set

BindColorPropertyValue

Triggers an Event when the property changes, plus an inital event when first bound

BeginTransientColorPropertyUpdate

Begins a temporary property update. This can be updated with UpdateWithNewData() This will show for everyone in the space, but will not be saved unless you call Finish().

PostColorPropertyUpdate

Updates the property value at the given path and synchronizes the data to the server

BindGlobalPolicy

Binds an event to throw when a policy is/isn't allowed for the user (returns false until policies are fetched & resolved)

BindSpacePolicy

Binds an event to throw when a policy is/isn't allowed for the user in a given space (returns false until policies are fetched & resolved)

SpawnObject

Instantiates the given object with no set properties (note you will need to pull the Container ID out of the Spawned Object and assign property values to it).

DestroyObject

Destroys the given object.

UploadContent

Uploads a file from your disk to the Cavrnus Server

UploadContentWithTags

Uploads a file from your disk to the Cavrnus Server with additional metadata

FetchAllUploadedContent

Fetches a list of available files on your Domain that you can download.

FetchFileById

Fetches a file from the Cavrnus Server and gives you a list of bytes

FetchFileByIdToDisk

Fetches a file from the Cavrnus Server and saves it as a file on disk

AwaitLocalUser

Throws an event when the local CavrnusUser arrives in the space

GetCurrentSpaceUsers

Gives the list of current users in a space

BindSpaceUsers

Triggers whenever users join or leave a given space

BindUserVideoFrames

Throws an event with the user's current stream image

SetLocalUserMutedState

Set my muted state

SetLocalUserStreamingState

Set my streaming state

FetchAudioInputs

Gets available microphones

UpdateAudioInput

Sets which microphone to use

FetchAudioOutputs

Gets available speakers

UpdateAudioOutput

Sets which speaker to use

FetchVideoInputs

Gets available camera/stream sources

UpdateVideoInput

Sets which camera/stream source to use

Core Headers

The core functionality of the Cavrnus Spatial Connector, including the definition of the CavrnusSpatialConnector actor that can be placed in a level to immediately connect your Unreal project to the metaverse.

LivePropertyUpdates

The header files in the LivePropertyUpdates folder define a set of classes designed to handle real-time updates of different property types within the Cavrnus collaborative environment. These classes share a common base class, UCavrnusLivePropertyUpdate, and provide specialized functionality for specific data types.

ValueSyncs

The header files within the ValueSyncs folder, along with IPropertySyncInterface.h, form a structured system for synchronizing property values between Unreal Engine and the Cavrnus platform.

Types

The header files in the "Types" folder define essential data structures used throughout the Cavrnus Spatial Connector plugin.

FlagComponents

The header files in the FlagComponents folder relate to flagging or marking entities within the Cavrnus system (users, avatars, spawned objects). These components play a role in identifying and tracking these entities for collaboration.

UI

The header files in the "UI" folder define the core structure and functionality of the user interface (UI) elements for the Cavrnus Spatial Connector plugin. They enable users to log in, select spaces, view other users, and potentially perform other essential actions within the collaborative environment.

Pagination

The header files in the "Pagination" folder define the UI structure and interface for handling pagination of list elements within the Cavrnus Spatial Connector plugin.

SpaceList

The header files in the "UI/SpaceList" folder define the UI elements and logic for displaying and interacting with a list of Cavrnus spaces.