README.md

Spectator Mode

With this demo project and our network anchors package, you can create multi-user, co-located Unity apps where:

• users share spatially anchored virtual content
• that virtual content is streamed over NDI to OBS and composited with the feed of any external camera so viewers can see exactly what the users are seeing in real time
• Magic Leap headsets and iOS or Android phones share cross-platform virtual content through image tracking localization
• any or all of the above can be used, features are all independent of each other

This readme includes the instructions on setting up the demo as well as the technical information required to create custom streaming solutions. Please report any questions or issues using Github’s issue ticketing system.

Table of Contents

• Requirements
• Getting Started
• Integrating Spectator Mode into an Existing Project
• Included Packages

Requirements

All Platforms

• Unity 2020.3.x
• Photon Networking API Key
• .NET Standard 2.0 profile

Magic Leap

• Lumin SDK 0.26.0+

Standalone Client (NDI Streaming)

• Windows: D3D11 or D3D12
• macOS: Metal required
• Linux: Vulkan required
• External Camera Note: Any external camera that can be used in OBS can be used as the composite feed. Anything from a simple webcam to a fancy camera rig will work.

Mobile (iOS and Android)

• Device that is compatable with ARFoundation 4.1.7 +
• ARFoundation 4.1.7 + and relevant Unity XR Plugins (ARCore for Android, ARKit for iOS)
• An image target (sample image).

Getting Started

Clone this repository and be sure to include the following flag to also get the corresponding submodules:

git clone --recurse-submodules <spectator-mode repo url>

Check out the Documentation directory for detailed walkthrough guides on enabling and integrating Spectator Mode features:

• Running The Demo Spectator Mode Scene
  • Steps to run our pre-built Photon and NDI scene on Magic Leap and Standalone.
• Basic Setup and Getting Started with Photon
  • Project set up and basic scene using Photon Networking to create a co-located Unity experience.
• Streaming with NDI and OBS
  • Creating necessary NDI streaming compnents in unity scene and combining the camera streams using OBS.
• Image Tracking Mobile Localization
  • Sharing co-located content between the Magic Leap and a mobile phone (iOS or Android) by scanning an image target to create a cross-platform network anchor.

Integrating Spectator Mode into an Existing Project

1. Add the following packages to your own project:
   • Packages/jp.keijiro.klak.ndi@2.0.2
   • Add the following registry to your projects manifest.json file and download "System.Memory" from the Package Manager:

     "scopedRegistries": [
         {
           "name": "Unity NuGet",
           "url": "https://unitynuget-registry.azurewebsites.net",
           "scopes": [
             "org.nuget"
           ]
         }
     ]
     

   • Follow the magicleap.spectator.networkanchors "Install Guide" to add the Network Anchors package. You can also download the Examples by going to Package Manager > Packages: In Project > Custom > Network Anchors > Samples and selecting "Import".
2. Follow the Walkthrough Guides that correspond to the features you wish to integrate (multi-user connection with Photon, co-located virtual content, NDI streaming, or image target localization).

Included Packages

com.magicleap.spectator.networkanchors A lightweight tool that enables co-location experiences using a shared anchor.

jp.keijiro.klak.ndi@2.0.2 Keijiro’s Klak NDI package to preform the NDI to OBS streaming. The package itself has a dependency on the System.Memory package, also included.

Photon 2 Unity Networking This project uses the Photon Unity Networking to manage the network logic.

Overall Troubleshooting

Note: For NDI/OBS specific troubleshooting, reference the Streaming Guide

Note: For Mobile Localization specific troubleshooting, reference the MobileLocalization Guide

• If you get errors when first opening the project that reference issues with the KlakNDI, System.Memory, or System.Buffers packages, these should resolve themselves if you close and re-open the project.