Ocumen I/O - Overview
Tobii Ocumen I/O (Input/Output) is the system used for recording or streaming live data in Ocumen.
Ocumen I/O enables you to easily record or stream gaze data and many other types of data that are relevant to the analysis phase of your project. Ocumen I/O is designed to be easy to use, with drag-and-drop recording scripts for Unity. The Ocumen I/O API also provides a way to read or write to recordings in C# or Python.
Table of Contents
Recording
Ocumen I/O includes drag-and-drop scripts that can be added to your Unity project to make a recording. The data is written to a ‘.ocumen’ file, a highly optimized self-contained format which contains multiple tracks of analytical data and metadata about the system.
Replay
Streaming from device
Ocumen I/O can be used to live stream data from a VR application to a remote computer. This is done over a WiFi network, using the IP address of the remote computer as the destination. Streamed data can be received and visualized in a custom app or in Ocumen Studio. With the help of Ocumen Filters, the streamed data can also be filtered in near real-time, for example to rapidly detect eye movement patterns.
Reading from file
Ocumen recordings can be opened in Ocumen Studio, filtered using Ocumen Filters, or read from C# or Python for data analysis. Exporting Recording Data to CSV or JSON is also possible.
Recorded Data Types
Ocumen I/O includes recording scripts that can be added to your Unity project to record multiple types of data:
- Advanced eye tracking data
- Headset pose
- Video of what the user sees
- Controller input
- 3D mesh data
- 3D collider data
- Frame data
To read more about these, see the Unity Recorders page.
In addition, custom data types can be recorded or streamed by writing a custom Unity script with only a few lines of code. The following are some examples of custom data you could add to an ocumen recording or stream:
- Important events in the app or game.
- User interaction states, such as searching for item, holding item, etc.
- Biometric data from other sensors, such as heart rate, skin conductance, etc.
- Any other data you want to record or stream.
Get Started
To get started using the Ocumen I/O, see the following resources:
- Create a recording in VR in the Recording Sample app.
- Record or stream from the Unity/C# Quick Start Project.
- Follow the Unity/C# Getting Started guide to add recording or streaming functionality to your project.
- Follow the Python Getting Started guide to read data from an Ocumen recording.