Engage Type And Status Codes - rallytac/pub GitHub Wiki
API Result Codes
| Value | Name | Comments |
|---|---|---|
| 0 | ENGAGE_RESULT_OK | |
| -1 | ENGAGE_RESULT_INVALID_PARAMETERS | One or more provided parameters are missing or invalid. |
| -2 | ENGAGE_RESULT_NOT_INITIALIZED | The Engine has not yet been initialized. |
| -3 | ENGAGE_RESULT_ALREADY_INITIALIZED | The Engine has already been initialized. |
| -4 | ENGAGE_RESULT_GENERAL_FAILURE | A non-specific error occurred. |
Transmit Status Codes
These status codes are present in the groupTxDetail element of extra event data provided events related to group TX.
| Value | Name | Comments |
|---|---|---|
| 0 | Undefined | |
| 1 | TX started | Transmit has begun |
| 2 | TX snded | Transmit has ended |
| -1 | Not an audio group | The group ID provided does not reference a group configured for audio |
| -2 | Not joined | The group has not yet been joined |
| -3 | Not connected | The group has not yet been connected |
| -4 | Already transmitting | Transmit is already active on the group |
| -5 | Invalid parameters | The parameters provided are invalid |
| -6 | Priority too low | The priority for transmission is lower than that of another user who is already transmitting - localPriority and remotePriority indicate priority crieria |
| -7 | RX is currently active on non-FDX | Another is user is already transmitting on a non-FDX group - nonFdxMsHangRemaining indicates the number of milliseconds of potential hang time before the next TX attempt could be made with possibility of success |
| -8 | Cannot subscribe to microphone | The microphone cannot be opened for transmission purposes |
| -9 | Invalid ID | The group ID provided is not recognized |
Connection Type
These status codes are present in the groupConnectionDetail element of extra event data provided in events related to group connection.
| Value | Name | Comments |
|---|---|---|
| 0 | Undefined | |
| 1 | IP Multicast | The group is connected on multicast - asFailover indicates whether multicast connection is due to failover operation |
| 2 | Rallypoint | The group is connected via a Rallypoint |
Licensing Status Codes
| Value | Name | Comments |
|---|---|---|
| 0 | OK | |
| -1 | ERR_NULL_ENTITLEMENT_KEY | No entitlement key was provided. |
| -2 | ERR_NULL_LICENSE_KEY | No license key was provided. |
| -3 | ERR_INVALID_LICENSE_KEY_LEN | No license key was provided or it is invalid. |
| -4 | ERR_LICENSE_KEY_VERIFICATION_FAILURE | The license key could not be verified. |
| -5 | ERR_ACTIVATION_CODE_VERIFICATION_FAILURE | The activation code could not be verified. |
| -6 | ERR_INVALID_EXPIRATION_DATE | The expiration date in the license key and/or activation code is invalid. |
| -7 | ERR_GENERAL_FAILURE | A non-specific error occurred. |
| -8 | ERR_NOT_INITIALIZED | The licensing subsystem has not yet been initialized. |
| -9 | ERR_REQUIRES_ACTIVATION | The license provided requires activation. |
BLOB JSON Payload Types
| Payload Type | Description |
|---|---|
| 0 | Undefined |
| 1 | Application-Defined UTF8 Text |
| 2 | JSON UTF8 Text |
| 3 | Application-Defined Binary |
| 4 | Engage Binary Human Biometrics |
Human Biometrics Data Series Types
| Type | Value | Range | JSON Object Name | Detail |
|---|---|---|---|---|
| Heart Rate | 1 | 0-255 | heartRate | Beats per minute |
| Skin Temperature | 2 | 0-255 | skinTemp | Celcius |
| Core Temperature | 3 | 0-255 | coreTemp | Celcius |
| Hydration Percentage | 4 | 0-100 | hydration | Percentage |
| Blood Oxygenation Percentage | 5 | 0-100 | bloodOxygenation | Percentage |
| Fatigue Level | 6 | 0-10 | fatigueLevel | 0 = low fatigue, 10 = maximum fatigue |
| Task Effectiveness Level | 7 | 0-10 | taskEffectiveness | 0 = minimal effectiveness, 10 = maximum effectiveness |