Tobii.Research.EyeTrackingOperations Class Reference

Provides static methods for searching for eye trackers as well as connecting directly to a specific eye tracker.The eye tracker object(s) returned can then be used to manipulate the eye trackers and read eye tracker data.This is the entry point for the SDK users. More...

Static Public Member Functions
static void	Terminate ()
	Terminate SDK. Call this before exiting the process to release all SDK allocated resources.
static IEyeTracker	GetEyeTracker (Uri address)
	Gets an eye tracker object that has the specified address.
static IEyeTracker	GetEyeTracker (string address)
	Gets an eye tracker object that has the specified address.
static EyeTrackerCollection	FindAllEyeTrackers ()
	Finds eye trackers connected to the computer or the network. Please note that subsequent calls to FindAllEyeTrackers() may return the eye trackers in a different order.
static async Task< EyeTrackerCollection >	FindAllEyeTrackersAsync ()
	Asynchronously finds eye trackers connected to the computer or the network. Please note that subsequent calls to FindAllEyeTrackersAsync() may return the eye trackers in a different order.
static long	GetSystemTimeStamp ()
	Retrieves the time stamp from the system clock in microseconds.

Properties
static EventHandler< LogEventArgs >	LogReceived
	Event fired when a debug log is received.
static Version	SdkVersion [get]
	Gets the version of the SDK.

Detailed Description

Provides static methods for searching for eye trackers as well as connecting directly to a specific eye tracker.The eye tracker object(s) returned can then be used to manipulate the eye trackers and read eye tracker data.This is the entry point for the SDK users.

Examples

ScreenBasedCalibration_CalibrateDuringGazeRecording.cs.

Member Function Documentation

FindAllEyeTrackers()

static EyeTrackerCollection Tobii.Research.EyeTrackingOperations.FindAllEyeTrackers ( )

inlinestatic

Finds eye trackers connected to the computer or the network. Please note that subsequent calls to FindAllEyeTrackers() may return the eye trackers in a different order.

Returns

A read-only EyeTrackerCollection with found eye trackers.

Example of how to search for all available eye trackers and print their device names, models and serial numbers to the console:

Console.WriteLine("\nSearching for all eye trackers");
 
EyeTrackerCollection eyeTrackers = EyeTrackingOperations.FindAllEyeTrackers();
foreach (IEyeTracker eyeTracker in eyeTrackers)
{
    Console.WriteLine("{0}, {1}, {2}, {3}, {4}, {5}", eyeTracker.Address, eyeTracker.DeviceName, eyeTracker.Model, eyeTracker.SerialNumber, eyeTracker.FirmwareVersion, eyeTracker.RuntimeVersion);
}

Examples

ScreenBasedCalibration_CalibrateDuringGazeRecording.cs.

FindAllEyeTrackersAsync()

static async Task< EyeTrackerCollection > Tobii.Research.EyeTrackingOperations.FindAllEyeTrackersAsync ( )

inlinestatic

Asynchronously finds eye trackers connected to the computer or the network. Please note that subsequent calls to FindAllEyeTrackersAsync() may return the eye trackers in a different order.

Returns

An asynchronous operation that will provide a collection of eye trackers.

internal static async Task<EyeTrackerCollection> SearchAsync()
{
    Console.WriteLine("\nSearching for all eye trackers asynchronously.");
 
    // Search for eye trackers asynchronously.
    EyeTrackerCollection eyeTrackers = await EyeTrackingOperations.FindAllEyeTrackersAsync();
 
    // Execution resumes here when SearchAsync is complete.
    foreach (IEyeTracker eyeTracker in eyeTrackers)
    {
        Console.WriteLine("{0}, {1}, {2}, {3}, {4}, {5}", eyeTracker.Address, eyeTracker.DeviceName, eyeTracker.Model, eyeTracker.SerialNumber, eyeTracker.FirmwareVersion, eyeTracker.RuntimeVersion);
    }
 
    return eyeTrackers;
}

GetEyeTracker() [1/2]

static IEyeTracker Tobii.Research.EyeTrackingOperations.GetEyeTracker ( string  address )

inlinestatic

Gets an eye tracker object that has the specified address.

Parameters

address

The address to the eye tracker, represented as a string, to use for connecting to the eye tracker.

Exceptions

UriFormatException

If string passed is invalid.

Returns

An IEyeTracker Object if the connection to the eye tracker was successfully connected, otherwise null.

internal static IEyeTracker GetEyeTracker(string address)
{
    Console.WriteLine("\nGet eye tracker from address string: {0}.", address);
 
    var eyeTracker = EyeTrackingOperations.GetEyeTracker(address);
 
    Console.WriteLine("Got eye tracker");
    Console.WriteLine("Address: {0}", eyeTracker.Address);
    Console.WriteLine("Device name: {0}", eyeTracker.DeviceName);
    Console.WriteLine("Model: {0}", eyeTracker.Model);
    Console.WriteLine("Serial number: {0}", eyeTracker.SerialNumber);
    Console.WriteLine("Firmware version: {0}", eyeTracker.FirmwareVersion);
    Console.WriteLine("Runtime version: {0}", eyeTracker.RuntimeVersion);
 
    return eyeTracker;
}

GetEyeTracker() [2/2]

static IEyeTracker Tobii.Research.EyeTrackingOperations.GetEyeTracker ( Uri  address )

inlinestatic

Gets an eye tracker object that has the specified address.

Parameters

address

The address to the eye tracker, represented as a Uri, to use for connecting to the eye tracker.

Returns

An IEyeTracker Object if the connection to the eye tracker was successfully connected, otherwise null.

internal static IEyeTracker GetEyeTracker(Uri address)
{
    Console.WriteLine("\nGet eye tracker from Uri: {0}.", address);
 
    var eyeTracker = EyeTrackingOperations.GetEyeTracker(address);
 
    Console.WriteLine("Got eye tracker");
    Console.WriteLine("Address: {0}", eyeTracker.Address);
    Console.WriteLine("Device name: {0}", eyeTracker.DeviceName);
    Console.WriteLine("Model: {0}", eyeTracker.Model);
    Console.WriteLine("Serial number: {0}", eyeTracker.SerialNumber);
    Console.WriteLine("Firmware version: {0}", eyeTracker.FirmwareVersion);
    Console.WriteLine("Runtime version: {0}", eyeTracker.RuntimeVersion);
 
    return eyeTracker;
}

Examples

ScreenBasedCalibration_CalibrateDuringGazeRecording.cs.

GetSystemTimeStamp()

static long Tobii.Research.EyeTrackingOperations.GetSystemTimeStamp ( )

inlinestatic

Retrieves the time stamp from the system clock in microseconds.

Returns

The time stamp from the system clock in microseconds.

Console.WriteLine("\nGet system time stamp.");
 
var systemTimeStamp = EyeTrackingOperations.GetSystemTimeStamp();
Console.WriteLine("System time stamp is: {0}.", systemTimeStamp);

Property Documentation

LogReceived

EventHandler<LogEventArgs> Tobii.Research.EyeTrackingOperations.LogReceived

staticaddremove

Event fired when a debug log is received.

internal static void ReceiveLogs()
{
    Console.WriteLine("\nReceive logs");
 
    // Subscribe to debug logs.
    EyeTrackingOperations.LogReceived += LogReceived;
 
    // Provoke some logs.
    EyeTrackingOperations.FindAllEyeTrackers();
 
    // Unsubscribe from debug logs.
    EyeTrackingOperations.LogReceived -= LogReceived;
}
 
private static void LogReceived(object sender, LogEventArgs e)
{
    Console.WriteLine("\nSource: {0}\nLevel: {1}\nMessage: \"{2}\" Time Stamp: \"{3}\"", e.Source, e.Level, e.Message, e.SystemTimeStamp);
}