Composite the Scene using OBS

Important

All Oculus Quest developers MUST PASS the concept review prior to gaining publishing access to the Quest Store and additional resources. Submit a concept document for review as early in your Quest application development cycle as possible. For additional information and context, please see Submitting Your App to the Oculus Quest Store.

This page describes the process of configuring OBS Studio using the Oculus plugin provided in the tools download to compose the scene.

Install the OBS Plugin

If you have not done so already, install OBS Studio (x64, Windows) now. Then, navigate to the root folder of your OBS install, obs-studio. Copy the entire contents under oculus-mrc_OBS folder from the tools download to the obs-studio root. You only need to do this once.

OBS Plugin Source

The source code of the “Oculus MRC” plugin for OBS is available at https://github.com/facebookincubator/obs-plugins, and offered under GNU General Public License, version 2 (https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html).

Composition Setup

Before you start compositing your mixed reality scene, make sure you’ve completed the Camera Calibration process. The process described below may require additional configuration or customization based on your camera and computer. The OBS Wiki describes how to use the software in detail.

  1. Create your new scene and add the “Oculus MRC” source. Right-click the source and select Group Selected Items. Rename this group “fg”.
  2. Right-click the “fg” group and select Copy.
  3. Right-click on an empty space in the “Sources” window and select Paste (Duplicate). Rename this group “bg”.
  4. Add a “Video Capture Group” to each group.
  5. Crop each group -
    • Uncheck “Relative” checkbox
    • “fg” - 1920, 0, 1920, 1080
    • “bg” - 0, 0, 1920, 1080
  6. Configure the “Video Capture Device” by adding a Chroma Key and Render Delay. These values will depend on your setup and configuration.

Begin Capture

Start the application in your Oculus Quest that you want to capture in mixed reality. Then -

  1. Double-click either of the “Oculus MRC” sources. In the properties window that opens, enter the IP Address that you recorded in the Camera Calibration process. Click Connect.
  2. Adjust the Render Delay so that the recorded real-world controller movement matches the in-app controller/hand movement.
  3. Adjust the Sync Offset in OBS’ Advanced Audio Properties if the audio and video of the capture are out of sync.
  4. Record or stream your mixed reality experience.
  5. When finished, Disconnect in the “Oculus MRC” sources.

Troubleshooting

  • If you’re unable to connect your Oculus Quest to OBS. Verify that your PC and HMD are on the same network and that mrc.xml is present on the device, then restart your Oculus Quest.
  • The mixed reality capture quality and latency is heavily depend on the quality of the wireless network connection. If you are seeing unstable performance or heavy video latency, please use a dedicate wireless router with 5G bands.