UsbConfiguration | API reference

UsbConfiguration | API reference | Android Developers

public class UsbConfiguration
extends Object implements Parcelable

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

From interface android.os.Parcelable

`int`	`CONTENTS_FILE_DESCRIPTOR` Descriptor bit used with `describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.
`int`	`PARCELABLE_WRITE_RETURN_VALUE` Flag for use with `writeToParcel(Parcel, int)`: the object being written is a return value, that is the result of a function such as "`Parcelable someFunction()`", "`void someFunction(out Parcelable)`", or "`void someFunction(inout Parcelable)`".

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 `UsbInterface`s 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

From class java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface android.os.Parcelable

`abstract int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Fields

Public methods

describeContents

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(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

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

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

public int getInterfaceCount ()

Returns the number of UsbInterfaces this configuration contains.

Returns
`int`	the number of endpoints

getMaxPower

public int getMaxPower ()

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

Returns
`int`	the configuration's max power

getName

public String getName ()

Returns the configuration's name.

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

isRemoteWakeup

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

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

public String toString ()

Returns a string representation of the object.

Returns
`String`	a string representation of the object.