| java.lang.Object | |
| ↳ | android.mtp.MtpDevice |
This class represents an MTP or PTP device connected on the USB host bus. An application can
instantiate an object of this type, by referencing an attached UsbDevice and then use methods in this class to get information about the
device and objects stored on it, as well as open the connection and transfer data.
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
MtpClient constructor
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Closes all resources related to the MtpDevice object.
| |||||||||||
Deletes an object on the device.
| |||||||||||
Returns the USB ID of the USB device.
| |||||||||||
Returns the
MtpDeviceInfo for this device | |||||||||||
Returns the name of the USB device
This returns the same value as
getDeviceName()
for the device's UsbDevice | |||||||||||
Returns the data for an object as a byte array.
| |||||||||||
Returns the list of object handles for all objects on the given storage unit,
with the given format and parent.
| |||||||||||
Retrieves the
MtpObjectInfo for an object. | |||||||||||
Retrieves the object handle for the parent of an object on the device.
| |||||||||||
Retrieves the ID of the storage unit containing the given object on the device.
| |||||||||||
Returns the list of IDs for all storage units on this device
Information about each storage unit can be accessed via
getStorageInfo(int). | |||||||||||
Retrieves the
MtpStorageInfo for a storage unit. | |||||||||||
Returns the thumbnail data for an object as a byte array.
| |||||||||||
Copies the data for an object to a file in external storage.
| |||||||||||
Opens the MTP device.
| |||||||||||
Returns a string containing a concise, human-readable description of this
object.
| |||||||||||
| Protected Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Invoked when the garbage collector has detected that this instance is no longer reachable.
| |||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
MtpClient constructor
| device | the UsbDevice for the MTP or PTP device
|
|---|
Closes all resources related to the MtpDevice object.
After this is called, the object can not be used until open(UsbDeviceConnection) is called again
with a new UsbDeviceConnection.
Deletes an object on the device. This call may block, since deleting a directory containing many files may take a long time on some devices.
| objectHandle | handle of the object to delete |
|---|
Returns the USB ID of the USB device.
This returns the same value as getDeviceId()
for the device's UsbDevice
Returns the MtpDeviceInfo for this device
Returns the name of the USB device
This returns the same value as getDeviceName()
for the device's UsbDevice
Returns the data for an object as a byte array. This call may block for an arbitrary amount of time depending on the size of the data and speed of the devices.
| objectHandle | handle of the object to read |
|---|---|
| objectSize | the size of the object (this should match
getCompressedSize() |
Returns the list of object handles for all objects on the given storage unit,
with the given format and parent.
Information about each object can be accessed via getObjectInfo(int).
| storageId | the storage unit to query |
|---|---|
| format | the format of the object to return, or zero for all formats |
| objectHandle | the parent object to query, or zero for the storage root |
Retrieves the MtpObjectInfo for an object.
| objectHandle | the handle of the object |
|---|
Retrieves the object handle for the parent of an object on the device.
| objectHandle | handle of the object to query |
|---|
Retrieves the ID of the storage unit containing the given object on the device.
| objectHandle | handle of the object to query |
|---|
Returns the list of IDs for all storage units on this device
Information about each storage unit can be accessed via getStorageInfo(int).
Retrieves the MtpStorageInfo for a storage unit.
| storageId | the ID of the storage unit |
|---|
Returns the thumbnail data for an object as a byte array.
The size and format of the thumbnail data can be determined via
getThumbCompressedSize() and
getThumbFormat().
For typical devices the format is JPEG.
| objectHandle | handle of the object to read |
|---|
Copies the data for an object to a file in external storage. This call may block for an arbitrary amount of time depending on the size of the data and speed of the devices.
| objectHandle | handle of the object to read |
|---|---|
| destPath | path to destination for the file transfer.
This path should be in the external storage as defined by
getExternalStorageDirectory() |
Opens the MTP device. Once the device is open it takes ownership of the
UsbDeviceConnection.
The connection will be closed when you call close()
The connection will also be closed if this method fails.
| connection | an open UsbDeviceConnection for the device |
|---|
Returns a string containing a concise, human-readable description of this object. Subclasses are encouraged to override this method and provide an implementation that takes into account the object's type and data. The default implementation is equivalent to the following expression:
getClass().getName() + '@' + Integer.toHexString(hashCode())
See Writing a useful
toString method
if you intend implementing your own toString method.
Invoked when the garbage collector has detected that this instance is no longer reachable. The default implementation does nothing, but this method can be overridden to free resources.
Note that objects that override finalize are significantly more expensive than
objects that don't. Finalizers may be run a long time after the object is no longer
reachable, depending on memory pressure, so it's a bad idea to rely on them for cleanup.
Note also that finalizers are run on a single VM-wide finalizer thread,
so doing blocking work in a finalizer is a bad idea. A finalizer is usually only necessary
for a class that has a native peer and needs to call a native method to destroy that peer.
Even then, it's better to provide an explicit close method (and implement
Closeable), and insist that callers manually dispose of instances. This
works well for something like files, but less well for something like a BigInteger
where typical calling code would have to deal with lots of temporaries. Unfortunately,
code that creates lots of temporaries is the worst kind of code from the point of view of
the single finalizer thread.
If you must use finalizers, consider at least providing your own
ReferenceQueue and having your own thread process that queue.
Unlike constructors, finalizers are not automatically chained. You are responsible for
calling super.finalize() yourself.
Uncaught exceptions thrown by finalizers are ignored and do not terminate the finalizer thread. See Effective Java Item 7, "Avoid finalizers" for more.
| Throwable |
|---|