• Minimal Meta XR All-in-One version: 60.0

• Minimal Unity version: 2021.3.26f1

• Minimal HISPlayer SDK version: 3.3.0

• Minor version - Android 10.0 ‘Quince Tart’
• Minimum SDK: 29

• Linear

• IL2CPP - ARM64

Note: If you plan to use Meta XR SDK v74 or newer, we recommend working with Unity 2022.3 LTS or Unity 6+.
Older Unity versions may still work but are limited to the Oculus XR Plugin and won’t support new Meta XR features.

Integrate HISPlayer SDK with the Meta XR All-in-One SDK or Meta XR Core SDK only for smaller package size.

First, please configure the Unity project for Oculus by following this Tutorial and open Window > Package Manager > Packages: In Project to check Meta XR All-in-One SDK is installed properly.

In older versions of the Meta XR SDK, this step automatically installed Oculus XR Plugin. However, starting with Meta XR SDK v74 and later, the choice of plugin is up to you. Meta’s support has shifted to focus on OpenXR Plugin, but is recommended to use Oculus XR Plugin for best compatibility.

To install these plugin, open Package Manage > Install Package by Name, type com.unity.xr.oculus and select install.

Go to Project Settings → XR Plug-in Management and make sure that the provider Oculus is checked.

If you have not imported HISPlayer SDK yet, please follow the Quickstart Guide.

Please, download the sample here: HISPlayer MetaXR Sample (no need to download it if you have received it in the email).

This updated sample includes multiple scenes designed for different video types:

• 360° Scene: for immersive 360-degree video playback.
• 180° Stereoscopic Scene: for 3D/VR180 stereoscopic video playback.
• Standard Video Scene: for regular flat video playback.

It is recommended to use OpenGL for best compatibility. If you need to use Vulkan for playing high-resolution video on Meta Quest devices, please contact HISPlayer team.

Before using the sample, make sure you have completed all the required setup steps described above — including importing all necessary packages and dependencies for Oculus and the HISPlayer SDK.

Follow these steps to configure and run the sample properly:

1. Enable the New Input System

Unity versions starting with 6000 use the Input System Package (New) by default. To verify this, go to: Edit > Project Settings > Player > Other Settings > Active Input Handling If you are using Input Manager (Old) or Both, change it to Input System Package (New).

2. Switch the Platform to Android

Go to File > Build Profiles > Android > Switch Platform

3. Run the Meta XR Project Setup Tool

Navigate to Meta XR Tools > Project Setup Tool. Click Fix All Outstanding Issues and Apply All Recommended Items.

Note: You can safely ignore the message: “Beginning with v74, it is recommended to use the OpenXR plugin instead of the OculusXR plugin.”

4. Configure HISPlayer Settings

Go to Tools > HISPlayer > Player Settings Configuration Click Fix All, but do not enable “Set Multithreaded Rendering to Disable”.

Note: The Meta XR Project Setup Tool may show “Target API should be set to 32 to ensure the latest supported version.” This can be ignored or refer to the Common Issues section.

5. Configure Graphics API

Go to Player Settings > Other Settings > Auto Graphics API and disable it. Keep OpenGLES3 only and remove Vulkan.

6. Open a Scene

Open one of the three scenes located in Assets/HISPlayerVRSample/Scenes/. When opening a scene, a prompt may appear to import TMP Essentials.

If it does not appear automatically, go to Window > TextMeshPro > Import TMP Essential Resources

7. Enter License Key (if required)

In the Inspector Window, select StreamController GameObject → HISPlayerVRController component → License Key. Enter your provided HISPlayer license key.

8. Add the Scene to Build List

Go to File > Build Profiles > Scene List and add the selected scene as the first in the list.

9. Select the Target Device

Go to Build Profiles > Android > Run Device and select your connected device.

10. Build the Project

Choose Build or Build and Run. A warning may appear saying “Disable Multithreaded”. Click Continue and ignore it.

This sample includes three different scenes, each demonstrating a different playback configuration: Standard VR, 180° Stereoscopic, and 360°.

Video Rendering: The video is rendered to the Screen GameObject.

Material Used: Assets/HISPlayerVRSample/Resources/Materials/HISPlayerVRMaterial.mat

Material Settings:

1. Click on HISPlayerVRMaterial.mat and check the Inspector window.
2. Shader: HISPlayer/HISPlayerDefaultShader

Setting HISPlayer Stream Properties:

• In the Hierarchy Window, select StreamController
• Then go to the Inspector Window → HISPlayerVRController (Script) → MultiStream Properties
  • Render Mode: Material
  • Material: HISPlayerVRMaterial.mat
  • URL: A default URL is provided, but you can modify it to test your own stream.

Video Rendering:
The video is rendered to the Unity Skybox.

Material Used:
Assets/HISPlayerVRSample/Resources/Materials/HISPlayerVR180StereoscopicMaterial.mat

Material Settings:

1. Click on HISPlayerVR180StereoscopicMaterial.mat and check the Inspector window.
2. Shader: HISPlayer/HISPlayer360Shader
3. Image Type: 180 Degrees
4. 3D Layout: Side by Side
5. Render Queue: 2501

Setting HISPlayer Stream Properties:

• In the Hierarchy Window, select:
  StreamController
• Then go to the Inspector Window → HISPlayerVRController (Script) → MultiStream Properties
  • Render Mode: Material
  • Material: HISPlayerVR180StereoscopicMaterial.mat
  • URL: A default URL is provided, but you can modify it to test your own stream.

Video Rendering:
The video is rendered to the Unity Skybox.

Material Used:
Assets/HISPlayerVRSample/Resources/Materials/HISPlayerVR360Material.mat

Material Settings:

1. Click on HISPlayerVR360Material.mat and check the Inspector window.
2. Shader: HISPlayer/HISPlayer360Shader
3. Image Type: 360 Degrees
4. 3D Layout: None
5. Render Queue: 2501

Setting HISPlayer Stream Properties:

• In the Hierarchy Window, select:
  StreamController
• Then go to the Inspector Window → HISPlayerVRController (Script) → MultiStream Properties
  • Render Mode: Material
  • Material: HISPlayerVR360Material.mat
  • URL: A default URL is provided, but you can modify it to test your own stream.

If you are using HISPlayer SDK version 3.4.0 and above, you will find HISPlayer360Shader.shader for 360 video playback in Packages/com.hisplayer.hisplayersdk/HISPlayer/Scripts/Shaders/.

HISPlayerVRSample uses the default Unity Skybox/Panoramic shader, as explained in the HISPlayer 360 Material.

If you use Linear Color Space in the Unity Project Settings > Player Settings > Other Settings > Rendering > Color Space, please change the default shader to HISPlayer360Shader which will improve the video rendering quality by following these steps :

• Open Assets/HISPlayerVRSample/Resources/RenderTextures/Materials/HISPlayer_360_Material.mat

• In the Inspector window, change Shader to HISPlayer360Shader

• Make sure you have the following setting of the material:

There is a conflict between the recommended configuration of the HISPlayer SDK, which asks you to disable Multithreading, and the Meta XR SDK, which asks you to enable it. HISPlayer requires this to avoid certain issues with some Android devices, specifically mobile phones. Therefore, it is recommended to enable it as required for Meta Quest usage and ignore the HISPlayer warning.

If you face an issue where the video is vertically inverted or rendered upside down, please follow 1 of these 2 approaches:

• Approach 1 (Recommended): Use HISPlayer360Shader.shader and attach it to the material as explained in the previous section. Make sure that the Flip Vertically option is enabled.

• Approach 2: Set FlipTextureVertically of the StreamProperties to true before calling SetUpPlayer() in your project script. This API will flip the texture vertically. This API will work only for Android and Meta Quest devices, it will not have effect in the Unity editor. For example:

  // Flip texture vertically to render the texture correctly for Skybox material.
  multiStreamProperties[0].FlipTextureVertically = true;
  SetUpPlayer();
  

Please don't mix both approaches, otherwise the video will be veritcally inverted.