XRSessionEvent

{{APIRef("WebXR Device API")}}{{SecureContext_Header}}

The WebXR Device API's XRSessionEvent interface describes an event which indicates the change of the state of an {{domxref("XRSession")}}. These events occur, for example, when the session ends or the visibility of its context changes.

{{InheritanceDiagram}}

Constructor

• {{domxref("XRSessionEvent.XRSessionEvent", "XRSessionEvent()")}}
  • : Creates and returns a new XRSessionEvent object.

Instance properties

In addition to properties inherited from its parent interface, {{domxref("Event")}}, XRSessionEvent provides the following:

• {{domxref("XRSessionEvent.session", "session")}} {{ReadOnlyInline}}
  • : The {{domxref("XRSession")}} to which the event refers.

Instance methods

While XRSessionEvent defines no methods, it inherits methods from its parent interface, {{domxref("Event")}}.

Session event types

The following events are represented using the XRSessionEvent interface, and are permitted values for its type property.

• {{domxref("XRSession.end_event", "end")}}
  • : Fired at the session when it has ended, after being terminated by the application or the {{Glossary("user agent")}}.
• {{domxref("XRSession.visibilitychange_event", "visibilitychange")}}
  • : Fired at the session whenever its visibility state changes.

Examples

This example creates a listener that watches for the visibility state of the session to change. It reacts by calling a function mySessionVisible() with a Boolean indicating whether or not the session is visible; this function might, for instance, spin up or reconfigure a worker that handles rendering the scene.

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

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}