Tobii Ocumen FAQ

Tobii Ocumen - Frequently Asked Questions.

If you can’t find an answer here, you can contact us via our contact form.

Table of Contents


Questions about Tobii Ocumen in general.

Where can I get Tobii Ocumen?

Tobii Ocumen is offered on top of our Tobii XR SDK and available separately. Please contact us via our contact form.

What hardware is Tobii Ocumen compatible with?

HMD Compatible Notes
HP Reverb G2 Omnicept Yes
Pico Neo 3 Pro Eye Yes
Pico Neo 2 Eye Yes* *Calibration quality API not supported.
HTC Vive Pro Eye No API access provided exclusively by HTC.
Tobii HTC VIVE Devkit No

What eye tracking capabilities does Tobii Ocumen give access to?

To read about what capabilities are included in Tobii Ocumen, check out our Tobii Ocumen solutions page or the Tobii Ocumen Studio solutions page.

What is the current readiness of Tobii Ocumen?

Tobii Ocumen consists of several components which differ in their state of readiness:

Component 2021-10-04 Release 2021-12-08 Release
Tobii Ocumen Advanced Signals Release Candidate Release Candidate
Tobii Ocumen I/O Alpha Alpha
Tobii Ocumen Configuration Alpha Alpha
Tobii Ocumen Filters Preview Removed
Tobii Ocumen Studio Alpha Alpha

Tobii Ocumen Filters has been removed in the 2021-12-08 release with the intention of replacing it with an improved system in a future release.

The respective readiness levels mean:

  • Released - The components have been tested by multiple customers, and after prolonged use no issues were reported. We will not change APIs or their behavior unless external reasons (e.g., updates to Unity or a new eye tracker generation) dictate so. Newer versions containing bug fixes and improvements will be provided, and should require minimal churn.
  • Release Candidate - The APIs have received extensive testing and are used by multiple customers. We do not expect the given APIs to change, unless bugs are encountered during the testing period.
  • Beta - Based on internal usage we are satisfied with the API behavior and have no immediate plans to change their surface or behavior. However, we are rather early in that process and would expect isolated issues to arise.
  • Alpha - These components see heavy development and design changes. We offer them because we are convinced they provide value to some customers, but only recommend their use in early or experimental development phases.
  • Preview - These components do not work yet, but can be tried to a limited degree.
  • Deprecated - These components are no longer supported and will be removed.
  • Removed - These components have been removed.

How can I get feature X?

If something is missing we would be more than happy to hear about it, please use our contact form.

How do I upgrade from an older Ocumen version in Unity?

To upgrade from an older Ocumen version, remove all existing Tobii Ocumen and Tobii XR SDK packages from the project and add the packages from the new version.

Ocumen I/O

Questions related to Ocumen I/O.

What languages are supported?

Language and operating system support is generally driven by demand, and additional languages can sometimes be made available upon request. Right now we support:

  • Unity C# (Windows / Android) for recording.
  • Python 3.8+ (Windows) for data import and export.

Why does my Python script crash / behave erratic?

You probably invoked undefined behavior. All Ocumen I/O bindings, including Python and C#, share the same high-performance library. While this makes moving your script to production easy, it also means you have to pay special attention not to invoke the APIs in forbidden ways. We highly recommend you to revisit the bundled, which gives an introduction into the underlying issues. In short, make sure you

  • never hold on to slices across Ocumen I/O calls,
  • never use 0 for user IDs,
  • never pass None unless the API explicitly allows it.


Questions related to the SDK.

Why can’t I choose a provider when I have enabled the Advanced API?

When selecting Advanced API our SDK talks to our eye trackers directly via an API we call Stream Engine, which already gives you raw, unfiltered access to all available eye tracking signals.