UsbConfiguration

public class UsbConfiguration
extends Object implements Parcelable

java.lang.Object
   ↳ android.hardware.usb.UsbConfiguration


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

Inherited constants

Fields

public static final Creator<UsbConfiguration> CREATOR

Public methods

int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled 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 representation of the object.

void writeToParcel(Parcel parcel, int flags)

Flatten this object in to a Parcel.

Inherited methods

Fields

CREATOR

Added in API level 21
public static final Creator<UsbConfiguration> CREATOR

Public methods

describeContents

Added in API level 21
public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
int a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR

getId

Added in API level 21
public int getId ()

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

Returns
int the configuration's ID

getInterface

Added in API level 21
public UsbInterface getInterface (int index)

Returns the UsbInterface at the given index.

Parameters
index int

Returns
UsbInterface the interface This value cannot be null.

getInterfaceCount

Added in API level 21
public int getInterfaceCount ()

Returns the number of UsbInterfaces this configuration contains.

Returns
int the number of endpoints

getMaxPower

Added in API level 21
public int getMaxPower ()

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

Returns
int the configuration's max power

getName

Added in API level 21
public String getName ()

Returns the configuration's name.

Returns
String the configuration's name, or null if the property could not be read

isRemoteWakeup

Added in API level 21
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
boolean the configuration's remote-wakeup attribute

isSelfPowered

Added in API level 21
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
boolean the configuration's self-powered attribute

toString

Added in API level 21
public String toString ()

Returns a string representation of the object.

Returns
String a string representation of the object.

writeToParcel

Added in API level 21
public void writeToParcel (Parcel parcel, 
                int flags)

Flatten this object in to a Parcel.

Parameters
parcel Parcel: The Parcel in which the object should be written. This value cannot be null.

flags int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES