mrtk_developmentreleases/2.0.0releases/2.1.0releases/2.2.0releases/2.3.0releases/2.4.0releases/2.5.0releases/2.5.1releases/2.5.2releases/2.5.3
  • Features and Architecture
  • API Documentation

We've moved!

Starting from MRTK 2.6, we are publishing both conceptual docs and API references on docs.microsoft.com. For conceptual docs, please visit our new landing page. For API references, please visit the MRTK-Unity section of the dot net API explorer. Existing content will remain here but will not be updated further.

  • Features and Architecture
  • Feature Overviews
  • Cross Platform Support
  • Configure MRTK for iOS and Android
Search Results for

    Show / Hide Table of Contents
    • Welcome to MRTK
      • Installation Guide
      • Configuration
        • Using the Unity Package Manager
        • MRTK configuration dialog
        • Getting started with MRTK and XR SDK
      • Updates and Deployment
        • Updating from earlier versions
        • Upgrading from HTK
        • Building and Deploying MRTK
      • Packages and Release Notes
        • Release Notes
        • MRTK Packages
      • Performance and Best Practices
        • Performance
        • Hologram Stabilization
        • Using MRTK in large projects
    • Architecture
      • Overview
      • Framework and Runtime
      • Input System
        • Terminology
        • Core System
        • Controllers, Pointers, and Focus
      • Systems, Extension Services and Data Providers
    • Feature Overviews
      • Boundary System
        • Boundary System Overview
        • Configuring the Boundary Visualization
      • Camera System
        • Camera System Overview
        • Camera Settings Providers
          • Windows Mixed Reality Camera Settings
          • Unity AR Camera Settings [Experimental]
          • Creating a camera settings provider
      • Cross Platform Support
        • Configure MRTK for iOS and Android
        • Configure MRTK for Leap Motion Hand Tracking
        • Configure MRTK for Oculus Quest
      • Detecting Platform Capabilities
      • Diagnostics System
        • Diagnostics System Overview
        • Configuring the Diagnostics System
        • Using the Visual Profiler
      • Extension Services
        • Extension Service Creation Wizard
        • Scene Transition Service Overview
        • Hand Physics Service Overview
      • Input System
        • Input Overview
        • Input Actions
        • Input Events
        • Input Providers
          • Input Providers Overview
          • Creating an input data provider
        • Controllers
        • Eyes
          • Overview
          • Getting Started
          • Access Data via Code
          • Validate Tracking Calibration
        • Gaze
        • Gestures
        • Hands
        • How to Add Near Interaction
        • In-Editor Input Simulation
        • Pointers
        • Voice Input
          • Dictation
          • Speech (Command and Control)
      • Multi Scene System
        • Multi Scene System Overview
        • Scene Types
        • Content Scene Loading
        • Monitoring Content Loading
        • Lighting Scene Operations
      • Packaging
        • MRTK Packages
        • MRTK Modularization
      • Profiles
        • Profiles Overview
        • Configuration Guide
      • Rendering
        • MRTK Standard Shader
        • Material Instance Overview
        • Hover Light Overview
        • Proximity Light Overview
        • Clipping Primitive Overview
      • Services
        • What makes a mixed reality feature
        • What are the MixedRealityServiceRegistry and IMixedRealityServiceRegistrar
        • Extension services
      • Spatial Awareness System
        • Spatial Awareness Overview
        • Spatial Observers
          • Configuring Observers for Device
          • Configuring Observers for Editor
          • Controlling Observers via Code
          • Creating a custom Observer
      • Teleport System Overview
      • Tools
        • Dependency Window
        • Extension Service Creation Wizard
        • Holographic Remoting
        • Input Animation Recording
          • Input Animation File Format Specification
        • Migration Window
        • Optimize Window
        • Runtime tools
          • Controller Mapping tool
          • InputFeatureUsage tool
      • UX Building Blocks
        • Toolbox Window
        • Button
        • Bounds Control
        • Object Manipulator
        • Constraint Manager
        • Slate
        • System Keyboard
        • Interactable
        • Solvers
          • Tap to Place
        • Object Collection
        • Scrolling Object Collection
        • Tooltips
        • Slider
        • Hand Menu
        • Near Menu
        • App Bar
        • Fingertip Visualization
        • Progress Indicator
        • Dialog [Experimental]
        • Hand Coach [Experimental]
        • Pulse Shader [Experimental]
        • Dock Control [Experimental]
        • HoloLens Keyboard Helpers [Experimental]
        • Rigged Hand Visualizer [Experimental]
        • Elastic System [Experimental]
        • Bounding Box [Obsolete]
        • Manipulation Handler [Obsolete]
      • Example Scenes
        • Examples Hub
        • Hand Interaction Example
        • Eye Tracking Interaction Example
    • Contributing
      • Contributing Overview
      • Coding Guidelines
      • Writing and Running Tests
      • Writing Documentation
      • Pull Requests
      • Experimental Features
      • Breaking Changes
      • How to use DocFX
    • Planning
      • Roadmap
    • Notice
    • Authors

    How to configure MRTK for iOS and Android [Experimental]

    Install required packages

    1. Download and import the Microsoft.MixedReality.Toolkit.Unity.Foundation package, from GitHub or the Unity Package Manager

    2. In the Unity Package Manager (UPM), install the following packages:

      Unity 2018.4.x

      Android iOS Comments
      AR Foundation
      Version: 1.5.0 - preview 6
      AR Foundation
      Version: 1.5.0 - preview 6
      For Unity 2018.4, this package is included as a preview. To view the package: Window > Package Manager > Advanced > Show Preview Packages
      ARCore XR Plugin
      Version: 2.1.2
      ARKit XR Plugin
      Version: 2.1.2

      Unity 2019.4.x

      Android iOS
      AR Foundation
      Version: 2.1.8
      AR Foundation
      Version: 2.1.8
      ARCore XR Plugin
      Version: 2.1.11
      ARKit XR Plugin
      Version: 2.1.9

      Unity 2020.1.x (Not currently formally supported, included for informational purposes only)

      Android iOS
      AR Foundation
      Version: 3.1.3
      AR Foundation
      Version: 3.1.3
      ARCore XR Plugin
      Version: 3.1.4
      ARKit XR Plugin
      Version: 3.1.3
    3. Update the MRTK UnityAR scripting defines by invoking the menu item: Mixed Reality Toolkit > Utilities > UnityAR > Update Scripting Defines

    Enabling the Unity AR camera settings provider

    The following steps presume use of the MixedRealityToolkit object. Steps required for other service registrars may be different.

    1. Select the MixedRealityToolkit object in the scene hierarchy.

      MRTK Configured Scene Hierarchy

    2. Select Copy and Customize to Clone the MRTK Profile to enable custom configuration.

      Clone MRTK Profile

    3. Select Clone next to the Camera Profile.

      Clone MRTK Camera Profile

    4. Navigate the Inspector panel to the camera system section and expand the Camera Settings Providers section.

      Expand settings providers

    5. Click Add Camera Settings Provider and expand the newly added New camera settings entry.

      Expand new settings provider

    6. Select the Unity AR Camera Settings provider

      Select Unity AR settings provider

      For more information about configuring the Unity AR camera settings provider: Unity AR camera settings provider.

    Note

    This installation checks (when the application starts) if the AR Foundation components are in the scene. If not, they are automatically added to make it work with ARCore and ARKit. If you need to set a specific behaviour, you should add the components you need by yourself. For more information about AR Foundation components and installation, check this documentation.

    Building a scene for Android and iOS devices

    1. Make sure you have added the UnityAR Camera Settings Provider to your scene.

    2. Switch platform to either Android or iOS in the Unity Build Settings

      When you switch the platform you should see the MRTK Project Configurator Window with settings for your chosen platform. Click Apply to enable platform specific settings.

      iOS Project Configurator Settings

      iOS Project Configurator

    3. There are no additional steps after switching the platform for Android.

    4. If the platform is iOS, Edit > Project Settings > Player > Other Settings, under the Optimization header, uncheck Strip Engine Code

      iOS Settings

      Note

      Unchecking Strip Engine Code is the short term solution to an error in Xcode #6646. We are working on a long term solution.

    5. Build and run the scene

    See also

    • Unity AR Camera Settings
    • Improve this Doc
    In This Article
    • Install required packages
    • Enabling the Unity AR camera settings provider
    • Building a scene for Android and iOS devices
    • See also
    Back to top Generated by DocFX