Web/API/USBDevice/claimInterface

This is an experimental technologyCheck 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
WebUSBThe definition of 'claimInterface()' in that specification.	Draft	Initial definition.

Browser compatibility

The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.

Update compatibility data on GitHub

	Desktop						Mobile
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	Android webview	Chrome for Android	Firefox for Android	Opera for Android	Safari on iOS	Samsung Internet
claimInterface Experimental'	Chrome Full support 61	Edge Full support 79	Firefox No support No	IE No support No	Opera Full support 48	Safari No support No	WebView Android No support No	Chrome Android Full support 61	Firefox Android No support No	Opera Android Full support 45	Safari iOS No support No	Samsung Internet Android Full support 8.0

Legend

Full support  

Full support

No support  

No support

Experimental. Expect behavior to change in the future.'

Experimental. Expect behavior to change in the future.

USBDevice.claimInterface() by Mozilla Contributors is licensed under CC-BY-SA 2.5.