tobii_research.h

Go to the documentation of this file.

#ifndef TOBII_RESEARCH_H_
#define TOBII_RESEARCH_H_

#ifdef __cplusplus
extern "C" {
#endif

#include <stddef.h>
#include <stdint.h>

#if _WIN32 || _WIN64
#ifdef TOBII_STATIC_LIB
#define TOBII_RESEARCH_CALL
#define TOBII_RESEARCH_API
#else
#define TOBII_RESEARCH_CALL __cdecl
#ifdef TOBII_EXPORTING
#define TOBII_RESEARCH_API __declspec(dllexport)
#else
#define TOBII_RESEARCH_API __declspec(dllimport)
#endif /* TOBII_EXPORTING */
#endif /* TOBII_STATIC_LIB */
#else
#define TOBII_RESEARCH_API
#define TOBII_RESEARCH_CALL
#endif /* _WIN32 */


typedef enum {
    TOBII_RESEARCH_STATUS_OK,

    TOBII_RESEARCH_STATUS_FATAL_ERROR,

    TOBII_RESEARCH_STATUS_INITIALIZE_FAILED,

    TOBII_RESEARCH_STATUS_TERMINATE_FAILED,

    TOBII_RESEARCH_STATUS_LOCALBROWSER_CREATE_FAILED,

    TOBII_RESEARCH_STATUS_LOCALBROWSER_POLL_FAILED,

    TOBII_RESEARCH_STATUS_ZEROCONFBROWSER_CREATE_FAILED,

    TOBII_RESEARCH_STATUS_ZEROCONFBROWSER_POLL_FAILED,

    TOBII_RESEARCH_STATUS_FILEBROWSER_CREATE_FAILED,

    TOBII_RESEARCH_STATUS_FILEBROWSER_POLL_FAILED,

    TOBII_RESEARCH_STATUS_INVALID_PARAMETER,

    TOBII_RESEARCH_STATUS_INVALID_OPERATION,

    TOBII_RESEARCH_STATUS_UNINITIALIZED,

    TOBII_RESEARCH_STATUS_OUT_OF_BOUNDS,

    TOBII_RESEARCH_STATUS_DISPLAY_AREA_NOT_VALID,

    TOBII_RESEARCH_STATUS_BUFFER_TOO_SMALL,

    TOBII_RESEARCH_STATUS_NOT_INITIALIZED,

    TOBII_RESEARCH_STATUS_ALREADY_INITIALIZED,

    TOBII_RESEARCH_STATUS_SAVED_LICENSE_FAILED_TO_APPLY,

    TOBII_RESEARCH_STATUS_SE_INTERNAL = 200,

    TOBII_RESEARCH_STATUS_SE_INSUFFICIENT_LICENSE,

    TOBII_RESEARCH_STATUS_SE_NOT_SUPPORTED,

    TOBII_RESEARCH_STATUS_SE_NOT_AVAILABLE,

    TOBII_RESEARCH_STATUS_SE_CONNECTION_FAILED,

    TOBII_RESEARCH_STATUS_SE_TIMED_OUT,

    TOBII_RESEARCH_STATUS_SE_ALLOCATION_FAILED,

    TOBII_RESEARCH_STATUS_SE_ALREADY_INITIALIZED,

    TOBII_RESEARCH_STATUS_SE_NOT_INITIALIZED,

    TOBII_RESEARCH_STATUS_SE_INVALID_PARAMETER,

    TOBII_RESEARCH_STATUS_SE_CALIBRATION_ALREADY_STARTED,

    TOBII_RESEARCH_STATUS_SE_CALIBRATION_NOT_STARTED,

    TOBII_RESEARCH_STATUS_SE_ALREADY_SUBSCRIBED,

    TOBII_RESEARCH_STATUS_SE_NOT_SUBSCRIBED,

    TOBII_RESEARCH_STATUS_SE_OPERATION_FAILED,

    TOBII_RESEARCH_STATUS_SE_CONFLICTING_API_INSTANCES,

    TOBII_RESEARCH_STATUS_SE_CALIBRATION_BUSY,

    TOBII_RESEARCH_STATUS_SE_CALLBACK_IN_PROGRESS,

    TOBII_RESEARCH_STATUS_SE_TOO_MANY_SUBSCRIBERS,

    TOBII_RESEARCH_STATUS_SE_BUFFER_TOO_SMALL,

    TOBII_RESEARCH_STATUS_SE_FIRMWARE_NO_RESPONSE,

    TOBII_RESEARCH_STATUS_FWUPGRADE_INTERNAL = 400,

    TOBII_RESEARCH_STATUS_FWUPGRADE_NOT_SUPPORTED,

    TOBII_RESEARCH_STATUS_FWUPGRADE_UNKNOWN_FIRMWARE_VERSION,

    TOBII_RESEARCH_STATUS_FWUPGRADE_CONNECTION_FAILED,

    TOBII_RESEARCH_STATUS_FWUPGRADE_INVALID_PARAMETER,

    TOBII_RESEARCH_STATUS_FWUPGRADE_PACKAGE_DEVICE_MISMATCH,

    TOBII_RESEARCH_STATUS_FWUPGRADE_PARSE_RESPONSE,

    TOBII_RESEARCH_STATUS_FWUPGRADE_OPERATION_FAILED,

    TOBII_RESEARCH_STATUS_FWUPGRADE_ALLOCATION_FAILED,

    TOBII_RESEARCH_STATUS_FWUPGRADE_FIRMWARE_NO_RESPONSE,

    TOBII_RESEARCH_STATUS_FWUPGRADE_DOWNGRADE_NOT_SUPPORTED,

    TOBII_RESEARCH_STATUS_UNKNOWN = 1000
} TobiiResearchStatus;

typedef struct TobiiResearchEyeTracker TobiiResearchEyeTracker;

typedef struct {
    TobiiResearchEyeTracker** eyetrackers;
    size_t count;
} TobiiResearchEyeTrackers;

typedef enum {
    TOBII_RESEARCH_LOG_SOURCE_STREAM_ENGINE,

    TOBII_RESEARCH_LOG_SOURCE_SDK,

    TOBII_RESEARCH_LOG_SOURCE_FIRMWARE_UPGRADE
} TobiiResearchLogSource;

typedef enum {
    TOBII_RESEARCH_LOG_LEVEL_ERROR,

    TOBII_RESEARCH_LOG_LEVEL_WARNING,

    TOBII_RESEARCH_LOG_LEVEL_INFORMATION,

    TOBII_RESEARCH_LOG_LEVEL_DEBUG,

    TOBII_RESEARCH_LOG_LEVEL_TRACE
} TobiiResearchLogLevel;

typedef struct {
    float x;
    float y;
} TobiiResearchNormalizedPoint2D;


typedef struct {
    float x;
    float y;
    float z;
} TobiiResearchPoint3D;

typedef TobiiResearchPoint3D TobiiResearchNormalizedPoint3D;

typedef void(*tobii_research_log_callback)(int64_t system_time_stamp,
                TobiiResearchLogSource source,
                TobiiResearchLogLevel level,
                const char* message);

TOBII_RESEARCH_API TobiiResearchStatus TOBII_RESEARCH_CALL tobii_research_logging_subscribe(
                        tobii_research_log_callback callback);

TOBII_RESEARCH_API TobiiResearchStatus TOBII_RESEARCH_CALL tobii_research_logging_unsubscribe();

TOBII_RESEARCH_API TobiiResearchStatus TOBII_RESEARCH_CALL tobii_research_find_all_eyetrackers(
                        TobiiResearchEyeTrackers** eyetrackers);

TOBII_RESEARCH_API void TOBII_RESEARCH_CALL tobii_research_free_eyetrackers(
                        TobiiResearchEyeTrackers* eyetrackers);

TOBII_RESEARCH_API TobiiResearchStatus TOBII_RESEARCH_CALL tobii_research_get_eyetracker(
                        const char* address,
                        TobiiResearchEyeTracker** eyetracker);

TOBII_RESEARCH_API TobiiResearchStatus TOBII_RESEARCH_CALL tobii_research_get_system_time_stamp(int64_t* time_stamp_us);

TOBII_RESEARCH_API void TOBII_RESEARCH_CALL tobii_research_free_string(char* str);


typedef struct {
    int major;
    int minor;
    int revision;
    int build;
} TobiiResearchSDKVersion;

TOBII_RESEARCH_API TobiiResearchStatus TOBII_RESEARCH_CALL tobii_research_get_sdk_version(
                        TobiiResearchSDKVersion* sdk_version);

#ifdef __cplusplus
}
#endif
#endif /* TOBII_RESEARCH_H_ */