Skip to content
This repository has been archived by the owner on Jan 6, 2025. It is now read-only.

Latest commit

 

History

History
110 lines (80 loc) · 5.64 KB

unreal-streaming.md

File metadata and controls

110 lines (80 loc) · 5.64 KB
title description author ms.author ms.date ms.topic ms.localizationpriority keywords appliesto
Streaming in Unreal
Learn how to stream your Unreal apps to HoloLens 2, including streaming limitations and command line options.
sw5813
vinnietieto
08/04/2020
article
high
Unreal, Unreal Engine 4, UE4, HoloLens, HoloLens 2, mixed reality, streaming, PC, holographic app remoting, holographic remoting player, documentation, mixed reality headset, windows mixed reality headset, virtual reality headset
HoloLens
HoloLens 2

Streaming in Unreal

"Streaming" is sometimes referred to as "Holographic Remoting." To learn more, see Holographic Remoting Overview

Streaming from a PC to HoloLens provides two major advantages:

  • It lets your mixed reality app take advantage of your PC's computational power.
  • It helps speed up development iteration time.

To get started, you'll need to download the Holographic Remoting Player to your HoloLens device. The Holographic Remoting Player lets your app to stream directly to the remoting player on your HoloLens from the following sources:

  • The Unreal Engine editor
  • A packaged Windows executable

When streaming, you have access to almost all of the same HoloLens capabilities as you would when running an application on a device. This includes hand joint tracking if you're on a HoloLens 2, spatial mapping, and spatial anchors, but leaves out the features on this list.

Note

  • Streaming quality is highly dependent on the strength of your wifi network.
  • All capabilities are automatically enabled for the holographic remoting player. If you find a capability that requires user permission (ex: eye tracking) to be working over streaming but not when running on device, check to ensure you've enabled the proper capabilities under your project settings.

Streaming limitations

Hand meshes, the HoloLens camera, and the system keyboard are unavailable over streaming. Note that speech input for streamed apps can be acquired via the microphone of the PC you are streaming from.

OpenXR

Unreal 4.26 running on OpenXR supports streaming to versions 2.4.0+ of the Holographic Remoting Player. For the latest feature support with Holographic Remoting see the version history and the troubleshooting pages.

Device support

Source HoloLens first Gen HoloLens 2 Immersive Headsets
Unreal editor ✔️ ✔️ ✔️
Windows package ❌ ✔️ ✔️

Note

Starting with Holographic Remoting version 2.2.0 streaming is also available for Windows PCs running Windows Mixed Reality.

Streaming from the Unreal editor

As a developer, you'll find that streaming from the Unreal editor to your HoloLens device provides significant benefits when testing, namely that you no longer have to wait for your app to build and deploy before trying out your updates.

You can find detailed instructions for streaming from the Unreal editor in our tutorial series.

Streaming from a packaged Windows executable

In Unreal 4.25.1 and onwards, you can stream your app to a HoloLens 2 device from a packaged Windows executable:

  1. Go to File > Package Project > Windows in the editor menu.

    • Choose a location to save your package and select Select Folder.

  2. Once the package has finished building, open the Holographic Remoting Player on your HoloLens 2 and make note of the IP Address.

  3. Leave the Holographic Remoting Player open and use the command line prompt to:

    • cd into the local directory where you saved your package.
    • Enter the following command: <App Name>.exe -vr -HoloLensRemoting=<IP Address>

Note

The application name in your project settings should be automatically used to create the Windows package. If these are different for some reason, use the Windows executable name in the command prompt.

Note

If eye tracking isn't working when streaming from a packaged executable, either disable any other plugins with PC-supported eye trackers (example: Magic Leap) or run the application from the command line with the relevant eye tracking argument (see command line options).

Hit enter and watch your application start streaming!

Command line options

Additional command line options for streaming from each platform in Unreal Engine 4.26+ can be found in the table below.

[!INCLUDE]

See also