USBDevice: claimInterface() method

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

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.

Note: This feature is available in Web Workers.

The claimInterface() method of the USBDevice interface returns a promise that resolves when the requested interface is claimed for exclusive access.

Syntax

js
claimInterface(interfaceNumber)

Parameters

interfaceNumber

The index of one of the interfaces supported by the device. Interfaces are device specific.

Return value

A promise.

Examples

The following example shows claimInterface() in the context of connecting to a USB device.

js
async function connectDevice(usbDevice) {
  await usbDevice.open();
  if (usbDevice.configuration === null) await usbDevice.selectConfiguration(1);
  await usbDevice.claimInterface(0);
}

Specifications

Specification
WebUSB API
# ref-for-dom-usbdevice-claiminterface②

Browser compatibility

BCD tables only load in the browser