Develop

Get Oculus MR Settings

Updated: Apr 15, 2026

Returns a pointer to a UOculusXRMR_Settings object for configuring Mixed Reality Capture (MRC) properties at runtime.

Overview

This function is generally the starting point for configuring the MRC pipeline. Call GetOculusXRMRSettings() in UOculusXRMRFunctionLibrary to obtain the settings object, then read or modify the properties listed below before saving them back to disk.

This function works in conjunction with Load from Ini and Save to Ini, which load and save the contents of the Oculus MR Settings object to and from the Engine.ini file.

Blueprint

Arguments

No arguments.

Output

Return Value: The Return Value is a pointer to a UOculusXRMR_Settings object with the following properties:

bIsCasting (GetIsCasting/SetIsCasting) - Turns MRC on and off (does not get saved to or loaded from ini).

CompositionMethod (GetCompositionMethod/SetCompositionMethod)

ExternalComposition (default): The casting window includes the background and foreground view.

DirectComposition (deprecated): The game scene is composited with the camera frame directly.

BindToTrackedCameraIndex (BindToTrackedCameraIndexIfAvailable/GetBindToTrackedCameraIndex) - Index of the calibrated external camera that the in-game MRC camera should be bound to.

ClippingReference - Specifies the distance from the camera to the MRC casting background/foreground boundary. Set to CR_TrackingReference to use the distance to the Tracking Reference (recommended for stationary experiences). Set to CR_Head to use the distance to the HMD (default, recommended for roomscale experiences).

bUseTrackedCameraResolution - If true, the casting viewports use the same resolution as the camera used in the calibration process.

WidthPerView - When bUseTrackedCameraResolution is false, sets the width of each casting viewport (foreground, background, or direct composition).

HeightPerView - When bUseTrackedCameraResolution is false, sets the height of each casting viewport (foreground, background, or direct composition).

CastingLatency - When CompositionMethod is set to ExternalComposition, sets the latency of the casting output. This setting may be used to help sync with the camera latency in the external composition application.

BackdropColor - When CompositionMethod is set to ExternalComposition, sets the color of the backdrop in the foreground view.

ExternalCompositionPostProcessEffects - When CompositionMethod is set to ExternalComposition, sets the amount of post-process effects shown in the MRC output. PPE_Off disables all post-process effects. PPE_On enables post-process effects, but may cause visual inaccuracy.

Deprecated properties

The following properties are deprecated and may be removed in a future version of the Meta XR Plugin:

CapturingCamera (deprecated) - Previously indicated which physical camera device provides the video frame for Direct Composition. The getter always returns CD_None_DEPRECATED and the setter is a no-op.

HandPoseStateLatency (deprecated) - Previously added a delay in seconds to the tracked controllers in the composited scene to correct for camera latency. Deprecated along with Direct Composition.

ChromaKeyColor (deprecated) - Previously specified the approximate color of the green screen as a compositing reference.

ChromaKeySimilarity (deprecated) - Previously controlled the color distance threshold for hiding pixels matching the chroma key color.

ChromaKeySmoothRange (deprecated) - Previously defined a range of color distance in which video frame pixels rendered as semi-transparent.

ChromaKeySpillRange (deprecated) - Previously defined a range of color distance in which video frame pixels were desaturated to reduce green edges.

Sample

This sample shows how to use Get Oculus MR Settings in conjunction with several related Blueprint functions. The graph retrieves the MRC settings object, loads values from the ini file, and saves updated settings back.