Tobii Ocumen - Changelog

A list of Tobii Ocumen bundle releases and what changed.

2024.1.0

This is a minor release of Tobii Ocumen including bug fixes, a new API call for blink validity and a new converter tool for .ocumen recordings.

Known issues

On Pico Neo 3 Pro Eye there is a known time drift issue for eye tracking data after headset has gone to sleep for long periods of time. A workaround for now is to not allow the headset to sleep or restart the headset after sleep.
IsBlinkDataValid currently indicates whether the blink signal is supported on the current device. It will not update during runtime, as the name might imply. The naming and/or behaviour of this signal may change in a future release.

Ocumen SDK (Minimum Recommended Unity Version - 2020.3.21f1)

Add support for latest Pico SDK and Pico OS 5.
Updated Tobii XR SDK version to 3.2.1.
Added IsBlinkDataValid flag in the Advanced API. IsBlinking will no longer internally handle data validity. This addresses a bug where IsBlinking could be true when blink data was invalid.

Ocumen Converter Tool (New Feature)

Converts .ocumen recordings from older versions (v2 or v4) to the latest version (v5).
Command line interface and integration into Ocumen Studio.

Other

Fixed various bugs related to the Ocumen samples, most notably issues with the Configuration sample using Pico Neo 3 Pro Eye.
Fixed camera offset in Recording Sample.
Fixed issues with the Unity Quick Start Project.
Removed ocumen_cli.exe because it is no longer used by Ocumen.
Add error handling for unsupported video encoding on Vulkan graphics API.

2023.1.0

This is a feature release for Tobii Ocumen.

Ocumen SDK (Minimum Recommended Unity Version - 2020.3.21f1)

Breaking API Changes:

The C# common Ocumen types namespace has been changed from Tobii.XR.Common to Tobii.Ocumen.Common.
The Tobii.Video namespace has been changed to Tobii.Ocumen.Video
C# types have been renamed from snake_case style to .NET standard naming convention.
Eye tracking data types have been moved into Tobii.Ocumen.Common
The Ocumen Recording Version has been updated. Please note that recordings from older versions will not be compatible with the new version.

Ocumen I/O

The fields for the left and right eyes in the PupilSizeAbsolute structure are now of the type PupilSizePerEye.
version_ocumen_data renamed to version_ocumen_io_api
version_low_level_stream renamed to version_ocumen_recording
Recording Version updated to 5.0.0

Ocumen Filters

Ocumen Filters has a new C# and Python API, read more about it here.
Signals & Filters Unity sample has been updated to use the new Ocumen Filters API.

Ocumen Studio (Recording Version 5.0.0)

Added scene visualization controls.
Improved rendering of meshes, colliders, and grid.
Addressed UI bugs.

2021-12-08

This is a feature release for Tobii Ocumen.

Ocumen SDK (Recommended Unity Version - 2019.4.5f1)

Ocumen Studio (Recording Version 4.0.0)

Added ability to record meshes.
Added alpha version of video recording.
Added VR controller pose and input recording.
Improved object visualization.

Ocumen I/O

Added Quick Start project allowing you to start doing meaningful science with just a few clicks.
Added Python API to work with .ocumen recordings.

Compatibility Notes

The Ocumen Studio Recording Version was updated to 4.0.0. Existing recordings must be opened with a previous version.
Ocumen Filter Pipelines have been deprecated and will be replaced with Ocumen Filter Libraries in an upcoming release.
Most customers should now receive a unified bundle containing all Ocumen components.
Binary examples are now shipped separately through our download sections.

2021-10-04

This is a feature release for Tobii Ocumen.

Ocumen SDK (Recommended Unity Version - 2019.4.5f1)

Add support for Pico Neo 3 Pro Eye.
Give developers ability to record .ocumen files.
Bundle Calibration Quality sample.
Bundle Ocumen Recording sample.

Ocumen Studio (Recording Version 2.0.0)

First public release of Tobii Ocumen Studio (Alpha) to replay .ocumen files
- from recorded files,
- from network streams,
- visualizing gaze,
- visualizing colliders.

Known Issues

Sphere colliders are properly recorded, but visualized as box colliders in Ocumen Studio.
Users of Pico Neo 3 Pro Eye will have to apply Pico’s soon-to-be-released OTA update for Ocumen to be fully supported

Compatibility Notes

To avoid further confusion, the Core package was renamed Common, as the XR Core SDK has been moved to a separate package. When upgrading to this version ensure adding the Common and XR Core SDK package, and remove any previous Core reference.

2021-05-24

Recommended Unity Version - 2019.4.5f1

This is a hotfix release for Tobii Ocumen.

Fixed off-by-one error in calibration indexing.
Added images missing in documentation.

2021-05-11

Recommended Unity Version - 2019.4.5f1

This is a feature and bugfix release for Tobii Ocumen.

Added support for HP Reverb G2 Omnicept Edition.
Fully transitioned code and samples to use Unity XR instead of legacy VR.
Moved XR SDK out from Ocumen Core into a separate package.
Removed the unsupported recorder library in Ocumen Core. We are planning a return of this library in a future version of Ocumen.
Removed individual package documentation, refer to top-level README.md in package.