...
Function Name | Description | Parameters | Return Type | UE Function Specifiers | Display Name |
---|---|---|---|---|---|
Unregisters the Binding so that callback will no longer be hit. | FCavrnusBinding disposable | voidBlueprintCallable, |
Data Model Access/Shutdown
...
Checks if you are logged in | N/A | boolBlueprintCallable, | |
Gets guest user credentials, allowing you to join valid spaces and make other requests | FString server, | voidBlueprintCallable, | |
Gets guest user credentials via a link, and informs you of the spaceId you should then join | FString server, | voidBlueprintCallable, |
Space Functions
Triggers when spaces become available to you that you can join, or when their metadata changes | FCavrnusSpaceInfoEvent spaceAdded, FCavrnusSpaceInfoEvent spaceUpdated, FCavrnusSpaceInfoEvent spaceRemoved | FCavrnusBinding | BlueprintCallable, | Disposable | |
Checks if there is any active connection to a space | boolBlueprintCallable, | ||||
JoinSpace | Connects to a Space; joining voice & video and recieving/processing the journal | FString spaceId, | voidBlueprintCallable, | ||
AwaitAnySpaceConnection | Triggers immediately if you are already in a space, otherwise triggers as soon as you connect | FCavrnusSpaceConnected onConnected | voidBlueprintCallable, | ||
ExitSpace | Disconnects you from a given space. You will stop recieving property updates, and lose user & voice connections | FCavrnusSpaceConnection spaceConn | voidBlueprintCallable, | ||
AwaitAnySpaceBeginLoading | <<Pending>> |
...
DefineColorPropertyDefaultValue | Defines what the application will show if a new prop value has not been assigned | FCavrnusSpaceConnection spaceConn, | voidBlueprintCallable, | ||
GetColorPropertyValue | Gets the current property value, whether the default or the one currently set | FCavrnusSpaceConnection spaceConn, | FcolorBlueprintCallable, | ||
BindColorPropertyValue | Triggers an Event when the property changes, plus an inital event when first bound | FCavrnusSpaceConnection spaceConn, | FCavrnusBinding | BlueprintCallable, | 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, | FstringBlueprintCallable, | ||
PostColorPropertyUpdate | Updates the property value at the given path and synchronizes the data to the server | FCavrnusSpaceConnection spaceConn, | voidBlueprintCallable, |
Boolean Property Functions
DefineBoolPropertyDefaultValue | Defines what the application will show if a new prop value has not been assigned | FCavrnusSpaceConnection spaceConn, | voidBlueprintCallable, | |
GetBoolPropertyValue | Gets the current property value, whether the default or the one currently set | FCavrnusSpaceConnection spaceConn, | boolBlueprintCallable, | |
BindBooleanPropertyValue | Triggers an Event when the property changes, plus an inital event when first bound | FCavrnusSpaceConnection spaceConn, | FCavrnusBindingBlueprintCallable, | 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, | FstringBlueprintCallable, | |
PostBoolPropertyUpdate | Updates the property value at the given path and synchronizes the data to the server | FCavrnusSpaceConnection spaceConn, | voidBlueprintCallable, |
Float Property Functions
DefineFloatPropertyDefaultValue | Defines what the application will show if a new prop value has not been assigned | FCavrnusSpaceConnection spaceConn, | voidBlueprintCallable,CallInEditor | ||
GetFloatPropertyValue | Gets the current property value, whether the default or the one currently set | FCavrnusSpaceConnection spaceConn, | floatBlueprintCallable, | ||
BindFloatPropertyValue | Triggers an Event when the property changes, plus an inital event when first bound | FCavrnusSpaceConnection spaceConn, | FCavrnusBinding | BlueprintCallable, | 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 | BlueprintCallable, | |
PostFloatPropertyUpdate | Updates the property value at the given path and synchronizes the data to the server | FCavrnusSpaceConnection spaceConn, | voidBlueprintCallable, |
String Property Functions
DefineStringPropertyDefaultValue | Defines what the application will show if a new prop value has not been assigned | FCavrnusSpaceConnection spaceConn, | voidBlueprintCallable, | ||
GetStringPropertyValue | Gets the current property value, whether the default or the one currently set | FCavrnusSpaceConnection spaceConn, | FstringBlueprintCallable, | ||
BindStringPropertyValue | Triggers an Event when the property changes, plus an inital event when first bound | FCavrnusSpaceConnection spaceConn, | FCavrnusBinding | BlueprintCallable, | 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, | FstringBlueprintCallable, | ||
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, |
Vector Property Functions
DefineVectorPropertyDefaultValue | Defines what the application will show if a new prop value has not been assigned | FCavrnusSpaceConnection spaceConn, | void | BlueprintCallable, |
GetVectorPropertyValue | Gets the current property value, whether the default or the one currently set | FCavrnusSpaceConnection spaceConn, | FVector4 | BlueprintCallable, |
BindVectorPropertyValue | Triggers an Event when the property changes, plus an inital event when first bound | FCavrnusSpaceConnection spaceConn, | FCavrnusBinding | BlueprintCallable, |
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 | BlueprintCallable, |
PostVectorPropertyUpdate | Updates the property value at the given path and synchronizes the data to the server | FCavrnusSpaceConnection spaceConn, | void | BlueprintCallable, |
...
DefineTransformPropertyDefaultValue | Defines what the application will show if a new prop value has not been assigned | FCavrnusSpaceConnection spaceConn, | voidBlueprintCallable, | ||
GetTransformPropertyValue | Gets the current property value, whether the default or the one currently set | FCavrnusSpaceConnection spaceConn, | FtransformBlueprintCallable, | ||
BindTransformPropertyValue | Triggers an Event when the property changes, plus an inital event when first bound | FCavrnusSpaceConnection spaceConn, | FCavrnusBinding | BlueprintCallable, | 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 | BlueprintCallable, | |
PostTransformPropertyUpdate | Updates the property value at the given path and synchronizes the data to the server | FCavrnusSpaceConnection spaceConn, | voidBlueprintCallable, | ||
CavrnusLivePropertyUpdate | <<Pending>> |
...
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 | BlueprintCallable, | Container Name | |
DestryObject | Destroys the given object. | FCavrnusSpaceConnection spaceConn, | voidBlueprintCallable, | ||
GetIfIsSpawnedObject | Gets the spawned object's data if it was created by Cavrnus | FCavrnusSpaceConnection spaceConn, | FCavrnusSpawnedObjectBlueprintCallable, | ||
FCavrnusSpawnedObject | << Pending >> | ||||
UseComponents | << Pending >> |
...
BindSpaceUsers | Triggers whenever users join or leave a given space | FCavrnusSpaceConnection spaceConn, | BlueprintCallable, | |
BindUserVideoFrames | Triggers an Event when the property changes | FCavrnusSpaceConnection spaceConn, | BlueprintCallable, |
Voice and Video
SetUserMutedState | Set my muted state | Set my muted stateBlueprintCallable, | ||
SetUserStreamingState | Set my streaming state | Set my streaming stateBlueprintCallable,CallInEditor | ||
FetchAudioInputs | Gets available microphones | Gets available microphonesBlueprintCallable, | ||
UpdateAudioInput | Sets which microphone to use | Sets which microphone to useBlueprintCallable, | ||
FetchAudioOutputs | Gets available speakers | Gets available speakersBlueprintCallable, | ||
UpdateAudioOutput | Sets which speaker to use | Sets which speaker to use | BlueprintCallable, | |
FetchVideoInputs | Gets available camera/stream sources | Gets available camera/stream sourcesBlueprintCallable,CallInEditor | ||
UpdateVideoInput | Sets which camera/stream source to use | Sets which camera/stream source to useBlueprintCallable, | ||
GetCurrentInput | << Pending >> | |||
GetCurrentOutput | << Pending >> |