• home
  • Configuration Example

Configuration Example


This is a step by step guide to setting up a HoloSuite Player in Unity.

For the reference documentation of the Unity HoloSuite Player plugin, refer to the Unity HoloSuite Player Reference Documentation.

The HoloSuite Player supports playing back your OMS, AVV, or HoloStream in Unity’s Built-in render pipeline, URP, and HDRP.

HoloSuite Player Unity Configuration Example

The following is a walkthrough of a typical HoloSuite Player configuration:

To begin, ensure all necessary packages are included in your project. For instructions on how to import the HoloSuite Player Package please refer to the HoloSuite Player Unity Installation documentation.


The HoloSuite Player package includes samples for each render pipeline that serve as a good starting point to build scenes from, and are a good way to see a correctly configured HoloSuite Player. You can import these samples from the Package Manager. Once imported you can load these example scenes from Assets > Samples > HoloSuite Player > 4.0.0 > HoloSuite Player - (imported render pipeline) > Scenes. The second HoloSuite Player category will be named to reflect which sample project you imported into your project.

Sample volumetric data will also be provided in the sample assets.

Because these examples are already pre-configured, they are the quickest way to get your volumetric clip playing in Unity. If you are just looking to quickly get a clip playing, simply load up the scene for your active render pipeline and change out the clip source file(s) of the HoloSuite Player GameObject with the volumetric clip file(s) you exported from HoloEdit.

For more information on the HoloSuite Player sample content review HoloSuite Player Unity Sample Content.


If you are looking to configure a HoloSuite Player from scratch, follow the steps below.

Importing OMS Files

The Unity HoloSuite Player supports importing OMS and MP4 as though they are native assets as long as frame encoding is present in the MP4 file. If you are unsure if your clip has frame encoding, take a look at the bottom right corner of your MP4 texture file. You will see a series of white moving dots, these represent the binary for the current frame. This is the frame encoding. If they are present you can drag and drop your OMS and MP4 files into any folder in your Unity project.

OMS and MP4 data that does not include frame encoding must be placed inside of the StreamingAssets directory, located in the Assets project folder. (Assets/StreamingAssets). If you do not have a StreamingAssets folder, create one under ‘Assets’.

The location you imported your OMS file into will determine your source type. For more information on source types take a look at the source types section of our docs.

OMS inspector: Once the OMS files have been loaded into the Unity Project you can inspect them by clicking on the OMS file. This will show you some statistics for the file, and a preview of its mesh in the inspector. This is useful for checking to see if your OMS includes retargeting data, or normals.


Import an AVV File

The Unity HoloSuite Player supports importing AVV files as though they are native assets. You can drag and drop your AVV file into any folder in your Unity project.

Import a HoloStream

While HoloStreams can be played by inputting their URL directly into the HoloSuite Player, they can also be stored in HoloStream asset files. These files make it convenient to store, swap, and manage your HoloStreams within a Unity Project. To create a HoloStream asset right click on the project panel and select Create > Arcturus > HoloStream > Asset. You can then input your HoloStream URL into the URL field to link the HoloStream Asset to that stream.

Playing Volumetric Video Assets

Now that your AVV, OMS, or HoloStream asset has been imported, you can simply drag it into the scene viewport to complete the setup. This will auto generate the HoloSuite Player Game Object, load your asset, as well as linking the correct material to match your asset and render pipeline. You can now play your scene, and playback will start on the volumetric asset.


In order for the MP4 texture file to be correctly linked when drag and dropping an OMS asset, it must have the same name, and be in the same folder as the OMS asset. If it is not, you will need to select it in the Video Clip field of the HoloSuite Player Game Object.


Timeline Playback with AVV assets

One advantage the AVV assets have is access to playback VIA the timeline. This allows them to be controlled on a per-frame basis, allowing tight coordination with the rest of your scene.



To configure the HoloSuite Player for timeline playback you will need create a timeline asset. Open the timeline by navigating to Window > Sequencing > Timeline. With the Game Object containing your HoloSuite Player selected, click on the Create button in the timeline panel. This will ask you to save the playable timeline asset. You can place this anywhere in your asset folder. In the timeline you just created, click the + button to add a new track. Select Arcturus > Volumetric Video Track to create a new volumetric video track.


Now drag the Game Object containing your HoloSuite Player into the new volumetric video track. Lastly adjust it’s position on the track so that playback starts at the zero marker. This is now configured, and once you click play, you can scrub though this timeline to control playback of the AVV clip.