Enumerations
Types
| Name | |
|---|---|
| enum | ski_audio_preset_t { eCustomDevice = 0, eSkinetic = 1, eHSDmkI = 2, eHSDmkII = 3, eHSD0 = 4, eHSDmkIII = 5} |
| enum | ski_connection_state_t { eReconnecting = 3, eDisconnecting = 2, eConnecting = 1, eConnected = 0, eDisconnected = -1} |
| enum | ski_device_type_t { eUnknown = ~(uint32_t)0, eSkineticVest = DEV_TYPE_SKINETIC, eHSDmk2 = DEV_TYPE_HSDMK2, eHSDmk3 = DEV_TYPE_HSDMK3} |
| enum | ski_effect_state_t { ePlay = 2, eMute = 1, eInitialized = 0, eStop = -1} |
| enum | ski_error_t { eNoError = 0, eOther = -1, eInvalidParam = -2, eNotConnected = -3, eOutputNotSupported = -4, eInvalidJson = -5, eDeviceNotReachable = -6, ePendingCommand = -7, eNoMoreSlot = -8, eNoInstance = -9, eInvalidMessage = -10, eAlreadyRunning = -11, eDeviceAlreadyConnected = -12, eInitializationInterrupted = -13, ePlayIgnored = -14, eErrorPortAudio = -15, eSocketError = -16, eAshError = -17, eCoreInvalidArgument = -100, eCoreInvalidSpn = -99, eCoreInvalidLayout = -98, eCoreAlreadyAllocated = -97, eCoreSequenceNotAllocated = -96, eCorePatternNotAllocated = -95, eCorePatternInUse = -94, eCoreSequenceAlreadyPlaying = -93, eCoreInvalidOperation = -92} |
| enum int | ski_log_level_t { trace = 0, debug = 1, info = 2, warn = 3, err = 4, critical = 5, off = 6, n_levels} |
| enum | ski_output_t { eAutoDetect = 0, eBluetooth = 1, eUSB = 2, eWifi = 3} |
Detailed Description
Public enumeration types
Types Documentation
enum ski_audio_preset_t
| Enumerator | Value | Description |
|---|---|---|
| eCustomDevice | 0 | Audio stream with a custom configuration |
| eSkinetic | 1 | Autoconfiguration of the audioStream for the Skinetic device |
| eHSDmkI | 2 | Autoconfiguration of the audioStream for the HSD mk.I device |
| eHSDmkII | 3 | Autoconfiguration of the audioStream for the HSD mk.II device |
| eHSD0 | 4 | Autoconfiguration of the audioStream for the HSD 0 device |
| eHSDmkIII | 5 | Autoconfiguration of the audioStream for the HSD mk.III device |
Preset of audio devices. eCustomDevice is to be used for a custom configuration.
enum ski_connection_state_t
| Enumerator | Value | Description |
|---|---|---|
| eReconnecting | 3 | Device connection was broken, trying to reconnect |
| eDisconnecting | 2 | Device is disconnecting, releasing all resources |
| eConnecting | 1 | Connection to the device is being established, connection routine is active. |
| eConnected | 0 | Device is connected |
| eDisconnected | -1 | Device is disconnected |
Connection state.
enum ski_device_type_t
| Enumerator | Value | Description |
|---|---|---|
| eUnknown | ~(uint32_t)0 | Type is Unknown or undefined |
| eSkineticVest | DEV_TYPE_SKINETIC | Skinetic Vest |
| eHSDmk2 | DEV_TYPE_HSDMK2 | HSD mk.II development kit |
| eHSDmk3 | DEV_TYPE_HSDMK3 | HSD mk.III development kit |
Type of device
enum ski_effect_state_t
| Enumerator | Value | Description |
|---|---|---|
| ePlay | 2 | Effect is playing. |
| eMute | 1 | Effect is muted. |
| eInitialized | 0 | Effect is initialized and should play as soon as possible. |
| eStop | -1 | Effect is stopped. |
Effect State
enum ski_error_t
| Enumerator | Value | Description |
|---|---|---|
| eNoError | 0 | No error |
| eOther | -1 | Other |
| eInvalidParam | -2 | Invalid parameter |
| eNotConnected | -3 | No device connected |
| eOutputNotSupported | -4 | Output is not supported on this platform |
| eInvalidJson | -5 | Invalid json |
| eDeviceNotReachable | -6 | Device not reachable |
| ePendingCommand | -7 | A priority command is waiting to be processed |
| eNoMoreSlot | -8 | No available slot on the board |
| eNoInstance | -9 | No Skinetic instance created |
| eInvalidMessage | -10 | Received an invalid message |
| eAlreadyRunning | -11 | Process is already running |
| eDeviceAlreadyConnected | -12 | A device is already connected |
| eInitializationInterrupted | -13 | The initialization of the device has been interrupted |
| ePlayIgnored | -14 | Play was ignored due to overall trigger strategy |
| eErrorPortAudio | -15 | PortAudio raised an error |
| eSocketError | -16 | An error happened with the socket |
| eAshError | -17 | ASH-fx library raised an error |
| eCoreInvalidArgument | -100 | Core Error: Invalid argument |
| eCoreInvalidSpn | -99 | Core Error: Invalid spn |
| eCoreInvalidLayout | -98 | Core Error: Invalid layout |
| eCoreAlreadyAllocated | -97 | Core Error: ID already allocated |
| eCoreSequenceNotAllocated | -96 | Core Error: Invalid sequence ID |
| eCorePatternNotAllocated | -95 | Core Error: Invalid pattern ID |
| eCorePatternInUse | -94 | Core Error: Pattern in use |
| eCoreSequenceAlreadyPlaying | -93 | Core Error: Sequence already set to play |
| eCoreInvalidOperation | -92 | Core Error: Invalid Operation |
Error codes returned by the functions of the library.
enum ski_log_level_t
| Enumerator | Value | Description |
|---|---|---|
| trace | 0 | |
| debug | 1 | |
| info | 2 | |
| warn | 3 | |
| err | 4 | |
| critical | 5 | |
| off | 6 | |
| n_levels |
Log levels definitions.
enum ski_output_t
| Enumerator | Value | Description |
|---|---|---|
| eAutoDetect | 0 | Connection type is automatically handled |
| eBluetooth | 1 | Bluetooth connection |
| eUSB | 2 | USB connection |
| eWifi | 3 | WiFi connection |
Output selection codes to determine the target output mode.
Updated on 2024-07-11 at 09:47:11 +0000