XRSession: inputsourceschange event

The inputsourceschange event is sent to an XRSession when the set of available WebXR input devices changes.

Syntax

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

addEventListener('inputsourceschange', event => { })

oninputsourceschange = event => { }

Event type

Event properties

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

added Read only

An array of zero or more XRInputSource objects, each representing an input device which has been recently connected or enabled.

removed Read only

An array of zero or more XRInputSource objects representing the input devices recently disconnected or disabled.

session Read only

The XRSession to which this input source change event is being directed.

Description

Trigger

Triggered when the set of available WebXR input devices changes.

Use cases

You can use this event to detect newly-available devices or when devices have become unavailable.

Examples

The following example shows how to set up an event handler which uses inputsourceschange events to detect newly-available pointing devices and to load their models in preparation for displaying them in the next animation frame.

xrSession.addEventListener("inputsourceschange", onInputSourcesChange);

function onInputSourcesChange(event) {
  for (let input of event.added) {
    if (input.targetRayMode == "tracked-pointer") {
      loadControllerMesh(input);
    }
  }
}

You can also add a handler for inputsourceschange events by setting the oninputsourceschange event handler:

xrSession.oninputsourceschange = onInputSourcesChange;

Specifications

Specification
WebXR Device API
# eventdef-xrsession-inputsourceschange
WebXR Device API
# dom-xrsession-oninputsourceschange

Browser compatibility

BCD tables only load in the browser