| When just getting started with the SDK you may skip this section for now and come back when done playing. |
The EyeVec eye-tracker software contains four groups of settings:
-
participant feature settings for information about the eyes of the participant
-
eye-tracker settings for controlling the many aspects of the eye-tracker operation
-
physical setup settings for defining how the eye-tracker is positioned on the desk in relation to the participant and the test screen
-
display settings for enabling/disabling certain features of the eyevec-control user-interface
All settings can be retrieved and adjusted using the corresponding getter and setter functions. Many settings can also be adjusted using the eyevec-control application and saved to settings files for persistence across sessions. The following reference pages list the getters and settters for the above settings groups:
In general the getter and setter function names for a setting can be derived
from the setting name by replacing the dashes in the setting name by
underscores and adding a prefix:
eyevec_{get|set}_{participant|setting|setup|display}_. For example the getter
and setter functions for the
calibration-type
eye-tracker setting are
eyevec_get_setting_calibration_type()
resp.
eyevec_set_setting_calibration_type().
All getter and setter function return an error result code, that should be
checked after the call.
Since the EyeVec SDK implements a client-server model (your application being the client) calling a getter or setter involves communication between the client and the server. Therefore it is not efficient to call any of the settings getters and/or setters in a tight loop; avoid doing so if possible.
While the eye-tracker is busy running a procedure (calibration, drift-check etc.) or recording eye-tracking data most settings will be temporarily read-only. If you need to alter some settings programmatically it is recommended to do this prior to the baseline measurement.