XRSessionEvent()

The WebXR Device API's XRSessionEvent() constructor creates and returns a new XRSessionEvent object. These objects represent events announcing state changes in an XRSession representing an augmented or virtual reality session.

Syntax

newXRSessionEvent = new XRSessionEvent(type, eventInitDict);

Parameters

type

A DOMString indicating which of the events represented by objects of type XRSessionEvent this particular object represents. See Event types for a list of the permitted values.

eventInitDict

An object conforming to the XRSessionEventInit dictionary which contains values to be applied to the newly-created event object. Permitted values are:

session

The XRSession to which the event is to be delivered.

Return value

A newly-created XRSessionEvent object representing an object of the specfied type and configured as described by the eventInitDict parameter.

Event types

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

end

Fired at the session when it has ended, after being terminated by the application or the user agent.

visibilitychange

Fired at the session whenever its visibility state changes.

Examples

This example creates a listiener 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("visibilitystate", e => {
  switch(e.session.visibilitystate) {
    case "visible":
    case "visible-blurred":
      mySessionVisible(true);
      break;
    case "hidden":
      mySessionVisible(false);
      break;
  }
});

Specifications

Browser compatibility