Auki::ConjureKit::ConjureKitConfiguration
A class that retrieves and stores ConjureKit configuration data used by ConjureKit.Init().
Public Classes
Name | |
---|---|
struct | conjurekit_configuration Represents the configuration for ConjureKit, a structured data containing various URIs and settings. |
Public Functions
Name | |
---|---|
bool | operator==(ConjureKitConfiguration c1, ConjureKitConfiguration c2) Equality operator between two ConjureKitConfiguration objects. |
bool | operator!=(ConjureKitConfiguration c1, ConjureKitConfiguration c2) Inequality operator between two ConjureKitConfiguration objects. |
void | TryGet(Action< ConjureKitConfiguration > onComplete, Action< string > onFailed) Asynchronous download of a configuration file from the default ConjureKit hardcoded URL (a.k.a., ConjureKitConfiguration.DefaultConfigUri), and manufacture of a ConjureKitConfiguration object from the downloaded JSON. |
void | TryGet(string configUri, Action< ConjureKitConfiguration > onComplete, Action< string > onFailed) Asynchronous download of a configuration file from a specified URL and manufacture of a ConjureKitConfiguration object from the downloaded JSON. |
Public Attributes
Name | |
---|---|
const string | DefaultConfigUri Default ConjureKit configuration URL. |
readonly string | ConfigUri URI used to created the config, if any. |
readonly string | HdsUri Hagall discovery service URI. |
readonly string | HagallMinVersion Hagall server minimum version. |
readonly string | EventUri Event logging service URI. |
readonly string | ApiUri API URI. |
readonly string | DdsUri DDS Server URI. |
readonly string | CatalogUri Asset catalog URI. |
readonly string | ParticipantAssetId Participant asset id. |
readonly string | MetricUri Metric reporting URI.. |
readonly Dictionary< string, float[]> | DeviceOffsets Contains the offsets of the physical camera position from the device display, for each supported device. |
string | PmsUri The URI for Posemesh metrics service. |
int | PingInterval Ping interval for PMS. |
int | PmsFirstReportInterval Time until first report for PMS is sent after connecting. |
int | PmsNextReportInterval Time until successive (after first) reports for PMS are sent. |
List< string > | PmsMessageTypes Hagall message types that will also be used to track latency. |
Public Functions Documentation
function operator==
static bool operator==(
ConjureKitConfiguration c1,
ConjureKitConfiguration c2
)
Equality operator between two ConjureKitConfiguration objects.
Parameters:
- c1 configuration 1
- c2 configuration 2
Return:
function operator!=
static bool operator!=(
ConjureKitConfiguration c1,
ConjureKitConfiguration c2
)
Inequality operator between two ConjureKitConfiguration objects.
Parameters:
- c1 configuration 1
- c2 configuration 2
Return:
function TryGet
static void TryGet(
Action< ConjureKitConfiguration > onComplete,
Action< string > onFailed
)
Asynchronous download of a configuration file from the default ConjureKit hardcoded URL (a.k.a., ConjureKitConfiguration.DefaultConfigUri), and manufacture of a ConjureKitConfiguration object from the downloaded JSON.
Parameters:
- onComplete Callback on success
- onFailed Callback on error
function TryGet
static void TryGet(
string configUri,
Action< ConjureKitConfiguration > onComplete,
Action< string > onFailed
)
Asynchronous download of a configuration file from a specified URL and manufacture of a ConjureKitConfiguration object from the downloaded JSON.
Parameters:
- configUri Endpoint for the HTTP.GET request
- onComplete Callback on success
- onFailed Callback on error
Public Attributes Documentation
variable DefaultConfigUri
static const string DefaultConfigUri = "https://config.aukiverse.com/aukiverse.json";
Default ConjureKit configuration URL.
variable ConfigUri
readonly string ConfigUri;
URI used to created the config, if any.
variable HdsUri
readonly string HdsUri;
Hagall discovery service URI.
variable HagallMinVersion
readonly string HagallMinVersion;
Hagall server minimum version.
variable EventUri
readonly string EventUri;
Event logging service URI.
variable ApiUri
readonly string ApiUri;
API URI.
variable DdsUri
readonly string DdsUri;
DDS Server URI.
variable CatalogUri
readonly string CatalogUri;
Asset catalog URI.
variable ParticipantAssetId
readonly string ParticipantAssetId;
Participant asset id.
Used by Odal. This asset will be instantiated for every Participant and will be attached to their Pose.
variable MetricUri
readonly string MetricUri;
Metric reporting URI..
variable DeviceOffsets
readonly Dictionary< string, float[]> DeviceOffsets;
Contains the offsets of the physical camera position from the device display, for each supported device.
variable PmsUri
string PmsUri;
The URI for Posemesh metrics service.
variable PingInterval
int PingInterval;
Ping interval for PMS.
variable PmsFirstReportInterval
int PmsFirstReportInterval;
Time until first report for PMS is sent after connecting.
variable PmsNextReportInterval
int PmsNextReportInterval;
Time until successive (after first) reports for PMS are sent.
variable PmsMessageTypes
List< string > PmsMessageTypes;
Hagall message types that will also be used to track latency.