Spectator View is an augmented reality product that enables viewing HoloLens experiences from secondary devices. Spectator View has multiple configurations and supports a variety of scenarios from filming quick prototypes to producing keynote demos.
Active development occurs in MixedReality-SpectatorView's master branch. It's suggested to consume Spectator View code from one of the release branches compared to the master branch.
Note: Spectator view uses symbolic linked directories in its sample projects, which results in large file paths. It's suggested to place your Unity project in a short named directory (such as C:\sv). Otherwise, file paths may become too long to resolve in Unity.
The MixedReality-SpectatorView repository uses Unity packages, git submodules and symbolic linked directories for obtaining and referencing external dependencies. Prior to opening any Unity projects, its suggested to run tools/Scripts/SetupRepository.bat as an administrator on your PC (On Mac or Linux, you can run /tools/scripts/SetupRepository.sh). This script has a few purposes:
- It configures your git repository to use clrf line endings and support symbolic linked directories.
- It obtains and updates all git submodules declared in the MixedReality-SpectatorView repository.
- It fixes any symbolic linked directories in the MixedReality-SpectatorView respository.
Note: Not all submodules have the same MIT license as the MixedReality-SpectatorView repository. Submodules in this project currently include: MixedRealityToolkit-Unity, Azure-Spatial-Anchors-Samples and ARCore-Unity-SDK. You should view and accept the licenses in these projects before running the SetupRepository.bat script.
It's easy to get started by building off one of the samples, or inspecting them to understand project setup. For more information, see Samples.
Below are simple instructions for adding Spectator View to your project:
- Ensure you have all of the Software & Hardware.
- Ensure you have added the appropriate platform dependencies to your project (ARCore/ARKit)
- Download the Spectator View repository.
- Copy the contents of
src\SpectatorView.Unity\AssetstoMixedReality.SpectatorViewfolder in the Assets folder of your project. - Choose a Spatial Alignment Strategy and spatial localizer.
- Add the appropriate Spatial Localizer Dependencies based on your chosen spatial localizer.
- Add the
MixedReality.SpectatorView/SpectatorView/Prefabs/SpectatorView.prefabprefab to your primary scene. - Configure the localization methods you wish to use: Spatial Localizer Dependencies.
- Generate and check-in Asset Caches to your project repo: Before Building
- Build & Deploy your primary scene onto the hosting device.
- Configure the IP Address of the host device in the spectating scene for each platform
MixedReality.SpectatorView/SpectatorView/SpectatorView.<Platform>.unityyou will deploy to. - Build & Deploy your spectating scenes onto the spectating devices.
Note: Some platforms require a special build step, for build information see: Building & Deploying
For more information on setting up a Spectator View project, see the following pages:
For more information on Spectator View's architecture, see here.
For more information on debugging Spectator View, see here
The easiest way to file feedback is by opening an issue. When filing feedback, please include the following information (when applicable):
- Whether you're using a HoloLens or HoloLens 2 device
- Development PC Windows Version
- Unity Version
- Whether you are building with .Net, Mono or il2cpp in Unity
- Visual Studio Version
- Windows SDK Version
- iOS device type/iOS Version
- Mac OS Version
- Android device type/Android OS Version
- Android Studio Version
In addition to opening issues, Spectator View contributors are active on Stack Overflow. Use the MRTK tag when asking Spectator View related questions.
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.
When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.