-
Notifications
You must be signed in to change notification settings - Fork 0
Devices and Recording Data
Following possible data sources are supported in UXC:
- Tobii Pro eye trackers - using the Tobii Pro SDK - Tobii X2-60 and TX300 were tested,
- Webcam video and audio recording - using the FFmpeg binary,
- Screencast video recording - using the UScreenCapture utility and FFmpeg binary,
- Keyboard and mouse events logging - using the Windows API hooks,
- External events logging - using the locally hosted REST API and websockets with ASP.NET SignalR.
Each devices has assigned its own type code. This is used throughout session definition, session recording data, API and elsewhere. Currently used type codes:
- ET - Eye tracker
- EXTEV - External events
- KB - Keyboard events
- ME - Mouse events
- WCA - Webcam audio recording
- WCV - Webcam video recording
- SC - Screencast video recording
Each device can be in one of the following states at a time.
- Disconnected
- Connected
- Recording - implies Connected
- Error - requires reconnection
UXC controls devices automatically, but connecting and disconnecting a device can be also done manually in the app UI.
All devices are data sources for session recording. Except of streaming devices - screencast, webcam video and audio recording - all devices write structured data into session data files.
Each data sample contains common field Timestamp
with local timestamp when the event was received by the app from the device.
See help page of each device for structure and contents of recorded data.
Each device may support configuration from two sources:
-
App configuration - configured in the configuration files in the application installation folder.
-
Session configuration - configured in the session definition, specific for each session recording.
-
device
: string (enum) - device type code, one of the following values:-
"ET"
- Eye tracker -
"EXTEV"
- External events -
"KB"
- Keyboard events -
"ME"
- Mouse events -
"WCA"
- Webcam audio recording -
"WCV"
- Webcam video recording -
"SC"
- Screencast video recording
-
-
configuration
: object (optional) - key-value configuration settings for the device. See description of each device for available settings, if any; otherwise, ignore.
-
{
"project": /* project name */,
"name": /* session name */,
"devices": [
{
"device" : "WCV",
"configuration": { "preset" : "HD" }
},
// ... other devices
],
// ... other SessionDefinition settings
}
See help page of each device for specific configuration settings.
- Home
- Usage Examples
- User Manual
- API Reference
- Installation Manual
- Contributing
- Project Documentation