Develop
Develop
Select your platform

Oculus Integration SDK (Legacy)

Download
Updated: May 31, 2024|
Version
Select your version
Oculus Integration SDK has been replaced by Meta XR UPM packages as of v59. Please download the UPM packages instead. The latest Oculus Integration SDK for Unity packages OVRPlugin, Interaction SDK (Experimental), Platform SDK, Voice SDK, Audio SDK, and Lipsync SDK.

Version 57.2 Release Notes

Oculus Integration SDK has been replaced by Meta XR UPM packages as of v59. For v59 and above, please download the UPM packages instead. More details here.

57.2 - Release Notes

The 57.2 update adds more information regarding the deprecation of this package (Oculus Integration SDK), and information on how to migrate to Meta XR UPM packages.

57.0 - Release Notes


The Oculus Integration SDK for Unity provides support to develop Oculus apps in Unity. The SDK v57.0 comes bundled with the
  • OVRPlugin 1.89.0
  • Audio SDK 47.0
  • Platform SDK 57.0
  • Lipsync SDK 29.0
  • Voice SDK 57.0
  • Interaction SDK 57.0
  • What's New


    Tools
  • **Building Blocks : **A new experimental tool designed to help easily discover and add XR features like Passthrough, hand tracking, and much more into a scene.
  • **Oculus Status Icon : **The status icon, previously redirecting to the Project Setup Tool now expands to a menu for quick access to tools such as Building Blocks and the Project Setup Tool. Additionally, a colored indicator turns red when the Project Setup Tool detects issues in the project.

  • InteractionSDK
  • Building Block support has been added for these 5 Interaction SDK use cases: Grabbable Item, Throwable Item, Pointable Item with Hand Ray, Pokeable Item with Poke Limiting, and Synthetic Hands. Developers can drag and drop the block into their project via the Building Blocks browser.
  • The Palm Menu prefab has been added to showcase a pokeable panel menu that uses the off hand’s palm as a physical backstop for poke interactions. A demo of this prefab can be found in the Poke Examples sample scene.
  • If your HandGrabPose uses a surface, the hand can slide along it even while grabbing. Consider this feature for handrails, levers and other grabbables attached to the world. You can define if the hand always slides or only when loosely grabbing.
  • The new InteractorGroupDebugTree allows developers to visually debug a hierarchy of InteractorGroups. Attach it to the root InteractorGroup and see in runtime the state of all sub-Interactors.

  • Scene
  • Added a new runtime permission for Scene spatial data which gives the user control over whether an app can access anchor data. If a user denies this permission, then all Scene functions return 0 anchors. In addition to adding “com.oculus.permission.USE_SCENE” in the Android Manifest, apps will have to query and request this permission at runtime using Unity’s Android Permission API. Alternatively, OVRManager (commonly a component on the OVRCameraRig) contains a helper checkbox which will request the runtime permission on app start (Permission Requests On Startup > Scene), and a field for adding the manifest permission (Quest Features > Scene Support).
  • Added two new semantic classification labels to the OVRSceneManager: GLOBAL_MESH and INVISIBLE_WALL_FACE (wall faces added by the system during Space Setup to enclose a space).
  • Added a new component OVRSceneVolumeMeshFilter to access triangle mesh data on scene anchors.
  • The property OVRSceneManager.initialAnchorParent is now exposed in the inspector UI
  • What's Fixed


    Oculus Utilities / OVRPlugin
  • The Oculus Status Icon is not jumping left or right on the status bar anymore in Unity 2022+.
  • The Oculus Status Icon doesn’t disappear anymore when changing Unity’s Layout.

  • InteractionSDK
  • InteractorGroups now work properly when the active sub-interactor gets Disabled externally.

  • Virtual Keyboard
  • Sample Scene now handles System Keyboard being enabled
  • Suggestions now properly truncate in the middle if the word extends beyond button width
  • Ghost/empty suggestion no longer appears
  • Improvements


    InteractionSDK
  • Disabling an Interactor Component now disables the Interactor entirely as if the Optional IActiveState was set to false

  • Virtual Keyboard
  • Readout bar is added to the keyboard providing a convenient copy of the given text context
  • Increased # of suggestions for swipe / typeahead from 3 to 4
  • Keyboard Events are now exposed as Unity Events; you can bind to them in the editor inspector
  • OVRManager will warn developers using both System Keyboard and Virtual Keyboard
  • Reduced overall memory footprint
  • Improvements to swipe typing activations
  • Improvements to key collisions, preventing gutter key misses
  • Known Issues

  • The Virtual Furniture scene in the Sample Framework only loads specified labels: if there is wall art or a screen in the scene, then these will not be shown. Many of the Scene Manager samples also do not support Single Pass Instancing and Multiview stereo rendering modes.
  • OverlayShape.FishEye is not supported through OpenXR. The workaround is to replace it with another OverlayShape, e.g. Equirect or Cubemap.
  • Fixed Foveated Rendering will not work if both the OpenXR Plugin and the Oculus XR Plugin are in the project, but only the Oculus XR Plugin is used as the active loader. Remove the UNITY_OPENXR_1_5_3 define from the Oculus.VR asmdef to prevent the Meta XR Foveation feature from being used when the Oculus XR Plugin is active.
  • Link Known Issues

  • Screen recordings or captures are black when running a Passthrough-enabled app over Link.