MDN self-hosted library · e01.org

XRSession: inputsourceschange event

WebXR Device API

WebXR Device API

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

Syntax

Use the event name in addEventListener():

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

Alternatively, assign to the event handler property of the interface:

oninputsourceschange = (event) => { }

Event type

An XRInputSourcesChangeEvent. Inherits from Event.

XRInputSourcesChangeEvent

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 (const 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 (but note that this replaces other event listeners added using oninputsourceschange, if any):

xrSession.oninputsourceschange = onInputSourcesChange;

Specifications

Browser compatibility