MtpDevice

MtpDevice

public MtpDevice (UsbDevice device)

MtpClient constructor

close

public void close ()

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.

deleteObject

public boolean deleteObject (int objectHandle)

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.

getDeviceId

public int getDeviceId ()

Returns the USB ID of the USB device. This returns the same value as UsbDevice.getDeviceId() for the device's UsbDevice

getDeviceInfo

public MtpDeviceInfo getDeviceInfo ()

Returns the MtpDeviceInfo for this device

getDeviceName

public String getDeviceName ()

Returns the name of the USB device This returns the same value as UsbDevice.getDeviceName() for the device's UsbDevice

getObject

public byte[] getObject (int objectHandle, 
                int objectSize)

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.

getObjectHandles

public int[] getObjectHandles (int storageId, 
                int format, 
                int objectHandle)

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

getObjectInfo

public MtpObjectInfo getObjectInfo (int objectHandle)

Retrieves the MtpObjectInfo for an object.

getParent

public long getParent (int objectHandle)

Retrieves the object handle for the parent of an object on the device.

getPartialObject

public long getPartialObject (int objectHandle, 
                long offset, 
                long size, 
                byte[] buffer)

Obtains object bytes in the specified range and writes it to an array. This call may block for an arbitrary amount of time depending on the size of the data and speed of the devices.

getPartialObject64

public long getPartialObject64 (int objectHandle, 
                long offset, 
                long size, 
                byte[] buffer)

Obtains object bytes in the specified range and writes it to an array. This call may block for an arbitrary amount of time depending on the size of the data and speed of the devices. This is a vender-extended operation supported by Android that enables us to pass unsigned 64-bit offset. Check if the MTP device supports the operation by using MtpDeviceInfo#getOperationsSupported().

getStorageId

public long getStorageId (int objectHandle)

Retrieves the ID of the storage unit containing the given object on the device.

getStorageIds

public int[] getStorageIds ()

Returns the list of IDs for all storage units on this device Information about each storage unit can be accessed via getStorageInfo(int).

getStorageInfo

public MtpStorageInfo getStorageInfo (int storageId)

Retrieves the MtpStorageInfo for a storage unit.

getThumbnail

public byte[] getThumbnail (int objectHandle)

Returns the thumbnail data for an object as a byte array. The size and format of the thumbnail data can be determined via MtpObjectInfo#getThumbCompressedSize and MtpObjectInfo#getThumbFormat. For typical devices the format is JPEG.

importFile

public boolean importFile (int objectHandle, 
                String destPath)

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.

importFile

public boolean importFile (int objectHandle, 
                ParcelFileDescriptor descriptor)

Copies the data for an object to a file descriptor. This call may block for an arbitrary amount of time depending on the size of the data and speed of the devices. The file descriptor is not closed on completion, and must be done by the caller.

open

public boolean open (UsbDeviceConnection connection)

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.

readEvent

public MtpEvent readEvent (CancellationSignal signal)

Reads an event from the device. It blocks the current thread until it gets an event. It throws OperationCanceledException if it is cancelled by signal.

sendObject

public boolean sendObject (int objectHandle, 
                long size, 
                ParcelFileDescriptor descriptor)

Copies the data for an object from a file descriptor. This call may block for an arbitrary amount of time depending on the size of the data and speed of the devices. The file descriptor is not closed on completion, and must be done by the caller.

sendObjectInfo

public MtpObjectInfo sendObjectInfo (MtpObjectInfo info)

Uploads an object metadata for a new entry. The MtpObjectInfo can be created with the MtpObjectInfo.Builder class. The returned MtpObjectInfo has the new object handle field filled in.

toString

public String toString ()

Returns a string representation of the object.

finalize

protected void finalize ()

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. A subclass overrides the finalize method to dispose of system resources or to perform other cleanup.

The general contract of finalize is that it is invoked if and when the Java virtual machine has determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, except as a result of an action taken by the finalization of some other object or class which is ready to be finalized. The finalize method may take any action, including making this object available again to other threads; the usual purpose of finalize, however, is to perform cleanup actions before the object is irrevocably discarded. For example, the finalize method for an object that represents an input/output connection might perform explicit I/O transactions to break the connection before the object is permanently discarded.

The finalize method of class Object performs no special action; it simply returns normally. Subclasses of Object may override this definition.

The Java programming language does not guarantee which thread will invoke the finalize method for any given object. It is guaranteed, however, that the thread that invokes finalize will not be holding any user-visible synchronization locks when finalize is invoked. If an uncaught exception is thrown by the finalize method, the exception is ignored and finalization of that object terminates.

After the finalize method has been invoked for an object, no further action is taken until the Java virtual machine has again determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, including possible actions by other objects or classes which are ready to be finalized, at which point the object may be discarded.

The finalize method is never invoked more than once by a Java virtual machine for any given object.

Any exception thrown by the finalize method causes the finalization of this object to be halted, but is otherwise ignored.