Skip to Content
This documentation is provided with the HEAT environment and describes this HEAT instance.

Tobii module

The Tobii module reads gaze, pupillometry and head pose from a screen-based Tobii eye tracker through Tobii’s own Stream Engine SDK, and optionally captures the tracker’s infrared camera feed as H264 video. It is built for a screen-mounted tracker (a Tobii bar below or above a monitor), not a headset-integrated one.

What you need

  • A Tobii eye tracker supported by the Stream Engine SDK, connected before the capture session starts.
  • A Tobii license file for that device. There is no bundled default; without one, the module fails to connect - see Troubleshooting.
  • The physical width and height of the screen the tracker is mounted to, in millimetres, and where the tracker sits relative to screen center - see Configure.

Process capability

This module declares the process.unrestricted capability, the same opt-out from HEAT Capture’s default per-module process restriction that the HTC Vive gaze module declares, for the same reason: the vendor SDK’s background service does not tolerate the restricted token HEAT Capture normally launches modules with. It still runs out-of-process, signed and job-contained like every other module - see Install a capture module.

Interface Control Document

See Interface control document for Stream Engine discovery and subscriptions, gaze and head-pose fields, camera-stream ownership, device configuration and failure behavior.

Pages

  • Configure: license, screen geometry, and video capture - including a calibration limitation worth knowing before relying on gaze accuracy.
  • Data produced: what is published, and a real gap compared to other eye trackers in this catalogue.
  • Troubleshooting: symptoms, causes and fixes.
Opens your browser's print dialog. Choose "Save as PDF" as the destination.