Skip to content

Most visited

Recently visited

navigation

UsbInterface

public class UsbInterface
extends Object implements Parcelable

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


A class representing an interface on a UsbDevice. USB devices 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<UsbInterface> CREATOR

Public methods

int describeContents()

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

int getAlternateSetting()

Returns the interface's bAlternateSetting field.

UsbEndpoint getEndpoint(int index)

Returns the UsbEndpoint at the given index.

int getEndpointCount()

Returns the number of UsbEndpoints this interface contains.

int getId()

Returns the interface's bInterfaceNumber field.

int getInterfaceClass()

Returns the interface's class field.

int getInterfaceProtocol()

Returns the interface's protocol field.

int getInterfaceSubclass()

Returns the interface's subclass field.

String getName()

Returns the interface's name.

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 12
Creator<UsbInterface> CREATOR

Public methods

describeContents

Added in API level 12
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.

getAlternateSetting

Added in API level 21
int getAlternateSetting ()

Returns the interface's bAlternateSetting field. This is an integer that along with the ID uniquely identifies the interface on the device. setInterface(UsbInterface) can be used to switch between two interfaces with the same ID but different alternate setting.

Returns
int the interface's alternate setting

getEndpoint

Added in API level 12
UsbEndpoint getEndpoint (int index)

Returns the UsbEndpoint at the given index.

Parameters
index int
Returns
UsbEndpoint the endpoint

getEndpointCount

Added in API level 12
int getEndpointCount ()

Returns the number of UsbEndpoints this interface contains.

Returns
int the number of endpoints

getId

Added in API level 12
int getId ()

Returns the interface's bInterfaceNumber field. This is an integer that along with the alternate setting uniquely identifies the interface on the device.

Returns
int the interface's ID

getInterfaceClass

Added in API level 12
int getInterfaceClass ()

Returns the interface's class field. Some useful constants for USB classes can be found in UsbConstants

Returns
int the interface's class

getInterfaceProtocol

Added in API level 12
int getInterfaceProtocol ()

Returns the interface's protocol field.

Returns
int the interface's protocol

getInterfaceSubclass

Added in API level 12
int getInterfaceSubclass ()

Returns the interface's subclass field.

Returns
int the interface's subclass

getName

Added in API level 21
String getName ()

Returns the interface's name.

Returns
String the interface's name

toString

Added in API level 12
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 12
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.

Hooray!

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 one-minute survey?
Help us improve Android tools and documentation.