Skip to content

Most visited

Recently visited

navigation

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

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

From class java.lang.Object
From interface android.os.Parcelable

Fields

CREATOR

added in API level 21
Creator<UsbConfiguration> CREATOR

Public methods

describeContents

added in API level 21
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.

getId

added in API level 21
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
UsbInterface getInterface (int index)

Returns the UsbInterface at the given index.

Parameters
index int

Returns
UsbInterface the interface

This value will never be null.

getInterfaceCount

added in API level 21
int getInterfaceCount ()

Returns the number of UsbInterfaces this configuration contains.

Returns
int the number of endpoints

getMaxPower

added in API level 21
int getMaxPower ()

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

Returns
int the configuration's max power

getName

added in API level 21
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
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
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
String toString ()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

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

Returns
String a string representation of the object.

writeToParcel

added in API level 21
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.

flags int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE.

This site uses cookies to store your preferences for site-specific language and display options.

Get the latest Android developer news and tips that will help you find success on Google Play.

* Required Fields

Hooray!

Follow Google Developers on WeChat

Browse this site in ?

You requested a page in , but your language preference for this site is .

Would you like to change your language preference and browse this site in ? If you want to change your language preference later, use the language menu at the bottom of each page.

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a short survey?
Help us improve the Android developer experience.
(Sep 2017 survey)