Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

GetColorPropertyValue

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

FCavrnusSpaceConnection spaceConn,
FString containerName,
FString propertyName

Fcolor

BindColorPropertyValue

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

FCavrnusSpaceConnection spaceConn,
FString containerName,
FString propertyName, FColorPropertyUpdated onPropertyUpdated

FCavrnusBinding

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().

FCavrnusSpaceConnection spaceConn,
FString containerName,
FString propertyName,
FColor propertyValue,
FString transientToContinue = ""

Fstring

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

...

Bool 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

GetBoolPropertyValue

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

FCavrnusSpaceConnection spaceConn,
FString containerName,
FString propertyName

bool

BindBooleanPropertyValue

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

FCavrnusSpaceConnection spaceConn,
FString containerName,
FString propertyName,
FBoolPropertyUpdated onPropertyUpdated

FCavrnusBinding

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().

FCavrnusSpaceConnection spaceConn,
FString containerName,
FString propertyName,
bool propertyValue,
FString transientToContinue = ""

Fstring

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

...

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

DestryObjectDestroyObject

Destroys the given object.

FCavrnusSpaceConnection spaceConn,
FCavrnusSpawnedObject spawnedObject

void

Space Users

...

GetIfIsSpawnedObject

...

Gets the spawned object's data if it was created by Cavrnus

...

FCavrnusSpaceConnection spaceConn,
AActor* object

...

FCavrnusSpawnedObject

...

FCavrnusSpawnedObject

...

<< Pending >>

...

UseComponents

...

<< Pending >>

Space Users

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

FCavrnusSpaceConnection spaceConn,
FCavrnusSpaceUserEvent userAdded,
FCavrnusSpaceUserEvent userRemoved

BindUserVideoFrames

Triggers Throws an Event when the property changesevent with the user's current stream image

FCavrnusSpaceConnection spaceConn,
FCavrnusUser& User,
FCavrnusUserVideoFrameEvent OnVideoFrameUpdate

Voice and Video

SetUserMutedStateSetLocalUserMutedState

Set my muted state

Set my muted state

SetUserStreamingStateSetLocalUserStreamingState

Set my streaming stateSet my streaming state

GetCurrentAudioInputDevice

Gets the current microphone

FetchAudioInputsGets available microphones

Gets available microphones

UpdateAudioInputSets which microphone to use

Sets which microphone to use

FetchAudioOutputs

Gets available speakers

Gets available speakers

UpdateAudioOutput

Sets which speaker to use

Sets which speaker to use

FetchVideoInputsGets available camera/stream sources

Gets available camera/stream sources

UpdateVideoInput

Sets which camera/stream source to use

Sets which camera/stream source to use

GetCurrentInput

<< Pending >>

GetCurrentOutput

<< Pending >>