With this SDK you will be able to easily find and get data from your Tobii eye tracker. If you are new to eye tracking we recommend that you spend some time exploring the content in Tobii Pro's Learn & Support section of the Tobii Pro website . There you will find a lot of information about how eye tracking works in general and how to design studies.
In the Common concepts section of this website, you will find information about concepts which are common for all supported languages, such as the different coordinate systems used, and how time stamps are defined.
The Tobii Pro SDK for Unity is an adaptation of the .NET binding that is compatible with Unity's version of C# (.NET 3.5 / Mono). Hence you can use the same syntax when using the Unity binding as you would when using the .NET binding (with some exceptions). However, since there are some important differences between the two bindings (regarding usage and supported methods), the Unity binding has it's own documentation pages.
The Tobii Pro SDK for Unity is delivered as a Unity package. However, in accordance with the other language bindings it is just an API for accessing the data of the eye tracker. In this case the API is in C# and consists of a set of precompiled .dlls (two native, and one managed). This means that you need to do some work yourself to make it work, such as creating your own MonoBehaviour scripts to attach to your Unity objects. Please see below for more instructions.
Visit our download site for Tobii Pro SDK , and download the latest version of the Tobii Pro SDK Unity Binding.
using Tobii.Research;to your code, or try out the examples in the Examples folder.
Most eye tracking applications follow the same pattern in terms of in which order functionality is used. The order is usually as follows:
Here's how to do this with the Pro SDK in Unity:
Start with the
EyeTrackingOperations, a static class residing in
Use either the
FindAllEyeTrackers function to get a list of available eye trackers or the
GetEyeTracker function that only returns one eye tracker specified by the eye tracker URI.
This could be done in one of Unity's "initialization" event functions, such as
Start (convenient if you only have one eye tracker),
or on demand (if you want the user to be able to chose eye tracker).
The objects returned from the functions
GetEyeTracker are instances of the class
Through those objects you can interact with the eye trackers.
To calibrate the eye tracker, use either a
ScreenBasedCalibration or a
HMDBasedCalibration object (depending on the type of eye tracker).
ScreenBasedCalibration / HMDBasedCalibration class requires an
IEyeTracker object in the constructor.
More information about how a calibration works can be found in the section Calibration.
When you have the
IEyeTracker object and want to subscribe to gaze data, subscribe to either the
GazeDataReceived or the
HMDGazeDataReceived event (depending on the type of eye tracker).
The data will be available as
Note: The events in the SDK are called on a thread internal to the SDK. That thread can not safely set values that are to be read on Unity's main thread. The simplest way to make it safe is to enqueue the data, and dequeue it on the main thread, e.g. via
Update() in a MonoBehaviour.
This pattern is used in the examples included in the unitypackage.
In Unity it is important to unsubscribe from any Pro SDK data that you have unsubscribed to, otherwise Tobii Pro SDK will not be able to terminate properly, and you risk that your application/game will hang on exit.
Unsubscribe to the Tobii Pro SDK events together with your other clean up code, for example in one of Unity's terminating event functions,
To be on the safe side, you can also call the
Terminate() method on
EyeTrackingOperations to ensure that all Tobii Pro SDK resources gets cleaned.
Only do this when closing down application or object (i.e. in
OnDestroy() or similar).
The Eye Tracker Manager (ETM) is an independent tool that can be handy to use when developing eye tracking applications. With the ETM you can browse and change settings, as well as perform calibrations, on all screen based eye trackers* compatible with the Pro SDK as well as update the firmware on some eye tracker models. The ETM can also be used to troubleshoot your own application for connection errors since if the ETM can find and interact with an eye tracker, then the SDK should be able to do the same. The ETM can be downloaded from here .
* Note: HMD eye trackers are currently not supported by Eye Tracker Manager.