What's new!

Here you can read the latest news about the Tobii Pro SDK.

Release notes

Version 1.5.0 (2018-05-24)

Octave support!

This version extends the capability of the Matlab language binding so that it can be used with GNU Octave. Octave and Matlab users can download the same binaries and use the exact same syntax (when communicating with Tobii Pro SDK). Just like the other bindings, Octave is supported on both Windows, Linux and Mac.

Interface additions

All bindings
  • Two new notifications DeviceFaults, and DeviceWarnings have been added. These notifications can only be received from Tobii Pro Spectrum.

Version History

Version 1.4.0 (2018-04-11)

This version adds support for changing eyetracking mode on the Tobii Pro Spectrum (adding the possibility to eye track macaques). Note: This feature is only supported by the Tobii Pro Spectrum, and only on FW versions later than 1.7.5.

Two new notifications have been added in relation to this: EyeTrackingModeChanged, and CalibrationChanged (Note: calibrations cannot be reused between eye tracking modes on Pro Spectrum).

Interface additions

All bindings
  • Two new notifications EyeTrackingModeChanged, and CalibrationChanged (names vary slightly depending on binding)

Bug fixes

All bindings
  • Fixed memory leak when streaming eye images in GIF format.
  • Fixed issue with HMD eye trackers (fix also released in 1.3.1 patch release)
  • Fixed issue introduced in 1.3.0 with computeAndApply method in calibration (fix also released in 1.3.1 patch release)
  • Fixed issue where EyeTrackingOperations.GetEyeTracker would return null for 4C trackers.

General improvements

  • Examples and prefabs (that were previously in another package) have now been merged into the Pro SDK Unity package.
  • Prefabs have been added for screen based eye trackers
  • Prefabs for VR tracker have been updated
  • The following functionalities are now available as prefabs (for both VR and screen based eye trackers):
    • Eyetracker discovery and management
    • Calibration
    • Track-box (screen based) resp. Positioning Guide (VR)
    • Data saving (in XML format)
    • Gaze trail
  • Constructors for gaze data objects have been made public (previously internal). This can be useful if you (for example) wish to generate mock data, or want to modify received gaze data while keeping the same format.

Version 1.3.0 (2018-01-19)

This version adds support for monocular (and bi-monocular) calibration - the ability to calibrate one eye at the time, for example when studying eye movements of people with strabismus or similar conditions.
Note: This feature is only supported by the Tobii Pro Spectrum, and only on FW versions later than 1.5.0.

Interface additions

All bindings
  • New class with new methods for monocular calibration (except in C binding, where there's only new methods).

Bug fixes

All bindings
  • Fixed memory leak when streaming eye images.

Version 1.2.1 (2017-11-22)

General improvements

All bindings
  • Dependent libraries are now bundled into the tobii_research library! You will no longer have to wonder what the tobii_stream_engine, or tobii_pro libraries are! (except for .NET/Unity users, where tobii_pro.dll still remains) - Because sometimes, less is more!
  • Tobii Pro SDK now supports Python 3.5!

Version 1.2.0 (2017-10-11)

Interface additions

All bindings
  • New method, SetDisplayArea / set_display_area
    • This method can be used to set the display area of an eye tracker, i.e. the coordinates for the corners of the display that the eye tracker is used with. These coordinates are not trivial to calculate, and we strongly recommend to use Eye Tracker Manager to perform these calculations the first time. But once you have the correct values, you can now use the new method to re-apply these at your convenience!
C binding
  • Three new error codes have been added to the TobiiResearchStatus enum:

Bug fixes

.NET and Unity
  • Fixed issue where you would get multiple event callbacks for each subscribed notification. No longer so - "There can be only one!" ;-)

General improvements

  • Information and code examples have been added to the documentation explaining how to utilize Eye Tracker Manager's command line options to remove the need to implement your own calibration routine.
  • New code example explaining how to use Tobii Pro SDK (Matlab) together with Psychtoolbox.

Version 1.1.4 (2017-08-30)

Interface additions

  • New method, Terminate(), for making sure SDK resources are released.
.NET and Unity
  • New event type EyeImageRawEventArgs, for getting eye images formatted as raw pixel data (Tobii Pro Spectrum only).

Bug fixes

  • Fixed potential deadlock in FindAllEyeTrackers (if called from multiple threads)
  • Fixed issue in C binding where it would crash when get_xx_property is called with NULL args
  • Including C library in C++ no longer requires the use of "extern C".

General improvements

  • Tobii Pro SDK for Unity is now delivered as a Unity asset (.unitypackage)!

Version 1.1.0 (2017-06-14)

This version adds support for the new VR4 eye tracker development kit (known here as a "HMD eye tracker").

Interface additions

Adding support for VR/HMD eye trackers required making quite a few additions to the interface. These include:
  • New stream data (HMDGazeData) - both new data objects and callback/event types
  • New calibration (HMDBasedCalibration) - new object and methods
  • New capabilities - extended enums
  • New setting on EyeTracker (HMDLensConfiguration)
  • The TobiiResearchCalibrationResult struct now has a new property describing the status of the calibration (TobiiResearchCalibrationStatus).
Please see API reference guide for corresponding language for details of new functions and objects!

Bug fixes

  • Fixed issue with the Python language binding where you could not set the gaze output frequency to an integer.
  • Fixed issue on Matlab where arrays with invalid data returned NaN with wrong dimensions. Now returns correctly sized arrays of NaN.
  • Fixed rare issue where calling getDisplayArea could take very long time to complete.
  • Some (potentially) misleading log messages removed.

Version 1.0.4 (2017-04-26)

Bug fixes
  • Fixed issue where licenses could not be applied when subscribed to streams.
  • Fixed issue where eye trackers that changed IP address would not be rediscovered until SDK was reinitialized.
  • Fixed issue where you would get no gaze data from X3-120, Spectrum and IS4 trackers if the eye tracker was restarted during gaze streaming.
  • Error messages about failed time sync will no longer be written to log for disconnected trackers.
  • Non-responding eye trackers will no longer impact the discovery of (responding) eye trackers.
  • Fixed issue with ExternalSignal stream from TX300 (currently the only eye tracker supporting this functionality) eye trackers not being sparse.
Functionality changes

Previously the eye tracker returned a numerical value (0 or -1) when not being able to determine a true value. As this could create issues when analysing data we now return NaN (Not a Number) for these, supported by all languages.

Version 1.0

Since this is the first release of our new SDK, most new features and changes made compared to the previously released SDKs can be found in Changes from Tobii Pro Analytics SDK 3. However, when releasing new versions, you will be able to find the release notes describing the changes between each version on this page.