Tobii.Research Namespace Reference

Namespaces

Classes
class	AlreadyInCalibrationModeException
	Is thrown when the eye tracker is already in calibration mode. More...
class	CalibrationChangedEventArgs
	Provides data for the CalibrationModeEntered event. More...
class	CalibrationData
	Stores calibration data. More...
class	CalibrationEyeData
	Represents calibration eye data. More...
class	CalibrationModeEnteredEventArgs
	Provides data for the CalibrationModeEntered event. More...
class	CalibrationModeLeftEventArgs
	Provides data for the CalibrationModeLeft event. More...
class	CalibrationPoint
	Represents the calibration point and its collected calibration samples. More...
class	CalibrationPointCollection
	Represents a read-only collection of CalibrationPoint objects. More...
class	CalibrationResult
	Represents the result of the calculated calibration. More...
class	CalibrationSample
	Represents the data collected for a calibration sample. More...
class	CalibrationSampleCollection
	Represents a read-only collection of CalibrationSample objects. More...
class	ConnectionFailedException
	Is thrown when connection to an eye tracker is lost or could not be established. More...
class	ConnectionLostEventArgs
	Provides data for the ConnectionLost event. More...
class	ConnectionRestoredEventArgs
	Provides data for the ConnectionRestored event. More...
class	DisplayArea
	Represents the three coordinates in space corresponding to the top left, bottom left, and top right corners of the active display area. More...
class	DisplayAreaEventArgs
	Provides data for the DisplayAreaChanged event. More...
class	DisplayAreaNotValidException
	Is thrown if trying to enter calibration mode with an invalid display area. More...
class	EventErrorEventArgs
	Provides data for the EventErrorOccurred event. More...
class	ExternalSignalValueEventArgs
	Provides data for the ExternalSignalReceived event. More...
class	EyeData
	Provides properties for the eye data. More...
class	EyeImageEventArgs
	Provides data for the EyeImageReceived event. More...
class	EyeImageRawEventArgs
	Provides data for the EyeImageRawReceived event. More...
class	EyeTrackerCollection
	Represents a read-only collection of IEyeTracker objects. More...
class	EyeTrackerUnavailableException
	Is thrown if the particular eye tracker is unavailable. Other eye trackers may be available. More...
class	EyeTrackingModeChangedEventArgs
	Provides data for the EyeTrackingModeChangedEventArgs event. More...
class	EyeTrackingModeCollection
	Represents a read-only collection of eye tracking modes. More...
class	EyeTrackingOperations
	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...
class	FailedLicense
	Represents a failed license. More...
class	FailedLicenseCollection
	Represents a read-only collection of FailedLicense objects. More...
class	FeatureNotSupportedException
	Is thrown when the eye tracker does not support the operation or if there is an insufficient license level when using a restricted feature. If there is a license problem The solution is to contact Tobii customer support and request a suitable license file. More...
class	FirmwarePackageCompatibility
	Firmware package compatibility. More...
class	FirmwareUpgradeNotSupportedException
	Is thrown when firmware upgrade is not supported by the eye tracker. More...
class	GazeDataEventArgs
	Provides data for the GazeDataReceived event. More...
class	GazeOrigin
	Provides properties for the gaze origin. More...
class	GazeOutputFrequencyCollection
	Represents a read-only collection of gaze output frequencies. More...
class	GazeOutputFrequencyEventArgs
	Provides data for the GazeOutputFrequencyChanged event. More...
class	GazePoint
	Provides properties for the gaze point. More...
class	HMDBasedCalibration
	Provides methods and properties for managing calibrations for HMD based eye trackers. More...
class	HMDCalibrationResult
	Represents the result of the calculated HMD calibration. More...
class	HMDEyeData
	Provides properties for the eye data when gotten from an HMD based device. More...
class	HMDGazeDataEventArgs
	Provides data for the HMDGazeDataReceived event. More...
class	HMDGazeDirection
	Provides properties for the HMD gaze direction. More...
class	HMDGazeOrigin
	Provides properties for the HMD gaze origin. More...
class	HMDLensConfiguration
	Provides properties for the lens configuration for a HMD device. More...
class	HMDPupilPosition
	Provides properties for the HMD pupil position. More...
interface	IEyeTracker
	Provides methods and properties to manage and get data from an eye tracker. More...
class	IncompatibleFirmwarePackageException
	Is thrown when the eye tracker device does not match the firmware. More...
class	InsufficientLicenseException
	Is thrown when there is an insufficient license level when using a restricted feature. The solution is to contact Tobii customer support and request a suitable license file. More...
class	InternalErrorException
	Is thrown on internal errors in the API. More...
class	LicenseCollection
	Represents a collection of LicenseKey objects. More...
class	LicenseKey
	Represents the eye tracker license key More...
class	LogEventArgs
	Provides data for the LogReceived event. More...
class	NormalizedPoint2D
	Represents a normalized x- and y-coordinate point in a two-dimensional plane. More...
class	NormalizedPoint3D
	Represents a normalized x-, y- and z-coordinate point in a three-dimensional space. More...
class	NotInCalibrationModeException
	Is thrown when the eye tracker is supposed to be in calibration mode but is not. More...
class	Point3D
	Represents an x-, y- and z-coordinate point in a three-dimensional space. More...
class	PupilData
	Provides properties for the pupil data. More...
class	SavedLicenseFailedToApplyException
	Is thrown when the license saved on the device failed to apply. More...
class	ScreenBasedCalibration
	Provides methods and properties for managing calibrations for screen based eye trackers. More...
class	ScreenBasedMonocularCalibration
	Provides methods and properties for managing monocular and bi-monocular calibrations for screen based eye trackers. This type of calibration is not supported by all eye trackers. Check the DeviceCapabilities of the eye tracker first! More...
class	TimeSynchronizationReferenceEventArgs
	Provides data for the TimeSynchronizationReferenceReceived event. More...
class	TrackBox
	Represents the eight corners in user coordinate system that together forms the track box. More...
class	TrackBoxEventArgs
	Provides data for the TrackBoxChanged event. More...
class	UnknownFirmwareVersionException
	Is thrown when the firmware version is unknown. More...

Enumerations
enum	CalibrationEyeValidity { CalibrationEyeValidity.InvalidAndNotUsed = -1, CalibrationEyeValidity.ValidButNotUsed = 0, CalibrationEyeValidity.ValidAndUsed = 1 }
	Defines the validity of calibration eye sample. More...
enum	CalibrationStatus { CalibrationStatus.Failure = 0, CalibrationStatus.Success = 1, CalibrationStatus.SuccessLeftEye = 2, CalibrationStatus.SuccessRightEye = 3 }
	Defines the overall status of a calibration process More...
enum	Capabilities {   Capabilities.None = 0, Capabilities.CanSetDisplayArea = 1 << 0, Capabilities.HasExternalSignal = 1 << 1, Capabilities.HasEyeImages = 1 << 2,   Capabilities.HasGazeData = 1 << 3, Capabilities.HasHMDGazeData = 1 << 4, Capabilities.CanDoScreenBasedCalibration = 1 << 5, Capabilities.CanDoHMDBasedCalibration = 1 << 6,   Capabilities.HasHMDLensConfig = 1 << 7, Capabilities.CanDoMonocularCalibration = 1 << 8 }
	Defines the capabilities. More...
enum	EventErrorSource {   EventErrorSource.User, EventErrorSource.EventPump, EventErrorSource.SubscriptionGazeData, EventErrorSource.SubscriptionExternalSignal,   EventErrorSource.SubscriptionTimeSynchronizationData, EventErrorSource.SubscriptionEyeImage, EventErrorSource.SubscriptionNotification }
	Define error sources More...
enum	EventErrorType {   EventErrorType.ConnectionLost, EventErrorType.InsufficientLicense, EventErrorType.NotSupported, EventErrorType.TooManySubscribers,   EventErrorType.InternalError, EventErrorType.UserError }
	Define error types More...
enum	ExternalSignalChangeType { ExternalSignalChangeType.ValueChanged, ExternalSignalChangeType.InitialValue, ExternalSignalChangeType.ConnectionRestored }
	Defines the type of external signal. More...
enum	EyeImageType { EyeImageType.Full, EyeImageType.Cropped, EyeImageType.Unknown }
	Defines the type of eye image. More...
enum	LicenseLevel {   LicenseLevel.Blocked, LicenseLevel.Consumer, LicenseLevel.Config, LicenseLevel.Professional,   LicenseLevel.Internal, LicenseLevel.Unknown }
	Defines the current license level of an eye tracker. More...
enum	LicenseValidationResult {   LicenseValidationResult.Ok, LicenseValidationResult.Tampered, LicenseValidationResult.InvalidApplicationSignature, LicenseValidationResult.NonSignedApplication,   LicenseValidationResult.Expired, LicenseValidationResult.Premature, LicenseValidationResult.InvalidProcessName, LicenseValidationResult.InvalidSerialNumber,   LicenseValidationResult.InvalidModel }
	Specifies license validation result. More...
enum	LogLevel {   LogLevel.Error, LogLevel.Warning, LogLevel.Information, LogLevel.Debug,   LogLevel.Trace }
	Define log levels More...
enum	LogSource { LogSource.StreamEngine, LogSource.SDK }
	Define the source of the debug logs. More...
enum	SelectedEye { SelectedEye.LeftEye, SelectedEye.RightEye, SelectedEye.BothEyes }
	Defines the selected eye. More...
enum	Validity { Validity.Invalid = 0, Validity.Valid = 1 }
	Specifies the validity. More...
enum	VersionComparison { VersionComparison.Upgrade, VersionComparison.Downgrade, VersionComparison.Same, VersionComparison.Invalid }
	Defines a version comparison result for firmware packages. More...

Enumeration Type Documentation

enum Tobii.Research.CalibrationEyeValidity

strong

Defines the validity of calibration eye sample.

Enumerator
InvalidAndNotUsed	The eye tracking failed or the calibration eye data is invalid.
ValidButNotUsed	Eye Tracking was successful, but the calibration eye data was not used in calibration e.g. gaze was to far away.
ValidAndUsed	The calibration eye data was valid and used in calibration.

enum Tobii.Research.CalibrationStatus

strong

Defines the overall status of a calibration process

Enumerator
Failure	Indicates that the calibration process failed.
Success	Indicates that the calibration process succeeded for both eyes.
SuccessLeftEye	Indicates that the calibration process succeeded for the left eye.
SuccessRightEye	Indicates that the calibration process succeeded for the right eye.

enum Tobii.Research.Capabilities

strong

Defines the capabilities.

Enumerator
None	No capabilities set.
CanSetDisplayArea	Indicates that the device can have the display area set.
HasExternalSignal	Indicates that the device can deliver an external signal stream.
HasEyeImages	Indicates that the device can deliver an eye image stream.
HasGazeData	Indicates that the device can deliver a gaze data stream. Standard for all screen based eye trackers.
HasHMDGazeData	Indicates that the device can deliver a HMD gaze data stream.
CanDoScreenBasedCalibration	Indicates that screen based calibration can be performed on the device.
CanDoHMDBasedCalibration	Indicates that HMD based calibration can be performed on the device.
HasHMDLensConfig	Indicates that it's possible to get and set the HMD lens configuration on the device.
CanDoMonocularCalibration	Indicates that monocular calibration can be performed on the device.

enum Tobii.Research.EventErrorSource

strong

Define error sources

Enumerator
User	User callback failed.
EventPump	Error when pumping event.
SubscriptionGazeData	Error when subscribing to event for gaze data.
SubscriptionExternalSignal	Error when subscribing to event for external signal.
SubscriptionTimeSynchronizationData	Error when subscribing to event for time synchronization data.
SubscriptionEyeImage	Error when subscribing to event for eye images.
SubscriptionNotification	Error when subscribing to notification event.

enum Tobii.Research.EventErrorType

strong

Define error types

Enumerator
ConnectionLost	The connection to the eye tracker was lost.
InsufficientLicense	The license is insufficient for subscribing to the event.
NotSupported	The event isn't supported by the eye tracker.
TooManySubscribers	Too many users subscribed to a stream.
InternalError	An internal error occurred.
UserError	The user threw an exception in the callback.

enum Tobii.Research.ExternalSignalChangeType

strong

Defines the type of external signal.

Enumerator
ValueChanged	Indicates that the value sent to the eye tracker has changed.
InitialValue	Indicates that the value is the initial value, and is received when starting a subscription.
ConnectionRestored	Indicates that there has been a connection lost and now it is restored and the value is the current value.

enum Tobii.Research.EyeImageType

strong

Defines the type of eye image.

Enumerator
Full	Indicates that the eye tracker could not identify the eyes, and the image is the full image.
Cropped	Indicates that the image is cropped and shows the eyes.
Unknown	Indicates an unknown image type.

enum Tobii.Research.LicenseLevel

strong

Defines the current license level of an eye tracker.

Enumerator
Blocked	The eye tracker is blocked.
Consumer	Consumer license level.
Config	Config license level.
Professional	Professional license level.
Internal	Internal license level.
Unknown	Unknown license level.

enum Tobii.Research.LicenseValidationResult

strong

Specifies license validation result.

Enumerator
Ok	The license is ok.
Tampered	The license is tampered.
InvalidApplicationSignature	The application signature is invalid.
NonSignedApplication	The application has not been signed.
Expired	The license has expired.
Premature	The license is premature,
InvalidProcessName	The process name is invalid.
InvalidSerialNumber	The serial number is invalid.
InvalidModel	The model is invalid.

enum Tobii.Research.LogLevel

strong

Define log levels

Enumerator
Error	Log level error.
Warning	Log level warning.
Information	Log level information.
Debug	Log level debug.
Trace	Log level trace.

enum Tobii.Research.LogSource

strong

Define the source of the debug logs.

Enumerator
StreamEngine	The source of the log is the stream engine.
SDK	The source of the log is the SDK.

enum Tobii.Research.SelectedEye

strong

Defines the selected eye.

Enumerator
LeftEye	Left eye selected
RightEye	Right eye selected.
BothEyes	Both eyes selected.

enum Tobii.Research.Validity

strong

Specifies the validity.

Enumerator
Invalid	Indicates valid.
Valid	Indicates invalid.

enum Tobii.Research.VersionComparison

strong

Defines a version comparison result for firmware packages.

Enumerator
Upgrade	The firmware package version is higher than the eye tracker firmware version.
Downgrade	The firmware package version is lower than the eye tracker firmware version.
Same	The firmware package and the eye tracker firmware have the same version.
Invalid	Version compare isn't valid between the firmware package and the eye tracker firmware.