Blueprints Reference

This section serves as a reference guide for the Blueprints in the Online Subsystem Oculus library.

To access these Blueprints, you must enable the Online Subsystem Oculus in Edit > Plugin > Online Platform.

User and Account Blueprints

• Get Device Name
  Returns the current device’s name.
• Get User Profile
  Returns current user profile.

Splash Screen Blueprints

• Add Loading Splash Screen
  Adds a splash screen with parameters to the application.
• Clear Loading Splash Screens
  Removes all splash screens from the application.
• Enable Auto-Loading Splash Screen
  Enables/disables the splash screen to be automatically shown when loading a new level.

Position and Orientation Blueprints

• Enable Orientation Tracking
  Enables or disables orientation tracking.
• Enable Position Tracking
  Enables or disables positional tracking.
• Get Base Rotation and Base Offset in Meters
  Returns the current rotation and position of the headset, with respect to the base rotation and position, expressed in meters.
• Get Pose
  Returns the orientation and position (if available) for the headset.
• Get Raw Sensor Data
  Reports raw sensor data from the headset.
• Is Device Tracked
  Determines whether or not a device (such as a controller) is being tracked by the sensors.
• Set Base Rotation and Base Offset in Meters
  Specifies the current rotation and position of the headset, with respect to the base rotation and position, expressed in apparent meters.
• Set Reorient HMD On Controller Recenter
  Sets the HMD recenter behavior.

Guardian Blueprints

• Get Guardian Dimensions
  Returns the dimensions of the Outer Boundary or the Play Area, expressed in UE4 units.
• Get Guardian Points
  Returns the points, in UE4 world space, that define the Outer Boundary or the Play Area.
• Get Node Guardian Intersection
  Returns the intersection result between a tracked device (HMD or Controller) and the Guardian boundary.
• Get Play Area Transform
  Returns the transform of the Play Area rectangle, defining it’s position, rotation, and scale to apply a unit cube to match it with the Play Area.
• Get Point Guardian Intersection
  Returns the intersection result between the Oculus Guardian boundary and a specified UE4 coordinate.
• Is Guardian Displayed
  Returns a boolean result that indicates whether or not the Outer Boundary Guardian is being displayed.
• Set Guardian Visibility
  Specifies whether or not the runtime should render the Guardian.

Dash Blueprints

• Has Input Focus
  Determines whether or not the application has input focus.
• Has System Overlay Present - DEPRECATED

Mixed Reality Blueprints

• Get Oculus MR Settings
  Returns a reference to an Oculus MR Settings object, which has properties that correspond to each of the Mixed Reality capture settings.
• Load from Ini
  Loads the Mixed Reality Capture settings from Engine.ini to an internal Oculus MR Settings object.
• Save to Ini
  Saves the Mixed Reality Capture settings from an an in-memory Oculus MR Settings object to the Engine.ini file.
• Get Tracking Reference Component and Set Tracking Reference Component
  Enables your application to add an object which the camera will follow, if you don’t want the camera to follow the first PlayerController (which is the default, and is the approach used by most applications).

Performance Optimization Blueprints

• Get Available Display Frequencies
  Returns the display frequencies that are available with the current headset.
• Get Current Display Frequency
  Returns the current display frequency for the connected HMD.
• Get GPU Frame Time
  Returns the amount of time that the GPU spent rendering the most recent frame.
• Get GPU Utilization
  Returns the CPU utilization availability and value.
• Get Tiled Multires Level
  Returns the current multi-resolution level, which applies to fixed foveated rendering.
• Set CPU and GPU Levels
  Sets the clock rates for the CPU and GPU on mobile devices.
• Set Display Frequency
  Sets the display frequency (frame rate) for Oculus Go to either 60 Hz or 72 Hz.
• Set Tiled Multires Level
  Sets the multi-resolution level for fixed foveated rendering.