Disclaimer
...
CAVRNUS TYPES
Orientation
Real-time applications built in Unity can be connected to the Cavrnus platform by placing the corresponding Cavrnus Metaverse Connector plugin in the project folder. Once enabled, developers have access to the following functions to enhance the functionality and data sharing of the project.
CAVRNUS CLASSES
Class Name | Base Class |
|---|---|
UCavrnusConnectorFunctionLibrary | UBlueprintFunctionLibrary |
CAVRNUS FUNCTIONS
Bindings
...
Function Name
...
Description
...
Parameters
...
Return Type
...
...
Unregisters the Binding so that callback will no longer be hit.
...
FCavrnusBinding disposable
...
void
Data Model Access/Shutdown
...
...
Returns a reference to the Cavrnus Relay Model
...
...
Deletes the Relay Model, if it exists, and sets the reference to a null pointer.
Authentication
...
...
Checks if you are logged in
...
N/A
...
bool
...
...
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. | |
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. | |
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. | |
This represents an individual user, and can be used to fetch their properties at runtime. | |
This is used to post Transient Updates. | |
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. | |
Represents a file that has been uploaded to the Cavrnus Servers. | |
This represents a microphone, and can be used to create a Audio/Video selector, like the one provided in Cavrnus by default. | |
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. |
CAVRNUS FUNCTIONS
Core
Sets up all static helpers and systems required for Cavrnus to run |
Authentication
Gets user credentials, allowing you to join valid spaces and make other requests |
...
...
void
...
Creates a guest user |
...
FString server,
FString userName,
FCavrnusAuthRecv onSuccess,
FCavrnusError onFailure
...
void
...
account with a given name and joins as that user | |
Checks if you are logged in | |
Throws an even when user authentication is complete |
Space Functions
Gets a list of all current spaces which can be joined | |
Triggers when spaces become available to you that you can join, or when their metadata changes |
...
...
FCavrnusBinding
Checks if there is any active connection to a space |
...
bool
Connects to a Space; joining voice & video and recieving/processing the journal |
...
FString spaceId,
FCavrnusSpaceConnected onConnected, FCavrnusError onFailure
...
void
Triggers when you begin attempting to join a space, returning the ID of the space being joined | |
Triggers immediately if you are already in a space, otherwise triggers as soon as you connect |
...
FCavrnusSpaceConnected onConnected
...
Disconnects you from a given space. You will stop recieving property updates, and lose user & voice connections |
...
AwaitAnySpaceBeginLoading
...
<<Pending>>
...
void
Color Property Functions
Defines what the application will show if a new prop value has not been assigned |
...
FCavrnusSpaceConnection spaceConn,
FString containerName,
FString propertyName,
FColor propertyValue
...
Gets the current property value, whether the default or the one currently set |
...
FCavrnusSpaceConnection spaceConn,
FString containerName,
FString propertyName
...
Triggers an Event when the property changes, plus an inital event when first bound |
...
FCavrnusSpaceConnection spaceConn,
FString containerName,
FString propertyName, FColorPropertyUpdated onPropertyUpdated
...
FCavrnusBinding
...
PostTransientColorPropertyUpdate
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 |
...
FCavrnusSpaceConnection spaceConn,
FString containerName,
FString propertyName,
FColor propertyValue,
FString transientToContinue = ""
...
Fstring
...
you call Finish(). | |
Updates the property value at the given path and synchronizes the data to the server |
...
FCavrnusSpaceConnection spaceConn,
FString containerName,
FString propertyName,
FColor propertyValue,
FString transientToFinish = ""
...
void
Bool Property Functions
Defines what the application will show if a new prop value has not been assigned |
...
...
void
Gets the current property value, whether the default or the one currently set |
...
...
bool
Triggers an Event when the property changes, plus an inital event when first bound |
...
FCavrnusSpaceConnection spaceConn,
FString containerName,
FString propertyName,
FBoolPropertyUpdated onPropertyUpdated
...
FCavrnusBinding
...
PostTransientBoolPropertyUpdate
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 |
...
FCavrnusSpaceConnection spaceConn,
FString containerName,
FString propertyName,
bool propertyValue,
FString transientToContinue = ""
...
Fstring
you call Finish(). | |
Updates the property value at the given path and synchronizes the data to the server |
...
...
void
Float Property Functions
Defines what the application will show if a new prop value has not been assigned |
...
...
void
Gets the current property value, whether the default or the one currently set |
...
...
float
...
Triggers an Event when the property changes, plus an inital event when first bound |
...
FCavrnusSpaceConnection spaceConn,
FString containerName,
FString propertyName,
FFloatPropertyUpdated onPropertyUpdated
...
FCavrnusBinding
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 |
...
FCavrnusSpaceConnection spaceConn,
FString containerName,
FString propertyName,
float propertyValue,
FString transientToContinue = ""
...
Fstring
you call Finish(). | |
Updates the property value at the given path and synchronizes the data to the server |
...
...
void
String Property Functions
Defines what the application will show if a new prop value has not been assigned |
...
FCavrnusSpaceConnection spaceConn,
FString containerName,
FString propertyName,
FString propertyValue
...
void
Gets the current property value, whether the default or the one currently set |
...
...
Fstring
Triggers an Event when the property changes, plus an inital event when first bound |
...
FCavrnusSpaceConnection spaceConn,
FString containerName,
FString propertyName,
FStringPropertyUpdated onPropertyUpdated
...
FCavrnusBinding
...
PostTransientStringPropertyUpdate
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 |
...
FCavrnusSpaceConnection spaceConn,
FString containerName,
FString propertyName,
FString propertyValue,
FString transientToContinue = ""
...
Fstring
you call Finish(). | |
Updates the property value at the given path and synchronizes the data to the server |
...
FCavrnusSpaceConnection spaceConn, FString containerName, FString propertyName, FString propertyValue, FString transientToFinish = ""
...
Vector Property Functions
Defines what the application will show if a new prop value has not been assigned |
...
FCavrnusSpaceConnection spaceConn,
FString containerName,
FString propertyName,
FVector4 propertyValue
...
void
...
...
Gets the current property value, whether the default or the one currently set |
...
...
FVector4
...
BlueprintCallable,
CallInEditor
Triggers an Event when the property changes, plus an inital event when first bound |
...
FCavrnusSpaceConnection spaceConn,
FString containerName,
FString propertyName,
FVectorPropertyUpdated onPropertyUpdated
...
FCavrnusBinding
...
BlueprintCallable,
CallInEditor
...
PostTransientVectorPropertyUpdate
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 |
...
FCavrnusSpaceConnection spaceConn,
FString containerName,
FString propertyName,
FVector4 propertyValue,
FString transientToContinue = ""
...
Fstring
...
you call Finish(). | |
Updates the property value at the given path and synchronizes the data to the server |
...
FCavrnusSpaceConnection spaceConn,
FString containerName,
FString propertyName,
FVector4 propertyValue,
FString transientToFinish = ""
...
...
BlueprintCallable,
CallInEditor
Transform Property Functions
Defines what the application will show if a new prop value has not been assigned |
...
...
void
Gets the current property value, whether the default or the one currently set |
...
...
Ftransform
...
Triggers an Event when the property changes, plus an inital event when first bound |
...
FCavrnusSpaceConnection spaceConn,
FString containerName,
FString propertyName,
FTransformPropertyUpdated onPropertyUpdated
...
FCavrnusBinding
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 |
...
FCavrnusSpaceConnection spaceConn,
FString containerName,
FString propertyName,
FTransform propertyValue,
FString transientToContinue = ""
...
Fstring
you call Finish(). | |
Updates the property value at the given path and synchronizes the data to the server |
...
FCavrnusSpaceConnection spaceConn,
FString containerName,
FString propertyName,
FTransform propertyValue,
FString transientToFinish = ""
...
void
...
CavrnusLivePropertyUpdate
...
DestryObject
User Property Functions
Synchronously returns a boolean denoting if the user is speaking. | |
Binds an event to throw when the user starts/stops speaking. | |
Synchronously returns a boolean denoting if the user is muted. | |
Binds an event to throw when the user mutes/un-mutes. | |
Synchronously returns a boolean denoting if the user is sharing a camera/video stream. | |
Binds an event to throw when the user starts/stops sharing a camera/video stream. | |
Synchronously returns a string of the user’s name. | |
Binds an event to throw when the user’s name changes. | |
Binds an event to throw when the user’s profile pic changes. |
Permissions
Binds an event to throw when a policy is/isn't allowed for the user (returns false until policies are fetched & resolved) | |
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) |
Remote Content
Uploads a file from your disk to the Cavrnus Server | |
Fetches a list of available files on your Domain that you can download. | |
Fetches a file from the Cavrnus Server and gives you a Stream. |
Spawned Objects
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). |
...
FCavrnusSpaceConnection spaceConn,
FString uniqueIdentifier
...
Fstring
...
FCavrnusSpawnedObject
...
<< Pending >>
...
UseComponents
...
<< Pending >>
Space Users
Destroys the given object. |
...
FCavrnusSpaceConnection spaceConn,
FCavrnusSpawnedObject spawnedObject
...
void
...
GetIfIsSpawnedObject
...
Gets the spawned object's data if it was created by Cavrnus
...
FCavrnusSpaceConnection spaceConn,
AActor* object
...
FCavrnusSpawnedObject
Space Users
Throws an event when the local CavrnusUser arrives in the space | |
Gives the list of current users in a space | |
Triggers whenever users join or leave a given space |
...
BlueprintCallable,
CallInEditor
...
...
Throws an |
...
FCavrnusSpaceConnection spaceConn,
FCavrnusUser& User,
FCavrnusUserVideoFrameEvent OnVideoFrameUpdate
...
event with the user's current stream image |
Voice and Video
...
SetUserStreamingState
...
Set my muted state |
...
Set my muted state
Set my streaming state | |
Gets available microphones |
...
Gets available microphones
...
Sets which microphone |
...
FetchAudioOutputs
...
Gets available speakers
...
Gets available speakers
...
UpdateAudioOutput
...
to use |
...
Sets which speaker to use
...
Gets available camera/stream sources | |
...
Sets which camera/stream source to use |
...
GetCurrentInput
...
<< Pending >>
...
GetCurrentOutput
...