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
newInputSourcesChangeEvent = new XRInputSourcesChangeEvent(type, eventInitDict);
Parameters
type
- A
DOMString
indicating the type of event which has occurred. This string must always beinputsourceschange
. eventInitDict
- An object conforming to the
XRInputSourcesChangeEventInit
dictionary, prodividing the initial values for the event.
Return value
A newly-created XRInputSourcesChangeEvent
object configured based upon
the input parameters provided.
Event types
inputsourceschange
- Delivered to the
XRSession
when the set of input devices available to it changes.
Example
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.
let iscEvent = new XRInputSourcesChangeEvent("inputsourceschange", { session: xrSession,
added: [newInputSource], removed: [] });
Specifications
Specification | Status | Comment |
---|---|---|
WebXR Device API The definition of 'XRInputSourcesChangeEvent()' in that specification. |
Working Draft | Initial definition. |
Browser compatibility
BCD tables only load in the browser