USBDevice.claimInterface()

This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

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

Syntax

var promise = USBDevice.claimInterface(interfaceNumber)

Parameters

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

Return value

A promise.

Example

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

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

Specifications

Specification Status Comment
WebUSB
The definition of 'claimInterface()' in that specification.
Draft Initial definition.

Browser compatibility

FeatureChromeEdgeFirefoxInternet ExplorerOperaSafari
Basic support61 No No No48 No
FeatureAndroid webviewChrome for AndroidEdge mobileFirefox for AndroidOpera AndroidiOS SafariSamsung Internet
Basic support No61 No No48 No No

Document Tags and Contributors

Contributors to this page: jpmedley
Last updated by: jpmedley,