XRInputSourcesChangeEvent: XRInputSourcesChangeEvent() 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 XRInputSourcesChangeEvent() constructor creates and returns a new XRInputSourcesChangeEvent object, representing an update to the list of available WebXR input devices. You won't typically call this constructor yourself, as these events are created and sent to you by the WebXR system.

Syntax

js
new XRInputSourcesChangeEvent(type, options)

Parameters

type

A string with the name of the event. It is case-sensitive and browsers always set it to inputsourceschange.

options

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

added

An array of zero or more XRInputSource objects, each representing one input device which is newly available to use.

removed

An array of zero or more XRInputSource objects representing the input devices which are no longer available.

session

The XRSession to which the event applies.

Return value

A new XRInputSourcesChangeEvent object configured based upon the input parameters provided.

Examples

The following snippet of code creates a new XRInputSourcesChangeEvent object indicating that a single new input source, described by an XRInputSource object named newInputSource, has been added to the system.

js
let iscEvent = new XRInputSourcesChangeEvent("inputsourceschange", {
  session: xrSession,
  added: [newInputSource],
  removed: [],
});

Specifications

Specification
WebXR Device API
# dom-xrinputsourceschangeevent-xrinputsourceschangeevent

Browser compatibility