XRSession: end event

Limited availability

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

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

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

An end event is fired at an XRSession object when the WebXR session has ended, either because the web application has chosen to stop the session, or because the user agent terminated the session.

Syntax

Use the event name in methods like addEventListener(), or set an event handler property.

js
addEventListener("end", (event) => {});

onend = (event) => {};

Event type

An XRSessionEvent. Inherits from Event.

Event XRSessionEvent

Event properties

In addition to the properties listed below, properties from the parent interface, Event, are available.

session Read only

The XRSession to which the event refers.

Description

Trigger

Triggered when the WebXR session has ended, either because the web application has chosen to stop the session, or because the user agent terminated the session.

This event is not cancelable and does not bubble.

Use cases

You can use this event to react to the ending of an WebXR session. You may want to display a UI element informing about the termination of the session, for example.

Examples

To be informed when a WebXR session comes to an end, you can add a handler to your XRSession instance using addEventListener(), like this:

js
XRSession.addEventListener("end", (event) => {
  /* the session has shut down */
});

Alternatively, you can use the XRSession.onend event handler property to establish a handler for the end event:

js
XRSession.onend = (event) => {
  /* the session has shut down */
};

Specifications

Specification
WebXR Device API
# eventdef-xrsession-end
WebXR Device API
# dom-xrsession-onend

Browser compatibility

BCD tables only load in the browser