XRSession: inputsourceschange event
Limited availability
This feature is not Baseline because it does not work in some of the most widely-used browsers.
Want more browser support for this feature? Tell us why.
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.
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.
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
| Specification |
|---|
| WebXR Device API # eventdef-xrsession-inputsourceschange |
| WebXR Device API # dom-xrsession-oninputsourceschange |