Cavrnus for Unity - API Reference

Disclaimer

This API reference is still in early developmental stages. As such, some information may be missing or out of date. Feel free to refer to this documentation as a low level index of Engine classes and functions. However please reference the latest code for a complete understanding of functionality and performance.

Getting Started

Orientation

Real-time applications built in Unity or Unreal 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	UE Function Specifiers	Display Name
Unbind	Unregisters the Binding so that callback will no longer be hit.	FCavrnusBinding disposable	void	BlueprintCallable, CallInEditor

Data Model Access/Shutdown

GetDataModel	Returns a reference to the Cavrnus Relay Model
KillDataModel	Deletes the Relay Model, if it exists, and sets the reference to a null pointer.

Authentication

IsLoggedIn	Checks if you are logged in	N/A	bool	BlueprintCallable, CallInEditor
AuthenticateWithPassword	Gets guest user credentials, allowing you to join valid spaces and make other requests	FString server, FString email, FString password, FCavrnusAuthRecv onSuccess, FCavrnusError onFailure	void	BlueprintCallable, CallInEditor
AuthenticateAsGuest	Gets guest user credentials via a link, and informs you of the spaceId you should then join	FString server, FString userName, FCavrnusAuthRecv onSuccess, FCavrnusError onFailure	void	BlueprintCallable, CallInEditor

Space Functions

BindJoinableSpaces	Triggers when spaces become available to you that you can join, or when their metadata changes	FCavrnusSpaceInfoEvent spaceAdded, FCavrnusSpaceInfoEvent spaceUpdated, FCavrnusSpaceInfoEvent spaceRemoved	FCavrnusBinding	BlueprintCallable, CallInEditor	Disposable
IsConnectedToAnySpace	Checks if there is any active connection to a space		bool	BlueprintCallable, CallInEditor
JoinSpace	Connects to a Space; joining voice & video and recieving/processing the journal	FString spaceId, FCavrnusSpaceConnected onConnected, FCavrnusError onFailure	void	BlueprintCallable, CallInEditor
AwaitAnySpaceConnection	Triggers immediately if you are already in a space, otherwise triggers as soon as you connect	FCavrnusSpaceConnected onConnected	void	BlueprintCallable, CallInEditor
ExitSpace	Disconnects you from a given space. You will stop recieving property updates, and lose user & voice connections	FCavrnusSpaceConnection spaceConn	void	BlueprintCallable, CallInEditor
AwaitAnySpaceBeginLoading	<<Pending>>

Color Property Functions

DefineColorPropertyDefaultValue	Defines what the application will show if a new prop value has not been assigned	FCavrnusSpaceConnection spaceConn, FString containerName, FString propertyName, FColor propertyValue	void	BlueprintCallable, CallInEditor
GetColorPropertyValue	Gets the current property value, whether the default or the one currently set	FCavrnusSpaceConnection spaceConn, FString containerName, FString propertyName	Fcolor	BlueprintCallable, CallInEditor
BindColorPropertyValue	Triggers an Event when the property changes, plus an inital event when first bound	FCavrnusSpaceConnection spaceConn, FString containerName, FString propertyName, FColorPropertyUpdated onPropertyUpdated	FCavrnusBinding	BlueprintCallable, CallInEditor	Disposable
PostTransientColorPropertyUpdate	Begins a temporary property update. This will show for everyone in the space, but will not be saved unless finalized with a PostPropertyUpdate.	FCavrnusSpaceConnection spaceConn, FString containerName, FString propertyName, FColor propertyValue, FString transientToContinue = ""	Fstring	BlueprintCallable, CallInEditor
PostColorPropertyUpdate	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	BlueprintCallable, CallInEditor

Boolean Property Functions

DefineBoolPropertyDefaultValue	Defines what the application will show if a new prop value has not been assigned	FCavrnusSpaceConnection spaceConn, FString containerName, FString propertyName, bool propertyValue	void	BlueprintCallable, CallInEditor
GetBoolPropertyValue	Gets the current property value, whether the default or the one currently set	FCavrnusSpaceConnection spaceConn, FString containerName, FString propertyName	bool	BlueprintCallable, CallInEditor
BindBooleanPropertyValue	Triggers an Event when the property changes, plus an inital event when first bound	FCavrnusSpaceConnection spaceConn, FString containerName, FString propertyName, FBoolPropertyUpdated onPropertyUpdated	FCavrnusBinding	BlueprintCallable, CallInEditor	Disposable
PostTransientBoolPropertyUpdate	Begins a temporary property update. This will show for everyone in the space, but will not be saved unless finalized with a PostPropertyUpdate.	FCavrnusSpaceConnection spaceConn, FString containerName, FString propertyName, bool propertyValue, FString transientToContinue = ""	Fstring	BlueprintCallable, CallInEditor
PostBoolPropertyUpdate	Updates the property value at the given path and synchronizes the data to the server	FCavrnusSpaceConnection spaceConn, FString containerName, FString propertyName, bool propertyValue, FString transientToFinish = ""	void	BlueprintCallable, CallInEditor

Float Property Functions

DefineFloatPropertyDefaultValue	Defines what the application will show if a new prop value has not been assigned	FCavrnusSpaceConnection spaceConn, FString containerName, FString propertyName, float propertyValue	void	BlueprintCallable, CallInEditor
GetFloatPropertyValue	Gets the current property value, whether the default or the one currently set	FCavrnusSpaceConnection spaceConn, FString containerName, FString propertyName	float	BlueprintCallable, CallInEditor
BindFloatPropertyValue	Triggers an Event when the property changes, plus an inital event when first bound	FCavrnusSpaceConnection spaceConn, FString containerName, FString propertyName, FFloatPropertyUpdated onPropertyUpdated	FCavrnusBinding	BlueprintCallable, CallInEditor	Disposable
PostTransientFloatPropertyUpdate	Begins a temporary property update. This will show for everyone in the space, but will not be saved unless finalized with a PostPropertyUpdate.	FCavrnusSpaceConnection spaceConn, FString containerName, FString propertyName, float propertyValue, FString transientToContinue = ""	Fstring	BlueprintCallable, CallInEditor
PostFloatPropertyUpdate	Updates the property value at the given path and synchronizes the data to the server	FCavrnusSpaceConnection spaceConn, FString containerName, FString propertyName, float propertyValue, FString transientToFinish = ""	void	BlueprintCallable, CallInEditor

String Property Functions

DefineStringPropertyDefaultValue	Defines what the application will show if a new prop value has not been assigned	FCavrnusSpaceConnection spaceConn, FString containerName, FString propertyName, FString propertyValue	void	BlueprintCallable, CallInEditor
GetStringPropertyValue	Gets the current property value, whether the default or the one currently set	FCavrnusSpaceConnection spaceConn, FString containerName, FString propertyName	Fstring	BlueprintCallable, CallInEditor
BindStringPropertyValue	Triggers an Event when the property changes, plus an inital event when first bound	FCavrnusSpaceConnection spaceConn, FString containerName, FString propertyName, FStringPropertyUpdated onPropertyUpdated	FCavrnusBinding	BlueprintCallable, CallInEditor	Disposable
PostTransientStringPropertyUpdate	Begins a temporary property update. This will show for everyone in the space, but will not be saved unless finalized with a PostPropertyUpdate.	FCavrnusSpaceConnection spaceConn, FString containerName, FString propertyName, FString propertyValue, FString transientToContinue = ""	Fstring	BlueprintCallable, CallInEditor
PostStringPropertyUpdate	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 = ""	void	BlueprintCallable, CallInEditor

Vector Property Functions

DefineVectorPropertyDefaultValue	Defines what the application will show if a new prop value has not been assigned	FCavrnusSpaceConnection spaceConn, FString containerName, FString propertyName, FVector4 propertyValue	void	BlueprintCallable, CallInEditor
GetVectorPropertyValue	Gets the current property value, whether the default or the one currently set	FCavrnusSpaceConnection spaceConn, FString containerName, FString propertyName	FVector4	BlueprintCallable, CallInEditor
BindVectorPropertyValue	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	Disposable
PostTransientVectorPropertyUpdate	Begins a temporary property update. This will show for everyone in the space, but will not be saved unless finalized with a PostPropertyUpdate.	FCavrnusSpaceConnection spaceConn, FString containerName, FString propertyName, FVector4 propertyValue, FString transientToContinue = ""	Fstring	BlueprintCallable, CallInEditor
PostVectorPropertyUpdate	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 = ""	void	BlueprintCallable, CallInEditor

Transform Property Functions

DefineTransformPropertyDefaultValue	Defines what the application will show if a new prop value has not been assigned	FCavrnusSpaceConnection spaceConn, FString containerName, FString propertyName, FTransform propertyValue	void	BlueprintCallable, CallInEditor
GetTransformPropertyValue	Gets the current property value, whether the default or the one currently set	FCavrnusSpaceConnection spaceConn, FString containerName, FString propertyName	Ftransform	BlueprintCallable, CallInEditor
BindTransformPropertyValue	Triggers an Event when the property changes, plus an inital event when first bound	FCavrnusSpaceConnection spaceConn, FString containerName, FString propertyName, FTransformPropertyUpdated onPropertyUpdated	FCavrnusBinding	BlueprintCallable, CallInEditor	Disposable
PostTransientTransformPropertyUpdate	Begins a temporary property update. This will show for everyone in the space, but will not be saved unless finalized with a PostPropertyUpdate.	FCavrnusSpaceConnection spaceConn, FString containerName, FString propertyName, FTransform propertyValue, FString transientToContinue = ""	Fstring	BlueprintCallable, CallInEditor
PostTransformPropertyUpdate	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	BlueprintCallable, CallInEditor
CavrnusLivePropertyUpdate	<<Pending>>

Spawned Objects

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).	FCavrnusSpaceConnection spaceConn, FString uniqueIdentifier	Fstring	BlueprintCallable, CallInEditor	Container Name
DestryObject	Destroys the given object.	FCavrnusSpaceConnection spaceConn, FCavrnusSpawnedObject spawnedObject	void	BlueprintCallable, CallInEditor
GetIfIsSpawnedObject	Gets the spawned object's data if it was created by Cavrnus	FCavrnusSpaceConnection spaceConn, AActor* object	FCavrnusSpawnedObject	BlueprintCallable, CallInEditor
FCavrnusSpawnedObject	<< Pending >>
UseComponents	<< Pending >>

Space Users

BindSpaceUsers	Triggers whenever users join or leave a given space	FCavrnusSpaceConnection spaceConn, FCavrnusSpaceUserEvent userAdded, FCavrnusSpaceUserEvent userRemoved		BlueprintCallable, CallInEditor	Disposable
BindUserVideoFrames	Triggers an Event when the property changes	FCavrnusSpaceConnection spaceConn, FCavrnusUser& User, FCavrnusUserVideoFrameEvent OnVideoFrameUpdate		BlueprintCallable, CallInEditor	Disposable

Voice and Video

SetUserMutedState	Set my muted state	Set my muted state	BlueprintCallable, CallInEditor
SetUserStreamingState	Set my streaming state	Set my streaming state	BlueprintCallable, CallInEditor
FetchAudioInputs	Gets available microphones	Gets available microphones	BlueprintCallable, CallInEditor
UpdateAudioInput	Sets which microphone to use	Sets which microphone to use	BlueprintCallable, CallInEditor
FetchAudioOutputs	Gets available speakers	Gets available speakers	BlueprintCallable, CallInEditor
UpdateAudioOutput	Sets which speaker to use	Sets which speaker to use	BlueprintCallable, CallInEditor
FetchVideoInputs	Gets available camera/stream sources	Gets available camera/stream sources	BlueprintCallable, CallInEditor
UpdateVideoInput	Sets which camera/stream source to use	Sets which camera/stream source to use	BlueprintCallable, CallInEditor
GetCurrentInput	<< Pending >>
GetCurrentOutput	<< Pending >>