Android APIs
public class

UsbConfiguration

extends Object
implements Parcelable
java.lang.Object
   ↳ android.hardware.usb.UsbConfiguration

Class Overview

A class representing a configuration on a UsbDevice. A USB configuration can have one or more interfaces, each one providing a different piece of functionality, separate from the other interfaces. An interface will have one or more UsbEndpoints, which are the channels by which the host transfers data with the device.

Developer Guides

For more information about communicating with USB hardware, read the USB developer guide.

Summary

[Expand]
Inherited Constants
From interface android.os.Parcelable
Fields
public static final Creator<UsbConfiguration> CREATOR
Public Methods
int describeContents()
Describe the kinds of special objects contained in this Parcelable's marshalled representation.
int getId()
Returns the configuration's ID field.
UsbInterface getInterface(int index)
Returns the UsbInterface at the given index.
int getInterfaceCount()
Returns the number of UsbInterfaces this configuration contains.
int getMaxPower()
Returns the configuration's max power consumption, in milliamps.
String getName()
Returns the configuration's name.
boolean isRemoteWakeup()
Returns the remote-wakeup attribute value configuration's attributes field.
boolean isSelfPowered()
Returns the self-powered attribute value configuration's attributes field.
String toString()
Returns a string containing a concise, human-readable description of this object.
void writeToParcel(Parcel parcel, int flags)
Flatten this object in to a Parcel.
[Expand]
Inherited Methods
From class java.lang.Object
From interface android.os.Parcelable

Fields

public static final Creator<UsbConfiguration> CREATOR

Public Methods

public int describeContents ()

Describe the kinds of special objects contained in this Parcelable's marshalled representation.

Returns
  • a bitmask indicating the set of special object types marshalled by the Parcelable.

public int getId ()

Returns the configuration's ID field. This is an integer that uniquely identifies the configuration on the device.

Returns
  • the configuration's ID

public UsbInterface getInterface (int index)

Returns the UsbInterface at the given index.

Returns
  • the interface

public int getInterfaceCount ()

Returns the number of UsbInterfaces this configuration contains.

Returns
  • the number of endpoints

public int getMaxPower ()

Returns the configuration's max power consumption, in milliamps.

Returns
  • the configuration's max power

public String getName ()

Returns the configuration's name.

Returns
  • the configuration's name

public boolean isRemoteWakeup ()

Returns the remote-wakeup attribute value configuration's attributes field. This attributes that the device may signal the host to wake from suspend.

Returns
  • the configuration's remote-wakeup attribute

public boolean isSelfPowered ()

Returns the self-powered attribute value configuration's attributes field. This attribute indicates that the device has a power source other than the USB connection.

Returns
  • the configuration's self-powered attribute

public String toString ()

Returns a string containing a concise, human-readable description of this object. Subclasses are encouraged to override this method and provide an implementation that takes into account the object's type and data. The default implementation is equivalent to the following expression: 

   getClass().getName() + '@' + Integer.toHexString(hashCode())

See Writing a useful toString method if you intend implementing your own toString method.

Returns
  • a printable representation of this object.

public void writeToParcel (Parcel parcel, int flags)

Flatten this object in to a Parcel.

Parameters
parcel The Parcel in which the object should be written.
flags Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE.