Develop
Develop
Select your platform

Using Keyboard Tracking Sample (Deprecated)

Updated: Jan 23, 2025
Tracked Keyboard Deprecation
As of v72, Tracked Keyboard as a feature is being deprecated in favor of the new Generic Keyboard Tracker (available on Quest 3 and Quest 3S).
For Unity integration, we recommend using Trackables in MR Utility Kit:
  • Unity Trackables
  • Keyboard Tracking
    • For Native integration, please see:
  • Dynamic Object Tracker Documentation
    • This documentation is no longer being updated and is subject for removal.

    Prerequisites

    Before you begin working with the tracked keyboard, you need the following:
    Make sure to use the latest version of the Meta Quest operating system and the Meta XR Core SDK, which is available individually or as part of the Meta XR All-in-One SDK. To verify this, do the following:
    1. In the headset, go to Settings > System > Software Update.
    2. Check the version.
    3. If the version is not 37 or higher, update the software to the latest available version.

    Pair Keyboard

    To pair your keyboard, follow these steps:
    1. Set the keyboard in pairing mode.
    2. In the headset, go to Settings > Devices > Bluetooth and select Pair.
    3. Select the tracked keyboard from the list of available devices. If the keyboard is not listed, ensure it is not already connected to any other device such as your computer.
    4. Using the tracked keyboard, type the pairing code and then press Return/Enter. When the See Your Keyboard in VR dialog appears, the keyboard pairs with the headset.
    5. Select OK and restart the headset.
    The keyboard should now appear in VR. If you place your hands on or close to the top of the keyboard, you will see your hands in passthrough. If you do not, ensure there is good lighting and the keyboard is set against a contrasting surface.
    Once your keyboard is connected, launch the XrKeyboard sample app which is included in the Oculus OpenXR Mobile SDK.
    If the keyboard is connected properly, the app will start searching for your keyboard immediately. As soon as the app tracks the keyboard, the 3D model renders in VR on top of where it would exist in the real world.
    You can find the connection and tracking status of your keyboard in the UI screen display. The name of the keyboard model that you have selected appears in Settings.
    The following UI options allow users to change the behavior of the tracked keyboard:
    Toggle Local or Remote Keyboard
    Remote Keyboard
    This option changes the expected tracked keyboard type between Remote and Local (Bluetooth) keyboard.
    Use Model with Passthrough Hands
    Model with Passthrough Hands
    In this mode, you see the full keyboard model rendered in VR space. Moving your hands over the keyboard enables a passthrough layer that allows you to see your own hands over the rendered model.
    Use Passthrough Window
    Passthrough Window
    This mode enables a passthrough window that is displayed around the tracked keyboard and gives a more natural feel. With this mode active, the VR model of the keyboard is no longer rendered.
    Toggle Require Keyboard Connected
    Connection required
    This option toggles between requiring the tracked keyboard to be connected through Bluetooth or not. If disabled, it allows the keyboard to still be tracked and rendered. However, there is no way for the device to capture input from keys pressed if the keyboard is not connected.
    Did you find this page helpful?
    Nav Logo
    Virtual reality / Meta Horizon
    Virtual reality / Meta Horizon
    Virtual reality / Meta Horizon
    English (US)
    © 2026 Meta