API Reference - Unity
- Kyle
- bert
- 1 Core
- 2 Authentication
- 3 Space Functions
- 4 Color Property Functions
- 5 Bool Property Functions
- 6 Float Property Functions
- 7 String Property Functions
- 8 Vector Property Functions
- 9 Transform Property Functions
- 10 User Property Functions
- 11 Permissions
- 12 Remote Content
- 13 Spawned Objects
- 14 Space Users
- 15 Voice and Video
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.
CAVRNUS TYPES
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 | |
Creates a guest user 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 | |
Checks if there is any active connection to a space | |
Connects to a Space; joining voice & video and recieving/processing the journal | |
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 | |
Disconnects you from a given space. You will stop recieving property updates, and lose user & voice connections |
Color Property Functions
Defines what the application will show if a new prop value has not been assigned | |
Gets the current property value, whether the default or the one currently set | |
Triggers an Event when the property changes, plus an inital event when first bound | |
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(). | |
Updates the property value at the given path and synchronizes the data to the server |
Bool Property Functions
Defines what the application will show if a new prop value has not been assigned | |
Gets the current property value, whether the default or the one currently set | |
Triggers an Event when the property changes, plus an inital event when first bound | |
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(). | |
Updates the property value at the given path and synchronizes the data to the server |
Float Property Functions
Defines what the application will show if a new prop value has not been assigned | |
Gets the current property value, whether the default or the one currently set | |
Triggers an Event when the property changes, plus an inital event when first bound | |
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(). | |
Updates the property value at the given path and synchronizes the data to the server |
String Property Functions
Defines what the application will show if a new prop value has not been assigned | |
Gets the current property value, whether the default or the one currently set | |
Triggers an Event when the property changes, plus an inital event when first bound | |
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(). | |
Updates the property value at the given path and synchronizes the data to the server |
Vector Property Functions
Defines what the application will show if a new prop value has not been assigned | |
Gets the current property value, whether the default or the one currently set | |
Triggers an Event when the property changes, plus an inital event when first bound | |
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(). | |
Updates the property value at the given path and synchronizes the data to the server |
Transform Property Functions
Defines what the application will show if a new prop value has not been assigned | |
Gets the current property value, whether the default or the one currently set | |
Triggers an Event when the property changes, plus an inital event when first bound | |
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(). | |
Updates the property value at the given path and synchronizes the data to the server |
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). | |
Destroys the given object. |
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 | |
Throws an event with the user's current stream image |
Voice and Video
Set my muted state | |
Set my streaming state | |
Gets available microphones | |
Sets which microphone to use | |
Gets available camera/stream sources | |
Sets which camera/stream source to use |