Oculus VR Client (Android)

The NVIDIA CloudXR SDK includes a sample Oculus VR client that is designed to work with VR headsets and that support the Oculus VR SDK. The client decodes and renders content that is streamed from the CloudXR server and collects motion and controller data from the VR headset that is sent to the CloudXR server.

The VR headset must be capable of decoding 4k HEVC video @ 60fps. The provided sample client has been tested with the Oculus Quest and Oculus Quest 2 devices, running at 72hz and 90hz.


The Android Oculus VR client is supplied only as source code.

Oculus VR Client Prerequisites


  • An Android VR headset that supports the Oculus VR SDK, for example: - Oculus Quest - Oculus Quest 2

  • Android Debug Bridge (ADB) to install the client application without needing full developer tools.


For developers who want to modify, build, and debug the client application, a complete Android development enviroment is required:

  • Android Studio 4.0 or later.

  • Android SDK 7.1.1 ‘Nougat’ (API level 25) or higher.

  • Android build tools 28.0.3

  • Android NDK 21.4.7075529

  • OpenJDK 1.8n


  • Android Studio can be downloaded from https://developer.android.com/studio.

  • Installing Android Studio also installs Android Platform Tools, Android SDK, and OpenJDK.

  • To install Android NDK from the Android Studio menus, click Tools>SDK Manager, select SDK Tools and then NDK, and click OK.

  • To use the bundled OpenJDK, click File>Project Structure in the menu bar. In the SDK Location page under JDK Location, select the Use embedded JDK checkbox, and then click OK.

  • The NDK version was selected because it was the LTS release at time of development and is aligned with Android Studio 4.0.x as the default NDK version.

    Newer NDK versions, such as 23.x, might cause build issues.

  • As of the CloudXR 3.1 release, only Android 64-bit builds are supported.

You also need:


Later SDKs may have problems, as Meta has moved to OpenXR in newer SDKs and deprecated the old Ovr APIs.

Building the Oculus VR Client

  1. Copy the OVR mobile SDK zip file that you downloaded into the {sdk-root-folder}\Sample\Android\OculusVR\app\libs folder and rename the file ovr_sdk.zip.

  2. Copy Google Oboe SDK .AAR file (oboe-1.5.0.aar) into the {sdk-root-folder}\Sample\Android\OculusVR\app\libs folder.

  3. Copy the CloudXR SDK client package, which is the CloudXR.aar file, from {sdk-root-folder}\Client\Lib\Android folder to the {sdk-root-folder}\Sample\Android\OculusVR\app\libs folder.

  4. Run Android Studio.

  5. Complete one of the following tasks:

    • Select Open existing Android Studio project on the Welcome screen.

    • Click File > Open.

  6. Navigate to {sdk-root-folder}\Sample\Android and open the OculusVR project/folder.

  7. Select Build > Make Project.

This process should generate an .apk file in the {sdk-root-folder}\Sample\Android\OculusVR\app\build\outputs\apk\debug directory that can be used to debug or be installed manually. You can also automatically generate a debug-signed .apk by directly running from within Android Studio. See Running the Oculus VR Client for more information.


To build from the command line, run gradlew build from the OculusVR folder.

Installing the Oculus VR Client


This section is only necessary should you want to manually install from command-line. If running through Android Studio, it will take care of the installation, so you can skip ahead to Running the Oculus VR Client. However, the first few steps below may be relevant if you haven’t already set up for debugging on your device.

  1. Place the Oculus VR device in developer mode and allow a USB connection in debug mode on the device.

  2. Use a USB cable to connect the Oculus VR device to the development system.

  3. If prompted on the device to allow connections, select Allow.

  4. In a Command Prompt window, navigate to the folder that contains the .apk file that was created by building the sample application.

  5. Use ADB to install the application from the release .apk file.

    adb.exe install -r <APK name>.apk


    By default, the ADB.exe program is installed by Android Studio in C:\Users\{username}\AppData\Local\Android\Sdk\platform-tools

    When the installation is complete, ADB responds with a Success message.

Running the Oculus VR Client


See Command-Line Options, for more information about command-line/launch options and a complete list of all the available options, and How to Launch on Android for the various methods for starting the application.

  1. Start SteamVR on the server system.

  2. Start the CloudXR Client app on the Oculus device.

    This process can be completed in one of the following ways:

    1. If installed from ADB with a launch options file, launch from VR on the device:

    1. Open the main menu.

    2. Select Library > Unknown Sources.

    3. Select the CloudXR Client app.

    1. If building in Android Studio, deploy/run directly.

      You can also set launch options inside the Configuration. Again, for more information on how to set launch options from Android Studio, see Command-Line Options and How to Launch on Android.


If prompted, grant any requested permissions on the device.

  1. Start the OpenVR application on the server that will be streamed to the client.

    This process can be completed in one of the following ways:

    • On the server, just launch the app directly.

    • On VR client with controllers, click Menu on the left controller to bring up the SteamVR launcher, and pick the application from that panel.


    • Launch the OpenVR application only after the client has connected to the server unless the client has been pre-configured on the server. Otherwise, the application will report that there is no connected headset. (This is because when a client first connects, it reports its specifications, such as resolution and refresh rate, to the server, at which time the server creates a virtual headset device.)

    • If the application exits immediately, ensure that you have disabled all Oculus experimental features, such as Show My Desk in VR.