The file contains the prototype declaration for all supported functions and data structs the customer needs to use.
More...
Classes |
| struct | SystemInfoStruct |
| | This struct provides information about the eyetracking system in use. More...
|
| struct | CalibrationPointStruct |
| | This struct provides information about the current calibration point. More...
|
| struct | EyeDataStruct |
| | This struct provides information about eye data. More...
|
| struct | SampleStruct |
| | This struct provides information about gaze data samples. More...
|
| struct | SampleStruct32 |
| | This struct provides information about gaze data samples. More...
|
| struct | EventStruct |
| | This struct provides information about the last eye event that has been calculated. More...
|
| struct | EventStruct32 |
| | This struct provides information about the last eye event that has been calculated. More...
|
| struct | AccuracyStruct |
| | This struct provides information about the last validation. More...
|
| struct | CalibrationStruct |
| | Use this struct to customize calibration behavior. More...
|
| struct | REDStandAloneModeStruct |
| | Use this struct to customize RED operation mode. More...
|
Defines |
|
#define | DLLExport __declspec(dllexport) |
|
#define | RET_SUCCESS 1 |
|
#define | RET_NO_VALID_DATA 2 |
|
#define | RET_CALIBRATION_ABORTED 3 |
|
#define | ERR_COULD_NOT_CONNECT 100 |
|
#define | ERR_NOT_CONNECTED 101 |
|
#define | ERR_NOT_CALIBRATED 102 |
|
#define | ERR_NOT_VALIDATED 103 |
|
#define | ERR_WRONG_DEVICE 111 |
|
#define | ERR_WRONG_PARAMETER 112 |
|
#define | ERR_WRONG_CALIBRATION_METHOD 113 |
|
#define | ERR_CREATE_SOCKET 121 |
|
#define | ERR_CONNECT_SOCKET 122 |
|
#define | ERR_BIND_SOCKET 123 |
|
#define | ERR_DELETE_SOCKET 124 |
|
#define | ERR_NO_RESPONSE_FROM_IVIEWX 131 |
|
#define | ERR_INVALID_IVIEWX_VERSION 132 |
|
#define | ERR_WRONG_IVIEWX_VERSION 133 |
|
#define | ERR_WRONG_SDK_DLL 133 |
|
#define | ERR_ACCESS_TO_FILE 171 |
|
#define | ERR_SOCKET_CONNECTION 181 |
|
#define | ERR_EMPTY_DATA_BUFFER 191 |
|
#define | ERR_RECORDING_DATA_BUFFER 192 |
|
#define | ERR_FULL_DATA_BUFFER 193 |
|
#define | ERR_IVIEWX_IS_NOT_READY 194 |
|
#define | ERR_IVIEWX_NOT_FOUND 201 |
|
#define | LOG_LEVEL_BUG 1 |
|
#define | LOG_LEVEL_iV_FCT 2 |
|
#define | LOG_LEVEL_ALL_FCT 4 |
|
#define | LOG_LEVEL_IV_COMMAND 8 |
|
#define | LOG_LEVEL_RECV_IV_COMMAND 16 |
|
#define | ET_PARAM_EYE_LEFT 0 |
|
#define | ET_PARAM_EYE_RIGHT 1 |
|
#define | ET_PARAM_PUPIL_THRESHOLD 0 |
|
#define | ET_PARAM_REFLEX_THRESHOLD 1 |
|
#define | ET_PARAM_SHOW_AOI 2 |
|
#define | ET_PARAM_SHOW_CONTOUR 3 |
|
#define | ET_PARAM_SHOW_PUPIL 4 |
|
#define | ET_PARAM_SHOW_REFLEX 5 |
|
#define | ET_PARAM_DYNAMIC_THRESHOLD 6 |
|
#define | ET_PARAM_PUPIL_AREA 11 |
|
#define | ET_PARAM_PUPIL_PERIMETER 12 |
|
#define | ET_PARAM_PUPIL_DENSITY 13 |
|
#define | ET_PARAM_REFLEX_PERIMETER 14 |
|
#define | ET_PARAM_REFLEX_PUPIL_DISTANCE 15 |
Typedefs |
|
typedef int(CALLBACK * | pDLLSetCalibrationPoint )(struct CalibrationPointStruct calibrationPoint) |
|
typedef int(CALLBACK * | pDLLSetSample )(struct SampleStruct rawDataSample) |
|
typedef int(CALLBACK * | pDLLSetEvent )(struct EventStruct eventDataSample) |
Enumerations |
| enum | ETDevice {
NONE,
RED,
HiSpeed,
MRI,
HED,
Custom
} |
Functions |
| DLLExport int __stdcall | iV_SetLicense (char *licenseKey) |
| | validates the customer license (only for OEM devices)
|
| DLLExport int __stdcall | iV_Start () |
| | run iView X application and connects automatically (only on same computer)
|
| DLLExport int __stdcall | iV_Quit () |
| | disconnects and closes iViewX
|
| DLLExport int __stdcall | iV_SendCommand (char etMessage[256]) |
| | sends a remote command to iView X. Please refer to the iView X help file for further information about remote commands.
|
| DLLExport int __stdcall | iV_Connect (char sendIPAddress[16], int sendPort, char recvIPAddress[16], int receivePort) |
| | establishes a UDP connection to iView X. "iV_Connect" will not return until connection has been established. If no connection can be established it will return after three seconds.
|
| DLLExport int __stdcall | iV_IsConnected () |
| | checks if connection to iView X is still established
|
| DLLExport int __stdcall | iV_Disconnect () |
| | disconnects from iView X "iV_Disconnect" will not return until the connection has been disconnected.
|
| DLLExport int __stdcall | iV_GetSystemInfo (struct SystemInfoStruct *systemInfoData) |
| | updates "systemInfoData" with current system information
|
| DLLExport int __stdcall | iV_SetTrackingParameter (int ET_PARAM_EYE, int ET_PARAM, int value) |
| | sets iView X tracking parameters
|
| DLLExport int __stdcall | iV_StartRecording () |
| | starts gaze data recording and scene video recording (if connected eyetracking device is "HED") "iV_StartRecording" does not return until gaze and scene video recording is started
|
| DLLExport int __stdcall | iV_StopRecording () |
| | stops gaze data recording and scene video recording (if connected eyetracking device is "HED") "iV_StopRecording" does not return until gaze and scene video recording is stopped
|
| DLLExport int __stdcall | iV_ContinueRecording (char etMessage[256]) |
| | pauses gaze data recording and scene video recording (if connected eyetracking device is "HED") "iV_ContinueRecording" does not return until gaze and scene video recording is continued
|
| DLLExport int __stdcall | iV_PauseRecording () |
| | pauses gaze data recording and scene video recording (if connected eyetracking device is "HED") "iV_PauseRecording" does not return until gaze and scene video recording is paused
|
| DLLExport int __stdcall | iV_ClearRecordingBuffer () |
| | clears the data buffer and scene video buffer (if connected eyetracking device is "HED").
|
| DLLExport int __stdcall | iV_SaveData (char filename[256], char description[64], char user[64], int overwrite) |
| | writes data buffer and scene video buffer (if connected eyetracking device is "HED") to file "filename" "iV_SaveData" will not return until the data has been saved
|
| DLLExport int __stdcall | iV_SetupCalibration (struct CalibrationStruct *calibrationData) |
| | sets calibration parameters
|
| DLLExport int __stdcall | iV_SaveCalibration (char name[256]) |
| | stores a performed calibration
|
| DLLExport int __stdcall | iV_LoadCalibration (char name[256]) |
| | loads a saved calibration a calibration has to be previously saved by using "iV_SaveCalibration"
|
| DLLExport int __stdcall | iV_AcceptCalibrationPoint () |
| | accepts a calibration point (participat has to be tracked; only if calibration is active)
|
| DLLExport int __stdcall | iV_AbortCalibration () |
| | aborts a calibration or validation (only if calibration or validation is active)
|
| DLLExport int __stdcall | iV_ChangeCalibrationPoint (int number, int positionX, int positionY) |
| | changes the position of a calibration point
|
| DLLExport int __stdcall | iV_ResetCalibrationPoints () |
| | resets the default positions of all calibration points
|
| DLLExport int __stdcall | iV_Calibrate () |
| | starts a calibration procedure. If "CalibrationStruct::visualization" is set to "1" with "iV_SetupCalibration" "iV_Calibrate" will not return until the calibration has been finished or aborted.
|
| DLLExport int __stdcall | iV_Validate () |
| | starts a validation procedure. If "CalibrationStruct::visualization" is set to "1" with "V_SetupCalibration" "iV_Calibrate" will not return until the calibration has been finished or aborted.
|
| DLLExport int __stdcall | iV_GetAccuracy (struct AccuracyStruct *accuracyData, int visualization) |
| | updates "accuracyData" with current accuracy data If parameter "visualization" is set to "1" the accuracy data will be visualized in a dialog window iV_GetAccuracy will not return until "AccuracyStruct" is updated
|
| DLLExport int __stdcall | iV_GetCurrentCalibrationPoint (struct CalibrationPointStruct *actualCalibrationPoint) |
| | updates "currentCalibrationPoint" with current calibration point data
|
| DLLExport int __stdcall | iV_EnableGazeDataFilter () |
| | enables a gaze data filter. This API bilateral filter was implemented due to special HCI application requirements
|
| DLLExport int __stdcall | iV_DisableGazeDataFilter () |
| | disables the raw data filter
|
| DLLExport int __stdcall | iV_GetSample (struct SampleStruct *rawDataSample) |
| | updates "rawDataSample" with current eyetracking data
|
| DLLExport int __stdcall | iV_GetSample32 (struct SampleStruct32 *rawDataSample) |
| | updates "rawDataSample" with current eyetracking data
|
| DLLExport int __stdcall | iV_SetEventDetectionParameter (int minDuration, int maxDispersion) |
| | defines detection parameter for online fixation detection algorithm
|
| DLLExport int __stdcall | iV_GetEvent (struct EventStruct *eventDataSample) |
| | updates "eventDataSample" with current event data
|
| DLLExport int __stdcall | iV_GetEvent32 (struct EventStruct32 *eventDataSample) |
| | updates "eventDataSample" with current event data
|
| DLLExport int __stdcall | iV_SendImageMessage (char etMessage[256]) |
| | sends a text message to iView X. "etMessage" will be written to the data file. If "etMessage" ends on .jpg, .bmp, .png, or .avi BeGaze will separate the data buffer into according trials.
|
| DLLExport int __stdcall | iV_SetLogger (int logLevel, char filename[256]) |
| | defines the logging behavior of iView X SDK
|
| DLLExport int __stdcall | iV_Log (char logMessage[256]) |
| | writes "logMessage" to log file
|
| DLLExport int __stdcall | iV_SetupREDStandAloneMode (struct REDStandAloneModeStruct *standAloneModeGeometry) |
| | defines remotely the RED stand alone mode
|
| DLLExport int __stdcall | iV_GetActualTimestamp (long long *actualTimestamp) |
| | requests the eye tracker time stamp
|
| DLLExport int __stdcall | iV_ShowEyeImageMonitor () |
| | visualizes eye image in seperate dialog (available for all devices except RED)
|
| DLLExport int __stdcall | iV_ShowSceneVideoMonitor () |
| | visualizes scene video in seperate dialog (available for HED devices only)
|
| DLLExport int __stdcall | iV_ShowTrackingMonitor () |
| | visualizes RED Tracking Monitor (available for RED devices only)
|
| DLLExport void __stdcall | iV_SetCalibrationCallback (pDLLSetCalibrationPoint pCalibrationCallbackFunction) |
| | "iV_CalibrationCallback" function will be called if a calibration point has changed, the calibration has been finished or aborted. This callback allows drawing a customized calibration routine.
|
| DLLExport void __stdcall | iV_SetSampleCallback (pDLLSetSample pSampleCallbackFunction) |
| | "iV_SampleCallback" function will be called if iView X has generated a new raw data sample. Important note: Dependent on the sample rate critical algorithms with high processor usage shouldn't be running within this callback
|
| DLLExport void __stdcall | iV_SetEventCallback (pDLLSetEvent pEventCallbackFunction) |
| | "iV_EventCallback" function will be called if an real-time detected fixation has started or ended.
|
|
DLLExport int __stdcall | Test () |
| | Test - test routine.
|
The file contains the prototype declaration for all supported functions and data structs the customer needs to use.
Definition in file iViewXAPI.h.
