tobii_research_streams.h

Go to the documentation of this file.

 
#ifndef TOBII_RESEARCH_STREAMS_H_
#define TOBII_RESEARCH_STREAMS_H_
 
#include "tobii_research.h"
#include "tobii_research_eyetracker.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum {
    TOBII_RESEARCH_VALIDITY_INVALID,
 
    TOBII_RESEARCH_VALIDITY_VALID
} TobiiResearchValidity;
 
typedef struct {
    TobiiResearchPoint3D position_in_user_coordinates;
 
    TobiiResearchNormalizedPoint3D position_in_track_box_coordinates;
 
    TobiiResearchValidity validity;
} TobiiResearchGazeOrigin;
 
typedef struct {
    float diameter;
 
    TobiiResearchValidity validity;
} TobiiResearchPupilData;
 
typedef struct {
    TobiiResearchNormalizedPoint2D position_on_display_area;
 
    TobiiResearchPoint3D position_in_user_coordinates;
 
    TobiiResearchValidity validity;
} TobiiResearchGazePoint;
 
typedef struct {
    TobiiResearchGazePoint gaze_point;
 
    TobiiResearchPupilData pupil_data;
 
    TobiiResearchGazeOrigin gaze_origin;
} TobiiResearchEyeData;
 
typedef struct {
    TobiiResearchEyeData left_eye;
 
    TobiiResearchEyeData right_eye;
 
    int64_t device_time_stamp;
 
    int64_t system_time_stamp;
} TobiiResearchGazeData;
 
 
typedef struct {
    TobiiResearchNormalizedPoint3D user_position;
 
    TobiiResearchValidity validity;
} TobiiResearchEyeUserPositionGuide;
 
 
typedef struct {
    TobiiResearchEyeUserPositionGuide left_eye;
 
    TobiiResearchEyeUserPositionGuide right_eye;
} TobiiResearchUserPositionGuide;
 
 
typedef struct {
    TobiiResearchNormalizedPoint2D position_in_tracking_area;
 
    TobiiResearchValidity validity;
} TobiiResearchHMDPupilPosition;
 
typedef struct {
    TobiiResearchPoint3D position_in_hmd_coordinates;
 
    TobiiResearchValidity validity;
} TobiiResearchHMDGazeOrigin;
 
typedef struct {
    TobiiResearchNormalizedPoint3D unit_vector;
 
    TobiiResearchValidity validity;
} TobiiResearchHMDGazeDirection;
 
typedef struct {
    TobiiResearchHMDGazeDirection gaze_direction;
 
    TobiiResearchPupilData pupil_data;
 
    TobiiResearchHMDGazeOrigin gaze_origin;
 
    TobiiResearchHMDPupilPosition pupil_position;
} TobiiResearchHMDEyeData;
 
typedef struct {
    TobiiResearchHMDEyeData left_eye;
 
    TobiiResearchHMDEyeData right_eye;
 
    int64_t device_time_stamp;
 
    int64_t system_time_stamp;
} TobiiResearchHMDGazeData;
 
typedef struct {
    int64_t system_request_time_stamp;
 
    int64_t device_time_stamp;
 
    int64_t system_response_time_stamp;
} TobiiResearchTimeSynchronizationData;
 
typedef enum {
    TOBII_RESEARCH_EXTERNAL_SIGNAL_VALUE_CHANGED,
 
    TOBII_RESEARCH_EXTERNAL_SIGNAL_INITIAL_VALUE,
 
    TOBII_RESEARCH_EXTERNAL_SIGNAL_CONNECTION_RESTORED
} TobiiResearchExternalSignalChangeType;
 
typedef struct {
    int64_t device_time_stamp;
 
    int64_t system_time_stamp;
 
    uint32_t value;
 
    TobiiResearchExternalSignalChangeType change_type;
} TobiiResearchExternalSignalData;
 
typedef enum {
    TOBII_RESEARCH_STREAM_ERROR_CONNECTION_LOST,
 
    TOBII_RESEARCH_STREAM_ERROR_INSUFFICIENT_LICENSE,
 
    TOBII_RESEARCH_STREAM_ERROR_NOT_SUPPORTED,
 
    TOBII_RESEARCH_STREAM_ERROR_TOO_MANY_SUBSCRIBERS,
 
    TOBII_RESEARCH_STREAM_ERROR_INTERNAL_ERROR,
 
    TOBII_RESEARCH_STREAM_ERROR_USER_ERROR
} TobiiResearchStreamError;
 
typedef enum {
    TOBII_RESEARCH_STREAM_ERROR_SOURCE_USER,
 
    TOBII_RESEARCH_STREAM_ERROR_SOURCE_STREAM_PUMP,
 
    TOBII_RESEARCH_STREAM_ERROR_SOURCE_SUBSCRIPTION_GAZE_DATA,
 
    TOBII_RESEARCH_STREAM_ERROR_SOURCE_SUBSCRIPTION_EXTERNAL_SIGNAL,
 
    TOBII_RESEARCH_STREAM_ERROR_SOURCE_SUBSCRIPTION_TIME_SYNCHRONIZATION_DATA,
 
    TOBII_RESEARCH_STREAM_ERROR_SOURCE_SUBSCRIPTION_EYE_IMAGE,
 
    TOBII_RESEARCH_STREAM_ERROR_SOURCE_SUBSCRIPTION_NOTIFICATION,
 
    TOBII_RESEARCH_STREAM_ERROR_SOURCE_SUBSCRIPTION_HMD_GAZE_DATA,
 
    TOBII_RESEARCH_STREAM_ERROR_SOURCE_SUBSCRIPTION_USER_POSITION_GUIDE
} TobiiResearchStreamErrorSource;
 
typedef enum {
    TOBII_RESEARCH_NOTIFICATION_CONNECTION_LOST,
 
    TOBII_RESEARCH_NOTIFICATION_CONNECTION_RESTORED,
 
    TOBII_RESEARCH_NOTIFICATION_CALIBRATION_MODE_ENTERED,
 
    TOBII_RESEARCH_NOTIFICATION_CALIBRATION_MODE_LEFT,
 
    TOBII_RESEARCH_NOTIFICATION_CALIBRATION_CHANGED,
 
    TOBII_RESEARCH_NOTIFICATION_TRACK_BOX_CHANGED,
 
    TOBII_RESEARCH_NOTIFICATION_DISPLAY_AREA_CHANGED,
 
    TOBII_RESEARCH_NOTIFICATION_GAZE_OUTPUT_FREQUENCY_CHANGED,
 
    TOBII_RESEARCH_NOTIFICATION_EYE_TRACKING_MODE_CHANGED,
 
    TOBII_RESEARCH_NOTIFICATION_DEVICE_FAULTS,
 
    TOBII_RESEARCH_NOTIFICATION_DEVICE_WARNINGS,
 
    TOBII_RESEARCH_NOTIFICATION_STREAM_BUFFER_OVERFLOW,
    TOBII_RESEARCH_NOTIFICATION_UNKNOWN
} TobiiResearchNotificationType;
 
 
typedef char TobiiResearchNotificationString[512];
 
typedef struct {
    int64_t system_time_stamp;
    TobiiResearchNotificationType notification_type;
    union {
        float output_frequency;
 
        TobiiResearchDisplayArea display_area;
 
        TobiiResearchNotificationString text;
    } value;
} TobiiResearchNotification;
 
typedef void(*tobii_research_gaze_data_callback)(TobiiResearchGazeData* gaze_data, void* user_data);
 
TOBII_RESEARCH_API TobiiResearchStatus TOBII_RESEARCH_CALL tobii_research_subscribe_to_gaze_data(
                        TobiiResearchEyeTracker* eyetracker,
                        tobii_research_gaze_data_callback callback, void* user_data);
 
TOBII_RESEARCH_API TobiiResearchStatus TOBII_RESEARCH_CALL tobii_research_unsubscribe_from_gaze_data(
                        TobiiResearchEyeTracker* eyetracker,
                        tobii_research_gaze_data_callback callback);
 
 
typedef void(*tobii_research_user_position_guide_callback)(TobiiResearchUserPositionGuide* user_position_guide,
    void* user_data);
 
 
TOBII_RESEARCH_API TobiiResearchStatus TOBII_RESEARCH_CALL tobii_research_subscribe_to_user_position_guide(
                        TobiiResearchEyeTracker* eyetracker,
                        tobii_research_user_position_guide_callback callback, void* user_data);
 
TOBII_RESEARCH_API TobiiResearchStatus TOBII_RESEARCH_CALL tobii_research_unsubscribe_from_user_position_guide(
                        TobiiResearchEyeTracker* eyetracker,
                        tobii_research_user_position_guide_callback callback);
 
typedef void(*tobii_research_hmd_gaze_data_callback)(TobiiResearchHMDGazeData* hmd_gaze_data, void* user_data);
 
TOBII_RESEARCH_API TobiiResearchStatus TOBII_RESEARCH_CALL tobii_research_subscribe_to_hmd_gaze_data(
        TobiiResearchEyeTracker* eyetracker, tobii_research_hmd_gaze_data_callback callback, void* user_data);
 
TOBII_RESEARCH_API TobiiResearchStatus TOBII_RESEARCH_CALL tobii_research_unsubscribe_from_hmd_gaze_data(
        TobiiResearchEyeTracker* eyetracker, tobii_research_hmd_gaze_data_callback callback);
 
typedef void(*tobii_research_external_signal_data_callback)(TobiiResearchExternalSignalData* external_signal_data,
        void* user_data);
 
TOBII_RESEARCH_API TobiiResearchStatus TOBII_RESEARCH_CALL tobii_research_subscribe_to_external_signal_data(
        TobiiResearchEyeTracker* eyetracker,
        tobii_research_external_signal_data_callback callback, void* user_data);
 
TOBII_RESEARCH_API TobiiResearchStatus TOBII_RESEARCH_CALL tobii_research_unsubscribe_from_external_signal_data(
        TobiiResearchEyeTracker* eyetracker,
        tobii_research_external_signal_data_callback callback);
 
typedef void(*tobii_research_time_synchronization_data_callback)(
        TobiiResearchTimeSynchronizationData* time_synchronization_data,
        void* user_data);
 
TOBII_RESEARCH_API TobiiResearchStatus TOBII_RESEARCH_CALL tobii_research_subscribe_to_time_synchronization_data(
        TobiiResearchEyeTracker* eyetracker,
        tobii_research_time_synchronization_data_callback callback,
        void* user_data);
 
TOBII_RESEARCH_API TobiiResearchStatus TOBII_RESEARCH_CALL tobii_research_unsubscribe_from_time_synchronization_data(
        TobiiResearchEyeTracker* eyetracker,
        tobii_research_time_synchronization_data_callback callback);
 
 
typedef struct {
    int64_t system_time_stamp;
    TobiiResearchStreamError error;
    TobiiResearchStreamErrorSource source;
    const char* message;
} TobiiResearchStreamErrorData;
 
typedef void(*tobii_research_stream_error_callback)(
    TobiiResearchStreamErrorData* stream_error,
    void* user_data);
 
TOBII_RESEARCH_API TobiiResearchStatus TOBII_RESEARCH_CALL tobii_research_subscribe_to_stream_errors(
        TobiiResearchEyeTracker* eyetracker,
        tobii_research_stream_error_callback callback,
        void* user_data);
 
TOBII_RESEARCH_API TobiiResearchStatus TOBII_RESEARCH_CALL tobii_research_unsubscribe_from_stream_errors(
        TobiiResearchEyeTracker* eyetracker,
        tobii_research_stream_error_callback callback);
 
typedef void(*tobii_research_notification_callback)(
        TobiiResearchNotification* notification,
        void* user_data);
 
TOBII_RESEARCH_API TobiiResearchStatus TOBII_RESEARCH_CALL tobii_research_subscribe_to_notifications(
        TobiiResearchEyeTracker* eyetracker,
        tobii_research_notification_callback callback,
        void* user_data);
 
TOBII_RESEARCH_API TobiiResearchStatus TOBII_RESEARCH_CALL tobii_research_unsubscribe_from_notifications(
        TobiiResearchEyeTracker* eyetracker,
        tobii_research_notification_callback callback);
 
typedef enum {
    TOBII_RESEARCH_EYE_IMAGE_TYPE_FULL,
    TOBII_RESEARCH_EYE_IMAGE_TYPE_CROPPED,
    TOBII_RESEARCH_EYE_IMAGE_TYPE_MULTI_ROI,
    TOBII_RESEARCH_EYE_IMAGE_TYPE_UNKNOWN
} TobiiResearchEyeImageType;
 
typedef struct {
    int64_t device_time_stamp;
    int64_t system_time_stamp;
    int bits_per_pixel;
    int padding_per_pixel;
    int width;
    int height;
    TobiiResearchEyeImageType type;
    int camera_id;
    size_t data_size;
    void* data;
    int region_id;
    int top;
    int left;
} TobiiResearchEyeImage;
 
typedef struct {
    int64_t device_time_stamp;
    int64_t system_time_stamp;
    TobiiResearchEyeImageType type;
    int camera_id;
    size_t image_size;
    void* image_data;
    int region_id;
    int top;
    int left;
} TobiiResearchEyeImageGif;
 
typedef void(*tobii_research_eye_image_callback)(TobiiResearchEyeImage* frame, void* user_data);
 
typedef void(*tobii_research_eye_image_as_gif_callback)(TobiiResearchEyeImageGif* frame, void* user_data);
 
TOBII_RESEARCH_API TobiiResearchStatus TOBII_RESEARCH_CALL tobii_research_subscribe_to_eye_image(
        TobiiResearchEyeTracker* eyetracker,
        tobii_research_eye_image_callback callback,
        void* user_data);
 
TOBII_RESEARCH_API TobiiResearchStatus TOBII_RESEARCH_CALL tobii_research_subscribe_to_eye_image_as_gif(
        TobiiResearchEyeTracker* eyetracker,
        tobii_research_eye_image_as_gif_callback callback,
        void* user_data);
 
TOBII_RESEARCH_API TobiiResearchStatus TOBII_RESEARCH_CALL tobii_research_unsubscribe_from_eye_image(
        TobiiResearchEyeTracker* eyetracker,
        tobii_research_eye_image_callback callback);
 
TOBII_RESEARCH_API TobiiResearchStatus TOBII_RESEARCH_CALL tobii_research_unsubscribe_from_eye_image_as_gif(
        TobiiResearchEyeTracker* eyetracker,
        tobii_research_eye_image_as_gif_callback callback);
 
typedef struct {
    int64_t device_time_stamp;
 
    int64_t system_time_stamp;
 
    TobiiResearchValidity left_eye_validity;
 
    float left_eye_openness_value;
 
    TobiiResearchValidity right_eye_validity;
 
    float right_eye_openness_value;
} TobiiResearchEyeOpennessData;
 
typedef void(*tobii_research_eye_openness_data_callback)(
    TobiiResearchEyeOpennessData* openness_data, void* user_data);
 
TOBII_RESEARCH_API TobiiResearchStatus TOBII_RESEARCH_CALL tobii_research_subscribe_to_eye_openness(
    TobiiResearchEyeTracker* eyetracker, tobii_research_eye_openness_data_callback callback, void* user_data
);
 
TOBII_RESEARCH_API TobiiResearchStatus TOBII_RESEARCH_CALL tobii_research_unsubscribe_from_eye_openness(
    TobiiResearchEyeTracker* eyetracker, tobii_research_eye_openness_data_callback callback
);
 
#ifdef __cplusplus
}
#endif
#endif /* TOBII_RESEARCH_STREAMS_H_ */