USBDevice.claimInterface()

Experimental

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

BCD tables only load in the browser