Develop

Select your platform

Overview

Setup

Setting up your development environment

Prerequisites

Installing Unreal Engine

Installing Android Studio

Installing the Meta XR Plugin

Configuring your headset

Resources

Choosing Unreal Enigne installation by feature compatibility

PC-VR Integration for Unreal Engine

Get started

Setting up your first project

Configuring the Meta XR plugin

Choosing an OpenXR Backend

Packaging your new project

Meta XR plugin settings

Unreal Engine Royalty Payment Program

Add user input and interactions

Interactions

Overview

Getting Started

Custom Hand and Controller Meshes

Architecture

Overview

Interaction Lifecycle

Custom Distance Grab Visuals

Custom Ray Grab Visuals

Poking Objects

Raycasting

2D UI Panels

Playing Sounds for Interactions

Creating a Distance Grab Interaction

Controller Input Mapping

Oculus Touch Controller

Touch Plus Controllers

Controllers Best Practices

Controllers Troubleshooting

Add Realism using Movement SDK

Morph Target Visual Reference

Body Joints Visual Reference

Integrate Voice Features

Overview

Integrating Voice SDK

Enabling Voice Commands

Setup Voice Command

Activation

Redirecting the Wit Endpoint

Versioning Your App

Providing Voice Transcriptions

Providing Visual Feedback

Live Understanding

Enabling Dictation

Using Text-to-Speech (TTS)

Overview

TTS Voice Customization

Integrate Mixed Reality

Use Mixed Reality Utility Kit

Passthrough Relighting Sample

Add Real-World View with Passthrough

Create Depth Perception

Troubleshooting and FAQ

Manage Scenes

Overview

Spatial Data Permissions

Semantic Labels for Scenes

Best Practices

Migrate to MR Utility Kit

Deprecated

Get Started with Scene Actor

Importing Scene Entity Meshes

Scene Mesh

Blueprint Reference

Using Spatial Anchors

Overview

Getting Started

Spatial Anchors

Shared Spatial Anchors

Mixed Reality Experience and Use Cases

Platform Solutions

Overview

Get Started

Getting Started Guide

Server-to-Server API Basics

Set Up for Platform Development

Audio

Multiplayer Features

Multiplayer Overview

Multiplayer Enablement

Destinations

Group Presence

Invite to App

Testing and Use Cases

Invokable Error Dialogs

SharedSpaces Multiplayer Showcase

Test Cases

Multiplayer Testing

Multiplayer Testing with Link

Multiplayer Testing with link and Meta XR Simulator

Multiplayer Testing Tool

User Engagement

User Engagement Overview

User Notifications

Overview

Create User Notifications

Event-Based Notifications

Analytics

Developer Posts

Leaderboards

Leaderboards Client APIs

Leaderboard Server APIs

Events

Achievements

Challenges

Challenges Client APIs

Challenges Server APIs

Share Content from Apps

Monetization

Monetization Overview

Add-ons - Downloadable Content and In-App Purchases

Server APIs for Subscriptions

Social Features

Social Features Overview

Blocking

Parties and Party Chat

Mic Switcher

User Info, Friends and Relationships

Overview

Verify the User

Enable Friend Requests (Mobile)

Managed Accounts

User Management

User Management Overview

Asset Files to Manage Download Size

App Deep Linking

System Deep Linking

Requiring Minimum OS Versions

Cloud Storage

Cloud Backup

Save Game Best Practices

Shader Compilation

Platform Services

Cross-Device Development with App Groupings

Webhooks

Sample Apps

Platform Reference

Platform Release Notes Archive

Display and Rendering Capabilities

Overview

Meta Quest

Fixed Foveated Rendering

Eye Tracked Foveated Rendering

Set Display Refresh Rates

Multi-View

Enabling Phase Sync Adaptive Frame Timing

Enabling Late Latching

Tone Mapping

PC-VR

Unreal Forward Shading Renderer

Adaptive Pixel Density

All Headsets

VR Compositor Layers

Layer Filters - SuperSampling and Sharpening with MQSR

Color Space and Color Scaling

Material shader statistics with Adreno Offline Compiler

Performance and Optimization

Build and Test

Build

Building and Packaging Apps

Iteration Speed Best Practices

Reduce App Deploy Time During Development

Improve Compile Times with FASTBuild

Test

Testing and Automation Tools

Use Meta Quest Scriptable Testing Services to Enable E2E Testing

Using AutoDriver to Record Inputs

Using Oculus Debugger for VS Code

Vulkan Validation Layers

Testing and Performance Analysis

PC-VR - Testing and Performance Analysis

Enhance the User Interface

Splash Screen

Overlays and Input Focus

Overview

Enable Keyboard Overlays for Text Input

Mixed Reality Capture

Creating without a Boundary

Social Applications and Revenue

Publish Your App

Unreal Engine Royalty Payment Program

Set Target Device and Get Device Type at Runtime

Upload App to Meta Horizon Store

Meta XR Plugin Settings

Developer Tools

Using Link for App Development

Meta XR Project Setup Tool

Meta XR Mixed Reality Template

Meta Quest Developer Hub

Overview

Get Started

Manage Your Headset

Set Up Headset with MQDH

Enable AI tools with MCP for Meta Horizon OS developers

Debugging Tools

Create Custom Command

Performance Analyzer

Overview

How to Take Perfetto Traces

Layer Visibility Control

Explore File Manager

Add, Remove, and Switch Between Multi-User Accounts

MQDH Downloads

Deploy Build on Headset

Troubleshooting MQDH

Submit and Track Bugs and Feature Requests

Android Tools

Collect VrApi Logs with Logcat

Overview

Logcat Stats Definitions

Configure Android System Properties

Use ADB with a Headset

Taking and Loading a Capture

Performing a Render Stage Trace

Performing a Draw Call Trace

Accessing Vulkan Shader Stats

OVR Metrics Tool Stats Definition Guide

Best Practices - OVR Metrics Tool for Non-Engineers

Interaction Simulation

Simulate User Input from Keyboard, Mouse, and Xbox Game Controllers

Simulate User Input from Meta Quest Controllers

Point-and-Click

Simulate a Mixed Reality Environment

Test Rooms

Overview

Built-in Rooms

Build your room in the Synthetic Environment Builder

Samples and Showcases

Overview

Unreal Showcases

Train Hand Tracking Sample

Scene

Shared Spatial Anchor

Set Client Color Desc

Set Color Scale and Offset

Guardian

Get Guardian Dimensions

Get Guardian Points

Get Node Guardian Intersection

Get Play Area Transform

Get Point Guardian Intersection

Is Guardian Displayed

Set Guardian Visibility

Hand Tracking

Get Hand Scale

Get Hand Skeletal Mesh

Initialize Hand Physics

Is Pointer Pose Valid

Is Hand Tracking Enabled

Get Oculus MR Settings

Load from Ini

Save to Ini

Get Tracking Reference Component

Set Tracking Reference Component

Overlay and Dash Blueprints

Has Input Focus

Passthrough

Add Passthrough Layer Component

Add Static Surface Geometry

Remove Static Surface Geometry

Add Procedural Surface Geometry

Remove Procedural Surface Geometry

Set Edge Rendering Color

Set Texture Opacity

Performance Optimization Blueprints

Get Available Display Frequencies

Get Current Display Frequency

Set Display Frequency

Get GPU Frame Time

Get GPU Utilization

Set CPU and GPU Levels

Get FFR Level

Set FFR Level

Position and Orientation

Enable Orientation Tracking

Enable Position Tracking

Get Base Rotation and Base Offset in Meters

Get Pose

Get Raw Sensor Data

Is Device Tracked

Set Base Rotation and Base Offset in Meters

Splash Screen

Add Loading Splash Screen

Clear Loading Splash Screen

Enable Auto-Loading Splash Screen

User, Device, and Account

Get Device Type

Get User Profile

Verify User Entitlement

Console Command Reference

Experimental Features

Avatar SDK C/C++ Developer Reference (Retired)

Updated: Jul 21, 2021

The Meta Avatar SDK Developer Reference contains detailed information about the data structures and files included with the SDK.

See Meta Avatar SDK Reference Manual.

Did you find this page helpful?

About us

Virtual reality / Meta Horizon

Meta Horizon Creator Program

Discover

Why Meta Quest?

What is mixed reality?

Platforms and tools

2D apps for Meta Horizon OS

Support and legal

About us

Virtual reality / Meta Horizon

Meta Horizon Creator Program

Discover

Why Meta Quest?

What is mixed reality?

Platforms and tools

2D apps for Meta Horizon OS

Support and legal

About us

Virtual reality / Meta Horizon

Meta Horizon Creator Program

Discover

Why Meta Quest?

What is mixed reality?

Platforms and tools

2D apps for Meta Horizon OS

Support and legal

English (US)