XRSessionEvent: session property

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Secure context: This 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.

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.

js
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
WebXR Device API
# dom-xrsessionevent-session

Browser compatibility

BCD tables only load in the browser