lib/iViewXAPI.h

Go to the documentation of this file.

#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     


/*
* With these defines it is possible to setup the logging status 
* for the function "iV_Log". With "iV_Log" it is possible to observe the 
* communication between a user’s application and iView X and/or function 
* calls. Log levels can be combined (e.g. LOG_BUG | LOG_IV_COMMAND | LOG_ETCOM). 
*/ 
#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      


/* 
* With ET_PARAM_ and function "iV_SetTrackingParameter" it is possible 
* to change iView X tracking parameters, for example pupil threshold and 
* corneal reflex thresholds, eye image contours, and other parameters.
* 
* Important note: This function can strongly affect tracking stability of 
* your iView X system. Only experienced users should use this function. 
*/
#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


/*
* The enumeration ETDevice can be used in connection with 
* "iV_GetSystemInfo" to get information about which type of device is 
* connected to iView X. It is part of the "SystemInfoStruct".
* (NONE = 0, RED = 1, HiSpeed = 2, MRI/MEG = 3, HED = 4, Custom = 5) 
*/
enum ETDevice {NONE, RED, HiSpeed, MRI, HED, Custom};


struct SystemInfoStruct
{
        int samplerate;                                 
        int iV_MajorVersion;                    
        int iV_MinorVersion;                    
        int iV_Buildnumber;                             
        int API_MajorVersion;                   
        int API_MinorVersion;                   
        int API_Buildnumber;                    
        enum ETDevice iV_ETDevice;              
};


struct CalibrationPointStruct
{
        int number;                                                     
        int positionX;                                          
        int positionY;                                          
};


struct EyeDataStruct
{
        double gazeX;                                   
        double gazeY;                                   
        double diam;                                    
        double eyePositionX;                    
        double eyePositionY;                    
        double eyePositionZ;                    
};


struct SampleStruct
{
        long long timestamp;                            
        EyeDataStruct leftEye;                          
        EyeDataStruct rightEye;                         
        int     planeNumber;                                    
};


struct SampleStruct32
{
        double timestamp;                                       
        EyeDataStruct leftEye;                          
        EyeDataStruct rightEye;                         
        int     planeNumber;                                    
};


struct EventStruct
{
        char eventType;                                         
        char eye;                                                       
        long long startTime;                            
        long long endTime;                                      
        long long duration;                                     
        double positionX;                                       
        double positionY;                                       
};


struct EventStruct32
{
        char eventType;                                         
        char eye;                                                       
        double startTime;                                       
        double endTime;                                         
        double duration;                                        
        double positionX;                                       
        double positionY;                                       
};


struct AccuracyStruct
{
        double deviationLX;                             
        double deviationLY;                             
        double deviationRX;                             
        double deviationRY;                             
};


struct CalibrationStruct
{
        int method;                                             
        int visualization;                              
        int displayDevice;                              
        int speed;                                              
        int autoAccept;                                 
        int foregroundBrightness;               
        int backgroundBrightness;               
        int targetShape;                                
        int targetSize;                                 
        char targetFilename[256];               
};


struct REDStandAloneModeStruct
{
        int stimX;
        int stimY;
        int stimHeightOverFloor;
        int redHeightOverFloor;
        int redStimDist;
        int redInclAngle;
};



typedef int (CALLBACK *pDLLSetCalibrationPoint)(struct CalibrationPointStruct calibrationPoint);
typedef int (CALLBACK *pDLLSetSample)(struct SampleStruct rawDataSample);
typedef int (CALLBACK *pDLLSetEvent)(struct EventStruct eventDataSample);




DLLExport int __stdcall iV_SetLicense(char* licenseKey);


DLLExport int __stdcall iV_Start();


DLLExport int __stdcall iV_Quit();


DLLExport int __stdcall iV_SendCommand(char etMessage[256]);


DLLExport int __stdcall iV_Connect(char sendIPAddress[16], int sendPort, char recvIPAddress[16], int receivePort);


DLLExport int __stdcall iV_IsConnected();


DLLExport int __stdcall iV_Disconnect();


DLLExport int __stdcall iV_GetSystemInfo(struct SystemInfoStruct *systemInfoData);


DLLExport int __stdcall iV_SetTrackingParameter(int ET_PARAM_EYE, int ET_PARAM, int value);


DLLExport int __stdcall iV_StartRecording();


DLLExport int __stdcall iV_StopRecording();


DLLExport int __stdcall iV_ContinueRecording(char etMessage[256]);


DLLExport int __stdcall iV_PauseRecording();

DLLExport int __stdcall iV_ClearRecordingBuffer();
        

DLLExport int __stdcall iV_SaveData(char filename[256], char description[64], char user[64], int overwrite);


DLLExport int __stdcall iV_SetupCalibration(struct CalibrationStruct *calibrationData);


DLLExport int __stdcall iV_SaveCalibration(char name[256]);


DLLExport int __stdcall iV_LoadCalibration(char name[256]);


DLLExport int __stdcall iV_AcceptCalibrationPoint();


DLLExport int __stdcall iV_AbortCalibration();


DLLExport int __stdcall iV_ChangeCalibrationPoint(int number, int positionX, int positionY);


DLLExport int __stdcall iV_ResetCalibrationPoints();


DLLExport int __stdcall iV_Calibrate();


DLLExport int __stdcall iV_Validate();


DLLExport int __stdcall iV_GetAccuracy(struct AccuracyStruct *accuracyData, int visualization);


DLLExport int __stdcall iV_GetCurrentCalibrationPoint(struct CalibrationPointStruct *actualCalibrationPoint);


DLLExport int __stdcall iV_EnableGazeDataFilter();


DLLExport int __stdcall iV_DisableGazeDataFilter();


DLLExport int __stdcall iV_GetSample(struct SampleStruct *rawDataSample);


DLLExport int __stdcall iV_GetSample32(struct SampleStruct32 *rawDataSample);


DLLExport int __stdcall iV_SetEventDetectionParameter(int minDuration, int maxDispersion);


DLLExport int __stdcall iV_GetEvent(struct EventStruct *eventDataSample);


DLLExport int __stdcall iV_GetEvent32(struct EventStruct32 *eventDataSample);


DLLExport int __stdcall iV_SendImageMessage(char etMessage[256]);


DLLExport int __stdcall iV_SetLogger(int logLevel, char filename[256]);


DLLExport int __stdcall iV_Log(char logMessage[256]);


DLLExport int __stdcall iV_SetupREDStandAloneMode(struct REDStandAloneModeStruct *standAloneModeGeometry);


DLLExport int __stdcall iV_GetActualTimestamp(long long *actualTimestamp);


DLLExport int __stdcall iV_ShowEyeImageMonitor();


DLLExport int __stdcall iV_ShowSceneVideoMonitor();


DLLExport int __stdcall iV_ShowTrackingMonitor(); 


DLLExport void __stdcall iV_SetCalibrationCallback(pDLLSetCalibrationPoint pCalibrationCallbackFunction); 


DLLExport void __stdcall iV_SetSampleCallback(pDLLSetSample pSampleCallbackFunction); 


DLLExport void __stdcall iV_SetEventCallback(pDLLSetEvent pEventCallbackFunction); 


DLLExport int __stdcall Test();