chrome.usb

Properties

• active

  boolean

  Since Chrome 47.

  Is this the active configuration?

• configurationValue

  number

  The configuration number.

• description

  string optional

  Description of the configuration.

• extra_data

  ArrayBuffer

  Extra descriptor data associated with this configuration.

• interfaces

  InterfaceDescriptor[]

  Available interfaces.

• maxPower

  number

  The maximum power needed by this device in milliamps (mA).

• remoteWakeup

  boolean

  The device supports remote wakeup.

• selfPowered

  boolean

  The device is self-powered.

Properties

• handle

  number

  An opaque handle representing this connection to the USB device and all associated claimed interfaces and pending transfers. A new handle is created each time the device is opened. The connection handle is different from Device.device.

• productId

  number

  The product ID.

• vendorId

  number

  The device vendor ID.

Properties

• data

  ArrayBuffer optional

  The data to transmit (required only by output transfers).

• direction

  Direction

  The transfer direction ("in" or "out").

• index

  number

  The wIndex field, see Ibid.

• length

  number optional

  The maximum number of bytes to receive (required only by input transfers).

• recipient

  Recipient

  The transfer target. The target given by index must be claimed if "interface" or "endpoint".

• request

  number

  The bRequest field, see Universal Serial Bus Specification Revision 1.1 § 9.3.

• requestType

  RequestType

  The request type.

• timeout

  number optional

  Since Chrome 43.

  Request timeout (in milliseconds). The default value 0 indicates no timeout.

• value

  number

  The wValue field, see Ibid.

Properties

• device

  number

  An opaque ID for the USB device. It remains unchanged until the device is unplugged.

• manufacturerName

  string

  Since Chrome 46.

  The iManufacturer string read from the device, if available.

• productId

  number

  The product ID.

• productName

  string

  Since Chrome 46.

  The iProduct string read from the device, if available.

• serialNumber

  string

  Since Chrome 46.

  The iSerialNumber string read from the device, if available.

• vendorId

  number

  The device vendor ID.

• version

  number

  Since Chrome 51.

  The device version (bcdDevice field).

Properties

• interfaceClass

  number optional

  USB interface class, matches any interface on the device.

• interfaceProtocol

  number optional

  USB interface protocol, checked only if the interface sub-class matches.

• interfaceSubclass

  number optional

  USB interface sub-class, checked only if the interface class matches.

• productId

  number optional

  Device product ID, checked only if the vendor ID matches.

• vendorId

  number optional

  Device vendor ID.

Properties

• filters

  DeviceFilter[] optional

  Filter the list of devices presented to the user. If multiple filters are provided devices matching any filter will be displayed.

• multiple

  boolean optional

  Allow the user to select multiple devices.

Properties

• address

  number

  Endpoint address.

• direction

  Direction

  Transfer direction.

• extra_data

  ArrayBuffer

  Extra descriptor data associated with this endpoint.

• maximumPacketSize

  number

  Maximum packet size.

• pollingInterval

  number optional

  Polling interval (interrupt and isochronous only).

• synchronization

  SynchronizationType optional

  Transfer synchronization mode (isochronous only).

• type

  TransferType

  Transfer type.

• usage

  UsageType optional

  Endpoint usage hint.

Properties

• interfaceId

  number optional

  The interface ID to request access to. Only available on Chrome OS. It has no effect on other platforms.

• productId

  number

  The product ID.

• vendorId

  number

  The device vendor ID.

Properties

• filters

  DeviceFilter[] optional

  A device matching any given filter will be returned. An empty filter list will return all devices the app has permission for.

• productId

  number optional

  Deprecated. Equivalent to setting DeviceFilter.productId.

• vendorId

  number optional

  Deprecated. Equivalent to setting DeviceFilter.vendorId.

Properties

• data

  ArrayBuffer optional

  The data to transmit (required only by output transfers).

• direction

  Direction

  The transfer direction ("in" or "out").

• endpoint

  number

  The target endpoint address. The interface containing this endpoint must be claimed.

• length

  number optional

  The maximum number of bytes to receive (required only by input transfers).

• timeout

  number optional

  Since Chrome 43.

  Request timeout (in milliseconds). The default value 0 indicates no timeout.

Properties

• alternateSetting

  number

  The interface alternate setting number (defaults to 0</code).

• description

  string optional

  Description of the interface.

• endpoints

  EndpointDescriptor[]

  Available endpoints.

• extra_data

  ArrayBuffer

  Extra descriptor data associated with this interface.

• interfaceClass

  number

  The USB interface class.

• interfaceNumber

  number

  The interface number.

• interfaceProtocol

  number

  The USB interface protocol.

• interfaceSubclass

  number

  The USB interface sub-class.

Properties

• packetLength

  number

  The length of each of the packets in this transfer.

• packets

  number

  The total number of packets in this transfer.

• transferInfo

  GenericTransferInfo

  Transfer parameters. The transfer length or data buffer specified in this parameter block is split along packetLength boundaries to form the individual packets of the transfer.

Properties

• data

  ArrayBuffer optional

  The data returned by an input transfer. undefined for output transfers.

• resultCode

  number optional

  A value of 0 indicates that the transfer was a success. Other values indicate failure.

Enum

Enum

Enum

Enum

Enum

Enum

Parameters

• handle

  ConnectionHandle

  An open connection to the device.

• transferInfo

  GenericTransferInfo

  The transfer parameters.

• callback

  function

  The callback parameter should be a function that looks like this:

  (info: TransferResultInfo) => {...}

  • info

    TransferResultInfo

Parameters

• handle

  ConnectionHandle

  An open connection to the device.

• interfaceNumber

  number

  The interface to be claimed.

• callback

  function

  The callback parameter should be a function that looks like this:

  () => {...}

Parameters

• handle

  ConnectionHandle

  The ConnectionHandle to close.

• callback

  function

  The callback parameter should be a function that looks like this:

  () => {...}

Parameters

• handle

  ConnectionHandle

  An open connection to the device.

• transferInfo

  ControlTransferInfo
• callback

  function

  The callback parameter should be a function that looks like this:

  (info: TransferResultInfo) => {...}

  • info

    TransferResultInfo

Parameters

• options

  EnumerateDevicesAndRequestAccessOptions

  The properties to search for on target devices.

• callback

  function

  The callback parameter should be a function that looks like this:

  (handles: ConnectionHandle[]) => {...}

  • handles

    ConnectionHandle[]

Parameters

• handle

  ConnectionHandle

  An open connection to the device.

• callback

  function

  The callback parameter should be a function that looks like this:

  (config: ConfigDescriptor) => {...}

  • config

    ConfigDescriptor

Parameters

• device

  Device

  The Device to fetch descriptors from.

• callback

  function

  The callback parameter should be a function that looks like this:

  (configs: ConfigDescriptor[]) => {...}

  • configs

    ConfigDescriptor[]

Parameters

• options

  EnumerateDevicesOptions

  The properties to search for on target devices.

• callback

  function

  The callback parameter should be a function that looks like this:

  (devices: Device[]) => {...}

  • devices

    Device[]

Parameters

• options

  DevicePromptOptions

  Configuration of the device picker dialog box.

• callback

  function

  Invoked with a list of chosen Devices.

  The callback parameter should be a function that looks like this:

  (devices: Device[]) => {...}

  • devices

    Device[]

Parameters

• handle

  ConnectionHandle

  An open connection to the device.

• transferInfo

  GenericTransferInfo

  The transfer parameters.

• callback

  function

  The callback parameter should be a function that looks like this:

  (info: TransferResultInfo) => {...}

  • info

    TransferResultInfo

Parameters

• handle

  ConnectionHandle

  An open connection to the device.

• transferInfo

  IsochronousTransferInfo
• callback

  function

  The callback parameter should be a function that looks like this:

  (info: TransferResultInfo) => {...}

  • info

    TransferResultInfo

Parameters

• handle

  ConnectionHandle

  An open connection to the device.

• callback

  function

  The callback parameter should be a function that looks like this:

  (descriptors: InterfaceDescriptor[]) => {...}

  • descriptors

    InterfaceDescriptor[]

Parameters

• device

  Device

  The Device to open.

• callback

  function

  The callback parameter should be a function that looks like this:

  (handle: ConnectionHandle) => {...}

  • handle

    ConnectionHandle

Parameters

• handle

  ConnectionHandle

  An open connection to the device.

• interfaceNumber

  number

  The interface to be released.

• callback

  function

  The callback parameter should be a function that looks like this:

  () => {...}

Parameters

• device

  Device

  The Device to request access to.

• interfaceId

  number

  The particular interface requested.

• callback

  function

  The callback parameter should be a function that looks like this:

  (success: boolean) => {...}

  • success

    boolean

Parameters

• handle

  ConnectionHandle

  A connection handle to reset.

• callback

  function

  The callback parameter should be a function that looks like this:

  (success: boolean) => {...}

  • success

    boolean

Parameters

• handle

  ConnectionHandle

  An open connection to the device.

• configurationValue

  number
• callback

  function

  The callback parameter should be a function that looks like this:

  () => {...}

Parameters

• handle

  ConnectionHandle

  An open connection to the device where this interface has been claimed.

• interfaceNumber

  number

  The interface to configure.

• alternateSetting

  number

  The alternate setting to configure.

• callback

  function

  The callback parameter should be a function that looks like this:

  () => {...}

Event

• listener

  function

  The listener parameter should be a function that looks like this:

  (device: Device) => {...}

  • device

    Device

Event

• listener

  function

  The listener parameter should be a function that looks like this:

  (device: Device) => {...}

  • device

    Device