XRSessionEvent.session

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.

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 API
The definition of 'XRSessionEvent.session' in that specification.
Working Draft Initial definition.

Browser compatibility

BCD tables only load in the browser