C Specification

The xrSetSystemNotificationsML function is defined as:

// Provided by XR_ML_system_notifications
XrResult xrSetSystemNotificationsML(
    XrInstance                                  instance,
    const XrSystemNotificationsSetInfoML*       info);

Parameters

Parameter Descriptions

Description

This API will work only on certain SKUs. When called on an incompatible SKU the XR_ERROR_SYSTEM_NOTIFICATION_INCOMPATIBLE_SKU_ML error must be returned.

If the com.magicleap.permission.SYSTEM_NOTIFICATION permission is not granted, the runtime must return XR_ERROR_SYSTEM_NOTIFICATION_PERMISSION_DENIED_ML.

Valid Usage (Implicit)
Return Codes
On success, this command returns

  • XR_SUCCESS

On failure, this command returns

  • XR_ERROR_FUNCTION_UNSUPPORTED

  • XR_ERROR_VALIDATION_FAILURE

  • XR_ERROR_RUNTIME_FAILURE

  • XR_ERROR_HANDLE_INVALID

  • XR_ERROR_INSTANCE_LOST

  • XR_ERROR_SYSTEM_NOTIFICATION_PERMISSION_DENIED_ML

  • XR_ERROR_SYSTEM_NOTIFICATION_INCOMPATIBLE_SKU_ML

See Also

XR_ML_system_notifications, XrInstance, XrSystemNotificationsSetInfoML

Document Notes

For more information, see the OpenXR Specification

This page is extracted from the OpenXR Specification. Fixes and changes should be made to the Specification, not directly.

Copyright

Copyright 2014-2025 The Khronos Group Inc.

This work is licensed under a Creative Commons Attribution 4.0 International License.