public class UsbDevice
extends Object
implements Parcelable
java.lang.Object | |
↳ | android.hardware.usb.UsbDevice |
This class represents a USB device attached to the android device with the android device acting as the USB host. Each device contains one or more UsbInterface
s, each of which contains a number of UsbEndpoint
s (the channels via which data is transmitted over USB).
This class contains information (along with UsbInterface
and UsbEndpoint
) that describes the capabilities of the USB device. To communicate with the device, you open a UsbDeviceConnection
for the device and use UsbRequest
to send and receive data on an endpoint. controlTransfer(int, int, int, int, byte[], int, int)
is used for control requests on endpoint zero.
For more information about communicating with USB hardware, read the USB developer guide.
Inherited constants |
---|
![]() android.os.Parcelable
|
Fields |
|
---|---|
public static final Creator<UsbDevice> |
CREATOR
|
Public methods |
|
---|---|
int |
describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
boolean |
equals(Object o) Indicates whether some other object is "equal to" this one. |
UsbConfiguration |
getConfiguration(int index) Returns the |
int |
getConfigurationCount() Returns the number of |
int |
getDeviceClass() Returns the devices's class field. |
int |
getDeviceId() Returns a unique integer ID for the device. |
static int |
getDeviceId(String name) |
String |
getDeviceName() Returns the name of the device. |
static String |
getDeviceName(int id) |
int |
getDeviceProtocol() Returns the device's protocol field. |
int |
getDeviceSubclass() Returns the device's subclass field. |
UsbInterface |
getInterface(int index) Returns the |
int |
getInterfaceCount() Returns the number of |
String |
getManufacturerName() Returns the manufacturer name of the device. |
int |
getProductId() Returns a product ID for the device. |
String |
getProductName() Returns the product name of the device. |
String |
getSerialNumber() Returns the serial number of the device. |
int |
getVendorId() Returns a vendor ID for the device. |
String |
getVersion() Returns the version number of the device. |
int |
hashCode() Returns a hash code value for the object. |
String |
toString() Returns a string representation of the object. |
void |
writeToParcel(Parcel parcel, int flags) Flatten this object in to a Parcel. |
Inherited methods |
|
---|---|
![]() java.lang.Object
|
|
![]() android.os.Parcelable
|
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. |
boolean equals (Object o)
Indicates whether some other object is "equal to" this one.
The equals
method implements an equivalence relation on non-null object references:
x
, x.equals(x)
should return true
. x
and y
, x.equals(y)
should return true
if and only if y.equals(x)
returns true
. x
, y
, and z
, if x.equals(y)
returns true
and y.equals(z)
returns true
, then x.equals(z)
should return true
. x
and y
, multiple invocations of x.equals(y)
consistently return true
or consistently return false
, provided no information used in equals
comparisons on the objects is modified. x
, x.equals(null)
should return false
. The equals
method for class Object
implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x
and y
, this method returns true
if and only if x
and y
refer to the same object (x == y
has the value true
).
Note that it is generally necessary to override the hashCode
method whenever this method is overridden, so as to maintain the general contract for the hashCode
method, which states that equal objects must have equal hash codes.
Parameters | |
---|---|
o |
Object : the reference object with which to compare. |
Returns | |
---|---|
boolean |
true if this object is the same as the obj argument; false otherwise. |
UsbConfiguration getConfiguration (int index)
Returns the UsbConfiguration
at the given index.
Parameters | |
---|---|
index |
int
|
Returns | |
---|---|
UsbConfiguration |
the configuration |
int getConfigurationCount ()
Returns the number of UsbConfiguration
s this device contains.
Returns | |
---|---|
int |
the number of configurations |
int getDeviceClass ()
Returns the devices's class field. Some useful constants for USB device classes can be found in UsbConstants
.
Returns | |
---|---|
int |
the devices's class |
int getDeviceId ()
Returns a unique integer ID for the device. This is a convenience for clients that want to use an integer to represent the device, rather than the device name. IDs are not persistent across USB disconnects.
Returns | |
---|---|
int |
the device ID |
String getDeviceName ()
Returns the name of the device. In the standard implementation, this is the path of the device file for the device in the usbfs file system.
Returns | |
---|---|
String |
the device name |
int getDeviceProtocol ()
Returns the device's protocol field.
Returns | |
---|---|
int |
the device's protocol |
int getDeviceSubclass ()
Returns the device's subclass field.
Returns | |
---|---|
int |
the device's subclass |
UsbInterface getInterface (int index)
Returns the UsbInterface
at the given index. For devices with multiple configurations, you will probably want to use getInterface(int)
instead.
Parameters | |
---|---|
index |
int
|
Returns | |
---|---|
UsbInterface |
the interface |
int getInterfaceCount ()
Returns the number of UsbInterface
s this device contains. For devices with multiple configurations, you will probably want to use getInterfaceCount()
instead.
Returns | |
---|---|
int |
the number of interfaces |
String getManufacturerName ()
Returns the manufacturer name of the device.
Returns | |
---|---|
String |
the manufacturer name |
int getProductId ()
Returns a product ID for the device.
Returns | |
---|---|
int |
the device product ID |
String getProductName ()
Returns the product name of the device.
Returns | |
---|---|
String |
the product name |
String getSerialNumber ()
Returns the serial number of the device.
Returns | |
---|---|
String |
the serial number name |
int getVendorId ()
Returns a vendor ID for the device.
Returns | |
---|---|
int |
the device vendor ID |
String getVersion ()
Returns the version number of the device.
Returns | |
---|---|
String |
the device version |
int hashCode ()
Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap
.
The general contract of hashCode
is:
hashCode
method must consistently return the same integer, provided no information used in equals
comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. equals(Object)
method, then calling the hashCode
method on each of the two objects must produce the same integer result. equals(java.lang.Object)
method, then calling the hashCode
method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. As much as is reasonably practical, the hashCode method defined by class Object
does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the JavaTM programming language.)
Returns | |
---|---|
int |
a hash code value for this object. |
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. |
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 . |