XRSessionEvent: XRSessionEvent() constructor

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 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

new XRSessionEvent(type, options)

Parameters

type

A string with the name of the event. It is case-sensitive and browsers set it to end or visibilitychange.

options

An object that, in addition of the properties defined in Event(), can have the following properties:

session: The XRSession to which the event is to be delivered.

Return value

A new XRSessionEvent object representing an object of the specified type and configured as described by the options parameter.

Examples

See XRSessionEvent for example code.

Specifications

Specification
WebXR Device API # dom-xrsessionevent-xrsessionevent

Browser compatibility

Help improve MDN

Learn how to contribute

This page was last modified on ⁨Feb 5, 2024⁩ by MDN contributors.

View this page on GitHub • Report a problem with this content