XRPermissionDescriptor

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

User permissions in the WebXR 设备 API are managed using the 权限 API . To that end, the XRPermissionDescriptor dictionary is used to describe the WebXR features the app needs to use, as well as those features it would like ot use if permision is granted.

XRPermissionDescriptor 's name must be set to xr in order to direct the Permissions API to correctly handle the request as applying to WebXR.

特性

In addition to inheriting the properties of the parent interface, PermissionDescriptor , XRPermissionDescriptor provides the following properties.

mode
An XRSessionMode value indicating the XR mode ( inline , immersive-vr ,或 immersive-ar ) for which the permissions are requested.
optionalFeatures
An array of strings, each specifying the name of a WebXR feature which is requested but not required for the app to function. The available features are the same as those used by XRSessionInit ; see Default features in XRSessionInit for further information.
requiredFeatures
An array of strings giving the names of the WebXR features for which permission must be obtained in order to use your app or site.

范例

The example below demonstrates performing the permission request for an application that requires the local-floor reference space in an immersive-vr environment.

权限 API is found to be available (by checking to see if navigator.permissions is defined), its query() method is called, specifying the permission descriptor we've established, xrPermissionDesc .

When the returned promise resolves, we check the returned status. If permission has been granted, we call a function setupXR() that handles preparing the WebXR environment for use. If permission is conditional based on prompting, we call a function promptAndSetupXR() that would handle asking for permission before enabling and starting up the environment. And for any other returned state—which is almost certainly denied , which is the only other option as of this article's writing—we do nothing, since we can't use WebXR.

If the permission request promise is rejected, the error is handled (currently by just dumping it to the console using domxref("console.log()")}}).

If the Permissions API isn't available at all, this example simply assumes that WebXR will report an appropriate error if permission isn't available, and tries to start up the WebXR session using the same setupXR() function called by the granted case.

let xrPermissionDesc = {
  name: "xr",
  mode: "immersive-vr",
  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();
}
					

规范

规范 状态 Comment
WebXR 设备 API
The definition of 'XRPermissionDescriptor' in that specification.
工作草案 初始定义。

浏览器兼容性

更新 GitHub 上的兼容性数据
Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari Android webview Chrome for Android Firefox for Android Opera for Android Safari on iOS Samsung Internet
XRPermissionDescriptor Chrome No Edge No Firefox No IE No Opera No Safari No WebView Android No Chrome Android No Firefox Android No Opera Android No Safari iOS No Samsung Internet Android No
mode Chrome No Edge No Firefox No IE No Opera No Safari No WebView Android No Chrome Android No Firefox Android No Opera Android No Safari iOS No Samsung Internet Android No
optionalFeatures Chrome No Edge No Firefox No IE No Opera No Safari No WebView Android No Chrome Android No Firefox Android No Opera Android No Safari iOS No Samsung Internet Android No
requiredFeatures Chrome No Edge No Firefox No IE No Opera No Safari No WebView Android No Chrome Android No Firefox Android No Opera Android No Safari iOS No Samsung Internet Android No

图例

不支持
不支持

另请参阅