Web/API/XRSessionEvent/session

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

The read-only XRSessionEvent interface's session property indicates which XRSession the event is about.

Syntax

xrSession = xrSessionEvent.session;

Value

An XRSession object indicating which WebXR session the event refers to.

Examples

In this example, the session property is used to obtain the session object to manage when an event is received.

xrSession.addEventListener("visibilitychange", e => {
  switch(e.session.visibilityState) {
    case "hidden":
      myEnableRendering(true);
      break;
    case "visible":
    case "visible-blurred":
      myEnableRendering(false);
      break;
  }
});

This calls a function that reacts to the session's visibility state change.

Specifications

Specification	Status	Comment
WebXR Device APIThe definition of 'XRSessionEvent.session' in that specification.	Working Draft	Initial definition.

Browser compatibility

The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.

Update compatibility data on 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
session	Chrome Full support 79	Edge Full support 79	Firefox No support No	IE No support No	Opera No support No	Safari No support No	WebView Android No support No	Chrome Android Full support 79	Firefox Android No support No	Opera Android No support No	Safari iOS No support No	Samsung Internet Android Full support 11.2

Legend

Full support  

Full support

No support  

No support

XRSessionEvent.session by Mozilla Contributors is licensed under CC-BY-SA 2.5.