Tobii Pro SDK Python API
|
Provides methods and properties to manage and get data from an eye tracker. More...
Inherits object.
Public Member Functions | |
def | __init__ (self, address) |
Gets an eye tracker object that has the specified URI. More... | |
def | apply_licenses (self, license_key_ring) |
Sets a key ring of licenses or a single license for unlocking features of the eye tracker. More... | |
def | clear_applied_licenses (self) |
Clears any previously applied licenses. More... | |
def | retrieve_calibration_data (self) |
Gets the calibration data used currently by the eye tracker. More... | |
def | apply_calibration_data (self, calibration_data) |
Sets the provided calibration data to the eye tracker, which means it will be active calibration. More... | |
def | get_all_gaze_output_frequencies (self) |
Gets a list of gaze output frequencies supported by the eye tracker. More... | |
def | get_gaze_output_frequency (self) |
Gets the gaze output frequency of the eye tracker. More... | |
def | set_gaze_output_frequency (self, gaze_output_frequency) |
Sets the gaze output frequency of the eye tracker. More... | |
def | get_all_eye_tracking_modes (self) |
Gets a tuple of eye tracking modes supported by the eye tracker. More... | |
def | get_eye_tracking_mode (self) |
Gets the eye tracking mode of the eye tracker. More... | |
def | set_eye_tracking_mode (self, eye_tracking_mode) |
Sets the eye tracking mode of the eye tracker. More... | |
def | get_track_box (self) |
Gets the track box of the eye tracker. More... | |
def | get_display_area (self) |
Gets the size and corners of the display area. More... | |
def | set_display_area (self, display_area) |
Sets the display area of the eye tracker. More... | |
def | get_hmd_lens_configuration (self) |
Gets the current lens configuration of the HMD based eye tracker. More... | |
def | set_hmd_lens_configuration (self, lens_configuration) |
Sets the lens configuration of the HMD based eye tracker. More... | |
def | set_device_name (self, device_name) |
Changes the device name. More... | |
def | subscribe_to (self, subscription_type, callback, as_dictionary=False) |
Subscribes to data for the eye tracker. More... | |
def | unsubscribe_from (self, subscription_type, callback=None) |
Unsubscribes from data for the eye tracker. More... | |
Data Fields | |
address | |
Gets the address (URI) of the eye tracker device. | |
device_name | |
Gets the name of the eye tracker. | |
serial_number | |
Gets the serial number of the eye tracker. More... | |
model | |
Gets the model of the eye tracker. | |
firmware_version | |
Gets the firmware version of the eye tracker. | |
runtime_version | |
Gets the runtime version of the eye tracker. | |
device_capabilities | |
Gets a tuple with the capabilities of the device. More... | |
Provides methods and properties to manage and get data from an eye tracker.
EyeTracker objects are either created from an address or returned in a tuple from find_all_eyetrackers.
def tobii_research.EyeTracker.__init__ | ( | self, | |
address | |||
) |
Gets an eye tracker object that has the specified URI.
address | Address (URI) to the eye tracker. |
EyeTrackerConnectionFailedError | |
EyeTrackerInternalError | |
ValueError |
def tobii_research.EyeTracker.apply_calibration_data | ( | self, | |
calibration_data | |||
) |
Sets the provided calibration data to the eye tracker, which means it will be active calibration.
See find_all_eyetrackers or EyeTracker.__init__ on how to create an EyeTracker object.
EyeTrackerConnectionFailedError | |
EyeTrackerInternalError | |
EyeTrackerLicenseError | |
ValueError |
def tobii_research.EyeTracker.apply_licenses | ( | self, | |
license_key_ring | |||
) |
Sets a key ring of licenses or a single license for unlocking features of the eye tracker.
See find_all_eyetrackers or EyeTracker.__init__ on how to create an EyeTracker object.
license_key_ring | List of LicenseKey objects, list of bytes, LicenseKey object or bytes object. |
EyeTrackerConnectionFailedError | |
EyeTrackerInternalError | |
AttributeError | |
TypeError |
def tobii_research.EyeTracker.clear_applied_licenses | ( | self | ) |
Clears any previously applied licenses.
def tobii_research.EyeTracker.get_all_eye_tracking_modes | ( | self | ) |
Gets a tuple of eye tracking modes supported by the eye tracker.
See find_all_eyetrackers or EyeTracker.__init__ on how to create an EyeTracker object.
def tobii_research.EyeTracker.get_all_gaze_output_frequencies | ( | self | ) |
Gets a list of gaze output frequencies supported by the eye tracker.
See find_all_eyetrackers or EyeTracker.__init__ on how to create an EyeTracker object.
def tobii_research.EyeTracker.get_display_area | ( | self | ) |
Gets the size and corners of the display area.
See find_all_eyetrackers or EyeTracker.__init__ on how to create an EyeTracker object.
EyeTrackerFeatureNotSupportedError | |
EyeTrackerConnectionFailedError | |
EyeTrackerInternalError | |
EyeTrackerLicenseError |
def tobii_research.EyeTracker.get_eye_tracking_mode | ( | self | ) |
Gets the eye tracking mode of the eye tracker.
See find_all_eyetrackers or EyeTracker.__init__ on how to create an EyeTracker object.
def tobii_research.EyeTracker.get_gaze_output_frequency | ( | self | ) |
Gets the gaze output frequency of the eye tracker.
See find_all_eyetrackers or EyeTracker.__init__ on how to create an EyeTracker object.
def tobii_research.EyeTracker.get_hmd_lens_configuration | ( | self | ) |
Gets the current lens configuration of the HMD based eye tracker.
The lens configuration describes how the lenses of the HMD device are positioned. See find_all_eyetrackers or EyeTracker.__init__ on how to create an EyeTracker object.
EyeTrackerFeatureNotSupportedError | |
EyeTrackerConnectionFailedError | |
EyeTrackerInternalError | |
EyeTrackerLicenseError |
def tobii_research.EyeTracker.get_track_box | ( | self | ) |
Gets the track box of the eye tracker.
See find_all_eyetrackers or EyeTracker.__init__ on how to create an EyeTracker object.
def tobii_research.EyeTracker.retrieve_calibration_data | ( | self | ) |
Gets the calibration data used currently by the eye tracker.
This data can be saved to a file for later use. See find_all_eyetrackers or EyeTracker.__init__ on how to create an EyeTracker object.
def tobii_research.EyeTracker.set_device_name | ( | self, | |
device_name | |||
) |
Changes the device name.
This is not supported by all eye trackers. See find_all_eyetrackers or EyeTracker.__init__ on how to create an EyeTracker object.
device_name | The eye tracker's desired name. |
def tobii_research.EyeTracker.set_display_area | ( | self, | |
display_area | |||
) |
Sets the display area of the eye tracker.
It is strongly recommended to use Eye Tracker Manager to calculate the display area coordinates as the origin of the User Coordinate System differs between eye tracker models. See find_all_eyetrackers or EyeTracker.__init__ on how to create an EyeTracker object.
display_area | The eye tracker's desired display_area as a DisplayArea object. |
def tobii_research.EyeTracker.set_eye_tracking_mode | ( | self, | |
eye_tracking_mode | |||
) |
Sets the eye tracking mode of the eye tracker.
See find_all_eyetrackers or EyeTracker.__init__ on how to create an EyeTracker object.
eye_tracking_mode | The eye tracking mode as a string. |
EyeTrackerConnectionFailedError | |
EyeTrackerInternalError | |
EyeTrackerLicenseError | |
ValueError |
def tobii_research.EyeTracker.set_gaze_output_frequency | ( | self, | |
gaze_output_frequency | |||
) |
Sets the gaze output frequency of the eye tracker.
See find_all_eyetrackers or EyeTracker.__init__ on how to create an EyeTracker object.
gaze_output_frequency | The gaze output frequency as a float value. |
EyeTrackerConnectionFailedError | |
EyeTrackerInternalError | |
EyeTrackerLicenseError | |
ValueError |
def tobii_research.EyeTracker.set_hmd_lens_configuration | ( | self, | |
lens_configuration | |||
) |
Sets the lens configuration of the HMD based eye tracker.
The lens configuration describes how the lenses of the HMD device are positioned See find_all_eyetrackers or EyeTracker.__init__ on how to create an EyeTracker object.
lens_configuration | The eye tracker's desired lens configuration as a HMDLensConfiguration object. |
def tobii_research.EyeTracker.subscribe_to | ( | self, | |
subscription_type, | |||
callback, | |||
as_dictionary = False |
|||
) |
Subscribes to data for the eye tracker.
See find_all_eyetrackers or EyeTracker.__init__ on how to create an EyeTracker object. You can subscribe to EYETRACKER_EXTERNAL_SIGNAL, EYETRACKER_EYE_IMAGES, EYETRACKER_HMD_GAZE_DATA, EYETRACKER_GAZE_DATA, EYETRACKER_USER_POSITION_GUIDE, EYETRACKER_NOTIFICATION_CONNECTION_LOST, EYETRACKER_NOTIFICATION_CONNECTION_RESTORED, EYETRACKER_NOTIFICATION_CALIBRATION_MODE_ENTERED, EYETRACKER_NOTIFICATION_CALIBRATION_MODE_LEFT, EYETRACKER_NOTIFICATION_CALIBRATION_CHANGED, EYETRACKER_NOTIFICATION_TRACK_BOX_CHANGED, EYETRACKER_NOTIFICATION_DISPLAY_AREA_CHANGED, EYETRACKER_NOTIFICATION_GAZE_OUTPUT_FREQUENCY_CHANGED, EYETRACKER_NOTIFICATION_EYE_TRACKING_MODE_CHANGED, EYETRACKER_NOTIFICATION_DEVICE_FAULTS, EYETRACKER_NOTIFICATION_DEVICE_WARNINGS, EYETRACKER_TIME_SYNCHRONIZATION_DATA or EYETRACKER_STREAM_ERRORS.
subscription_type | Type of data to subscribe to. |
callback | Callback receiveing the data. See documentation of subscription types for details. |
as_dictionary | If True, the callback will receive a dictionary with values instead of a custom object. |
def tobii_research.EyeTracker.unsubscribe_from | ( | self, | |
subscription_type, | |||
callback = None |
|||
) |
Unsubscribes from data for the eye tracker.
See find_all_eyetrackers or EyeTracker.__init__ on how to create an EyeTracker object. You can unsubscribe from EYETRACKER_EXTERNAL_SIGNAL, EYETRACKER_EYE_IMAGES, EYETRACKER_GAZE_DATA, EYETRACKER_HMD_GAZE_DATA, EYETRACKER_USER_POSITION_GUIDE, EYETRACKER_NOTIFICATION_CONNECTION_LOST, EYETRACKER_NOTIFICATION_CONNECTION_RESTORED, EYETRACKER_NOTIFICATION_CALIBRATION_MODE_ENTERED, EYETRACKER_NOTIFICATION_CALIBRATION_MODE_LEFT, EYETRACKER_NOTIFICATION_CALIBRATION_CHANGED, EYETRACKER_NOTIFICATION_TRACK_BOX_CHANGED, EYETRACKER_NOTIFICATION_DISPLAY_AREA_CHANGED, EYETRACKER_NOTIFICATION_GAZE_OUTPUT_FREQUENCY_CHANGED, EYETRACKER_NOTIFICATION_EYE_TRACKING_MODE_CHANGED, EYETRACKER_NOTIFICATION_DEVICE_FAULTS, EYETRACKER_NOTIFICATION_DEVICE_WARNINGS, EYETRACKER_TIME_SYNCHRONIZATION_DATA or EYETRACKER_STREAM_ERRORS.
subscription_type | Type of data to unsubscribe from. |
callback | Callback sent to subscribe_to or None to unsubscribe all subscriptions of this type. |
tobii_research.EyeTracker.device_capabilities |
Gets a tuple with the capabilities of the device.
Valid values in the tuple are CAPABILITY_CAN_SET_DISPLAY_AREA, CAPABILITY_HAS_EXTERNAL_SIGNAL and CAPABILITY_HAS_EYE_IMAGES.
tobii_research.EyeTracker.serial_number |
Gets the serial number of the eye tracker.
All physical eye trackers have a unique serial number.