Tobii Ocumen - FAQ
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?
|HP Reverb G2 Omnicept||Yes||Yes||Yes|
|Pico Neo 3 Pro Eye||Yes||Yes||Yes|
|Pico Neo 2 Eye||Yes*||Yes*||No†|
*Calibration quality API not supported.
†Support for the Pico Neo 2 Eye was phased out in the 2023.1.0 release since Pico no longer officially supports the headset. The headset may still work with Ocumen, but we will not provide any support for it.
How do I get started with Tobii Ocumen?
You can find a general getting started video for Tobii Ocumen in our solutions page.
More detailed getting started guides for each individual component can be found in the develop section.
What is the current readiness of Tobii Ocumen?
Tobii Ocumen consists of several components which differ in their state of readiness:
|Tobii Ocumen Advanced Signals||Stable||Stable||Stable|
|Tobii Ocumen I/O||Stable||Stable||Stable|
|Tobii Ocumen Configuration||Stable||Stable||Stable|
|Tobii Ocumen Filters||Alpha||Removed*||Stable|
|Tobii Ocumen Studio||Alpha||Beta||Beta|
The respective readiness levels mean:
- Stable - The component is complete and has received extensive testing. Newer versions containing bug fixes and improvements will be provided.
- Beta - The component is usable but still undergoing changes, and it has not been extensively tested.
- Alpha - The component is undergoing heavy development and design changes. We only recommend its use in early or experimental development phases.
- Removed - The component has been removed.
*Tobii Ocumen Filters was removed in the 2021-12-08 release for technical reasons, and an improved replacement was added in the 2023.1.0 release.
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. After the upgrade, certain code implementations might be needed depending if new version contains breaking changes. Refer to the Ocumen changelog for more info.
Will my older Ocumen projects work with the new Version?
Whether older projects will work directly with the new version of Ocumen depends on the extent of changes made in an update. If significant modifications have been made, some adjustments to your old projects will be necessary. To ascertain the exact changes needed, you should refer to the Ocumen changelog or documentation provided with the new version.
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.
I cannot open my recording in Ocumen Studio/Ocumen I/O after upgrade, what can I do?
The inability to open a recording in Ocumen after an upgrade may not necessarily be an error. This could be due to significant modifications made to the Ocumen recording format.
When creating or playing a recording, Ocumen uses the I/O API with a specific recording format. You can obtain a recording format version using the I/O API, alternatively, you can try to open the recording in Ocumen Studio and if the recording is incompatible, you will see the recording format version in the Error message. Please refer to the Ocumen changelog to see compatible versions.
If necessary, you can use an older version of Ocumen to work with older recordings.
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 and data import and export.
- Python 3.8+ (Windows) for data import and export.
Why does my Python script crash / behave erraticly?
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
tutorial_09_call_safety.py, 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
0for user IDs,
- never pass
Noneunless the API explicitly allows it.