W3cubDocs

/DOM

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 compatibilityUpdate compatibility data on GitHub

Desktop
Chrome Edge Firefox Internet Explorer Opera Safari
Basic support 61 No No No 48 No
Mobile
Android webview Chrome for Android Edge Mobile Firefox for Android Opera for Android iOS Safari Samsung Internet
Basic support No 61 No No 48 No No

© 2005–2018 Mozilla Developer Network and individual contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/USBDevice/claimInterface