XRSystem: isSessionSupported()

在此页

句法
范例
规范
浏览器兼容性
相关话题

XRSystem 方法 isSessionSupported() returns a promise which resolves to true if the specified WebXR session mode is supported by the user's WebXR device. Otherwise, the promise resolves with false .

If the no devices are available or the browser doesn't have permission to use the XR device, the promise is rejected with an appropriate DOMException .

句法

var isSupportedPromise = xr.isSessionSupported(xrSessionMode)

参数

xrSessionMode: DOMString specifying the WebXR session mode for which support is to be checked. This string must be one of inline (to present the WebXR content inline within the context of an HTML document) or immersive-vr for a fully-immersive virtual experience.

返回值

A Promise that resolves to true if the specified session mode is supported; otherwise the promise resolves to false .

异常

Rather than throwing true exceptions, isSessionSupported() rejects the returned promise, passing to the rejection handler a DOMException whose 名称 is one of the following strings.

SecurityError: The document's origin does not have permission to use the xr-spatial-tracking feature policy .

范例

In this example, we see isSessionSupported() used to detect whether or not the device supports VR mode by checking to see if an immersive-vr session is supported. If it is, we set up a button to read "Enter XR", to call a method onButtonClicked() , and enable the button.

If no session is already underway, we request the VR session and, if successful, set up the session in a method called onSessionStarted() , not shown. If a session is already underway when the button is clicked, we call the xrSession 对象的 end() method to shut down the WebXR session.

if (navigator.xr) {
  navigator.xr.isSessionSupported('immersive-vr')
  .then((isSupported) => {
    if (isSupported) {
      userButton.addEventListener('click', onButtonClicked);
      userButton.innerHTML = 'Enter XR';
      userButton.disabled = false;
    }
  });
}
function onButtonClicked() {
  if (!xrSession) {
    navigator.xr.requestSession('immersive-vr')
    .then((session) => {
      xrSession = session;
      // onSessionStarted() not shown for reasons of brevity and clarity.
      onSessionStarted(xrSession);
    });
  } else {
    // Button is a toggle button.
    xrSession.end();
  }
}

规范

规范	状态	注释
WebXR 设备 API The definition of 'isSessionSupported()' in that specification.	工作草案	初始定义。

浏览器兼容性

更新 GitHub 上的兼容性数据

	桌面						移动
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	Android webview	Chrome for Android	Firefox for Android	Opera for Android	Safari on iOS	Samsung Internet
`isSessionSupported()`	Chrome 79	Edge 79	Firefox 不支持 No	IE 不支持 No	Opera 不支持 No	Safari 不支持 No	WebView Android 不支持 No	Chrome Android 79	Firefox Android 不支持 No	Opera Android 不支持 No	Safari iOS 不支持 No	Samsung Internet Android 11.2

图例

完整支持
不支持
实验。期望将来行为有所改变。

元数据

最后修改： Feb 10, 2020

WebXR 设备 API
XRSystem
方法
1. XRSystem: isSessionSupported()
2. XRSystem: requestSession()
Related pages for WebXR Device API

在此页

句法

参数

返回值

异常

范例

规范

浏览器兼容性

图例

相关话题