Measurements and Insights Module

This section outlines how to integrate the IR SDK module into your Unity project, enabling you to collect and analyze user data from your immersive experiences.

Prerequisites

• IR SDK for Unity is installed into your Unity project.

• Experience is created on the IR platform.

• IR SDK is authenticated.

• Experience is chosen there.

Step-by-Step Integration

1. Add IR SDK Controller.

• Add empty gameObject into the scene. You can call it "IR_SDK_Controller".

• Add Componet "iR SDK Controller"

• Set Master Update Interval

Master Update Interval

The Measurements and Insights module allows you to configure how frequently the tracker sends a heartbeat signal, which provides real-time updates on user activity and engagement within your experience.

Heartbeat Interval Configuration

• You can set the tracker heartbeat interval to any value that suits your performance needs.

• The interval determines how often data is sent from the tracker to the IR Enterprise platform.

• A shorter interval provides more frequent updates but may impact performance.

One important note: the IR SDK is designed to optimize performance when collecting and transmitting data. Network communication occurs at every “Master Update Interval”, but this does not mean that data is only collected at the moment of the request. Each module has additional parameters that define the frequency at which data is gathered and added as a batch to the network request. You can find more details and examples of these parameters in Step 2.

Recommended Settings

For optimal performance and a balance between data accuracy and system efficiency, we recommend setting the heartbeat interval to 5000–7000 milliseconds.

2. Add iR MnI Controller & Assign Track

Add iR MnI Controller component to the IR SDK Controller object which you created and set in the 1st step.

It has 2 settings which requires you to configure:

1. Tracker.

The Tracker represents your main player. To configure it:

1. Locate your main player and assign the MnI Tracker Component to it.

2. Ensure your player has a collider for triggering events.

iR MNI Tracker Component The IR MnI Tracker component includes fields for UserID and Display Name, which you can assign dynamically during runtime.

• UserID: Allows you to use your custom user identifiers instead of relying on the default UserID generated by the IR SDK (based on the user’s browser session).

• Display Name: Lets you assign a user-friendly name for better tracking and identification within your experience.

1. Assign Tracker object to the iR MnI Controller "Tracker field"

The MnI system determines whether the player is within the trackable area by detecting interactions between the player’s collider (Tracker) and the Trackable area’s collider. Proper collider setup is essential for accurate tracking.

2. Update Interval.

This parameter defines the frequency of data collection during runtime before it is sent to the server. For example, you can configure the system to collect data about the user’s location in the 3D experience every second or every 5 seconds. Once the Master Update Interval is reached, the collected data is sent to the server in bulk.

By adjusting the Update Interval and Master Update Interval parameters, you can fine-tune the balance between data accuracy and the performance of your 3D experience. Shorter intervals increase accuracy but may impact performance, while longer intervals improve performance but may reduce data granularity.

We recommend having ~1 second for Update Interval.

3. Setup trackable area in your scene

To establish a trackable area:

1. Create an object in your scene equipped with a collider set as a trigger. We recommend using a 3D cube for this purpose. You can disable the Mesh Renderer component to make this area invisible to the player.

2. Position the object in the desired location for tracking and resize it as per your requirements.

3. Attach the 'iR MNI Region' script from our SDK to this object.

4. Creating a Map of Your Experience

Once the trackable area is established, proceed to create an experience map utilizing our SDK's functionalities. The map generated will be based on the trackable area you defined in the previous step.

1. Navigate to "LV" in the Unity menu bar.

2. Choose "Preview Map." Please note! if this section is not available, you need to authenticate and select experience first. After that, you'll see the window that is shown on the "upload map" picture.

3. Select the region from the "Select Region" menu.

4. Click on "Preview" to ensure accuracy.

5. If the preview is satisfactory, click "Upload."

This process will generate an experience map based on your defined trackable area.

Once the integration is complete and your experience is built, you can start inspecting the initial results. Refer to this article to learn about the types of data and reports available from the Measurements and Analytics module. This will help you understand user behavior, engagement metrics, and overall performance insights for your experience.

Known limitations

1. Note on Supported Systems: As of the current version, the MnI SDK supports WebGL and Windows systems. Support for iOS, Android, and MacOS is in development and will be available soon.

2. Currently, MnI does not support tracking data in multiple scenes, but this feature will be available soon!