XRPermissionDescriptor.requiredFeatures - Web APIs 编辑

Secure context

This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

The XRPermissionDescriptor dictionary's requiredFeatures property should be set prior to calling navigator.permissions.query() to a list of WebXR features which must be supported for the app to work. This ensures that permissions are checked as applicable to ensure that those features are available upon request.

Syntax

xrPermissionDescriptor = {
   mode: xrSessionMode,
   requiredFeatures: reqFeatureList,
   optionalFeatures: optFeatureList
};

xrPermissionDescriptor.requiredFeatures = reqFeatureList;
reqFeatureList = xrPermissionDescriptor.requiredFeatures;

Value

An array of strings indicating the WebXR features which must be available for use by the app or site. The permissions check will be performed in such a manner as to verify that all features in the list are available for use with the user's permission.

Currently, all features are members of the XRReferenceSpaceType enumerated type, indicating the reference space types that your app would like permission to use, but can operate without. Future editions of WebXR may add more recognized features.

The permitted values are:

The types of reference space are listed in the table below, with brief information about their use cases and which interface is used to implement them.

Usage notes

Examples

In this example, permissions are checked to ensure that the user has granted permission for the site or app to use immersive augmented reality mode with the local-floor reference space (presumably since the user is unlikely to start to fly).

let xrPermissionDesc = {
  name: "xr",
  mode: "immersive-ar",
  requiredFeatures: [ "local-floor" ]
};

if (navigator.permissions) {
  navigator.permissions.query(xrPermissionDesc).then(({state}) => {
    switch(state) {
      case "granted":
        setupXR();
        break;
      case "prompt":
        promptAndSetupXR();
        break;
      default:
        /* do nothing otherwise */
       break;
  }
  .catch(err) {
    console.log(err);
  }
} else {
  setupXR();
}

Specifications

Browser compatibility

BCD tables only load in the browser

See also

• Permissions and security for WebXR
• XRPermissionStatus
• navigator.permissions and WorkerNavigator.permissions
• Permissions