WebUSB API
The USBDevice interface of the WebUSB API provides access to metadata about a paired USB device and methods for controlling it.
Instance properties
- USBDevice.configuration
- : A USBConfiguration object for the currently selected interface for a paired USB device.
- USBDevice.configurations
- : An Array of device-specific interfaces for controlling a paired USB device.
- USBDevice.deviceClass
- : One of three properties that identify USB devices for the purpose of loading a USB driver that will work with that device. The other two properties are
USBDevice.deviceSubclassandUSBDevice.deviceProtocol.
- : One of three properties that identify USB devices for the purpose of loading a USB driver that will work with that device. The other two properties are
- USBDevice.deviceProtocol
- : One of three properties that identify USB devices for the purpose of loading a USB driver that will work with that device. The other two properties are
USBDevice.deviceClassandUSBDevice.deviceSubclass.
- : One of three properties that identify USB devices for the purpose of loading a USB driver that will work with that device. The other two properties are
- USBDevice.deviceSubclass
- : One of three properties that identify USB devices for the purpose of loading a USB driver that will work with that device. The other two properties are
USBDevice.deviceClassandUSBDevice.deviceProtocol.
- : One of three properties that identify USB devices for the purpose of loading a USB driver that will work with that device. The other two properties are
- USBDevice.deviceVersionMajor
- : The major version number of the device in a semantic versioning scheme.
- USBDevice.deviceVersionMinor
- : The minor version number of the device in a semantic versioning scheme.
- USBDevice.deviceVersionSubminor
- : The patch version number of the device in a semantic versioning scheme.
- USBDevice.manufacturerName
- : The name of the organization that manufactured the USB device.
- USBDevice.opened
- : Indicates whether a session has been started with a paired USB device.
- USBDevice.productId
- : The manufacturer-defined code that identifies a USB device.
- USBDevice.productName
- : The manufacturer-defined name that identifies a USB device.
- USBDevice.serialNumber
- : The manufacturer-defined serial number for the specific USB device.
- USBDevice.usbVersionMajor
- : One of three properties that declare the USB protocol version supported by the device. The other two properties are
USBDevice.usbVersionMinorandUSBDevice.usbVersionSubminor.
- : One of three properties that declare the USB protocol version supported by the device. The other two properties are
- USBDevice.usbVersionMinor
- : One of three properties that declare the USB protocol version supported by the device. The other two properties are
USBDevice.usbVersionMajorandUSBDevice.usbVersionSubminor.
- : One of three properties that declare the USB protocol version supported by the device. The other two properties are
- USBDevice.usbVersionSubminor
- : One of three properties that declare the USB protocol version supported by the device. The other two properties are
USBDevice.usbVersionMajorandUSBDevice.usbVersionMinor.
- : One of three properties that declare the USB protocol version supported by the device. The other two properties are
- USBDevice.vendorId
- : The official usb.org-assigned vendor ID.
Instance methods
- USBDevice.claimInterface()
- : Returns a Promise that resolves when the requested interface is claimed for exclusive access.
- USBDevice.clearHalt()
- : Returns a Promise that resolves when a halt condition is cleared.
- USBDevice.controlTransferIn()
- : Returns a Promise that resolves with a USBInTransferResult when a command or status operation has been transmitted to the USB device.
- USBDevice.controlTransferOut()
- : Returns a Promise that resolves with a USBOutTransferResult when a command or status operation has been transmitted from the USB device.
- USBDevice.close()
- : Returns a Promise that resolves when all open interfaces are released and the device session has ended.
- USBDevice.forget()
- : Returns a Promise that resolves after all open interfaces are released, the device session has ended, and the permission is reset.
- USBDevice.isochronousTransferIn()
- : Returns a Promise that resolves with a USBIsochronousInTransferResult when time sensitive information has been transmitted to the USB device.
- USBDevice.isochronousTransferOut()
- : Returns a Promise that resolves with a USBIsochronousOutTransferResult when time sensitive information has been transmitted from the USB device.
- USBDevice.open()
- : Returns a Promise that resolves when a device session has started.
- USBDevice.releaseInterface()
- : Returns a Promise that resolves when a claimed interface is released from exclusive access.
- USBDevice.reset()
- : Returns a Promise that resolves when the device is reset and all app operations canceled and their promises rejected.
- USBDevice.selectAlternateInterface()
- : Returns a Promise that resolves when the specified alternative endpoint is selected.
- USBDevice.selectConfiguration()
- : Returns a Promise that resolves when the specified configuration is selected.
- USBDevice.transferIn()
- : Returns a Promise that resolves with a USBInTransferResult when bulk or interrupt data is received from the USB device.
- USBDevice.transferOut()
- : Returns a Promise that resolves with a USBOutTransferResult when bulk or interrupt data is sent to the USB device.
Specifications
Browser compatibility
来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。
