ISAR SDK Trial

Interactive Streaming for Augmented Reality (or just ISAR) is a plugin, allowing interactive (data/telemetry being transmitted both ways) streaming of ANY application to XR devices.
Explore the docs »

View Demo · View Integration · Report Bugs · Request Features

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

The following documentation specifically references usage with the Unity Game Engine, however the ISAR SDK can be used independently of Unity. For more support regarding usage outside of Unity, see the Support section of our website.

(back to top)

Built With

• WebRTC
• C/C++

(back to top)

Trial Notice

Since this is a trial of the ISAR SDK, it comes with an expiration date. We always update the package/repo prior to the date running out. Your application will no longer stream once the trial expires! So keep an eye out for udpates.

⚠️ This trial will expire/renew January 31st, 2023 ⚠️

(back to top)

Getting Started

Now with that out of the way, let's get you started on rolling with ISAR SDK. We recommend you check out the quick integration tutorial video as well as an overview of the architecture.

Release Notes

• Check out the latest Release Notes

Prerequisites

• Minimum Unity 2019.4.x (tested with 2019.4.21f1)
• Disable your Firewall (or check below for specific ports to open for the stream)

First Time Installation

1. Open an existing Unity 3D project or create a new one
2. Remove previous versions of ISAR from the project (skip this if the project does not currently have ISAR installed)
   • Open Package Manager in the Unity editor (Window -> Package Manager)
   • Find the ISAR Core package and choose Remove
   • Find the ISAR MRTK Extensions package, if installed, and choose Remove
3. Import ISAR Core into the project
   • Open Package Manager in the Unity editor (Window -> Package Manager)
   • If installed, remove the Version Control package from the project
   • Click the + then Add package from disk... and select the file package.json from the com.hololight.isar directory contained in this repository
4. Add the desired toolset following the instructions below
   • MRTK; supports HoloLens 2, Oculus Quest 2 and Android clients
   • XR Interaction Toolkit; supports Oculus Quest 2 client

(back to top)

Project Configuration

1. Navigate to Edit -> Project Settings -> XR Plug-in Management
   • Enable ISAR XR
2. Open File -> Build Settings...
   • Ensure the following configuration is selected:
     • Platform: PC, Mac & Linux Standalone + Architecture: x86_64

(back to top)

ISAR Configuration File

The configuration file for ISAR is located within the ISAR Core package in Runtime/Resources. A copy of this file is placed in the Assets/StreamingAssets directory of the Unity project when the server is run. Changes to the configuration file in StreamingAssets will be overwritten each run and each build; therefore it is recommended not to make changes to the copied file.

Below is a description of each section within the configuration file that can be changed by the developer. The suggested default values for each client can be found here.

• width and height determine the resolution of the rendered image per view/eye. Careful, the resolution needs to be supported by the H264 hardware decoder of the client device
• numViews determines the number of views/eyes rendered on the client device. Valid values are:
  • 1 for mono rendering, e.g. Tablets
  • 2 for stereo rendering, e.g. HoloLens
• bandwidth allows the developer to specify the bitrate for the encoder. If no value is set, a default value of 20mbit is used.

(back to top)

First Time Run

Enter play mode in the Unity editor or build a standalone application with the following settings:

• Platform: PC, Mac & Linux Standalone
• Target Platform: Windows
• Architecture: x86_64

The ISAR server application will start listening on the TCP port 9999. The ISAR client application is using this port to establish the streaming session. If the connection fails, ensure that no firewall is blocking it.

(back to top)

Disabling ISAR

The ISAR SDK can be disabled while remaining as a package in the project. To do so, follow the below steps:

• Click Edit->Project Settings and move to the XR Plug-in Management section
• Uncheck ISAR XR
• Check Unity Mock HMD
• Ensure not to call the Isar class, or any of the inherited classes (IsarViewPose, IsarAudio, IsarCustomSend or IsarQr), constructor within the code
• Disable the QrSupport script if it is enabled

(back to top)

Clients

ISAR SDK supports several clients that can connect to the server. For information on installing and connecting with specific clients, refer to Clients.

(back to top)

Example

A preconfigured example is available within the repository. For information on how to load this example, refer to Example.

(back to top)

Additional Features

QR Code

To find out how to easily integrate QR code support, see here.

Image Tracking

To find out how to enable and use image tracking, see here.

For more examples, please refer to the Docs.

(back to top)

Roadmap

• Depth (Stabilization)
• Spatial Understanding
• ISAR 3.0
  • Improved Audio
  • Improved Performance
• iOS Support

See the open issues for a full list of proposed features (and known issues).

(back to top)

License

Distributed under Holo-Light GmbH's Proprietary License. See License.txt for more information.

(back to top)

Contact

Holo-Light GmbH - @Holo_LightGmbH - [email protected]

Project Link: https://github.com/Holo-Light-GmbH/ISAR-SDK-Trial

(back to top)