com.theta360.ptp

Interface PtpInitiator

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable

All Known Implementing Classes:

AbstractPtpInitiator, PtpIpInitiator

public interface PtpInitiator
extends java.io.Closeable

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addListener(PtpEventListener listener) Add the listener for PTP event.
void	checkResponse()
void	closeSession() Close the session.
void	deleteObject(UINT32 objectHandle) Delete the specified object.
DeviceInfo	getDeviceInfo() Get the DeviceInfo of the responder.
DevicePropDesc<?>	getDevicePropDesc(Code<UINT16> devicePropCode) Get the description of the device property.
byte[]	getDevicePropValue(Code<UINT16> devicePropCode)
java.lang.String	getDevicePropValueAsString(Code<UINT16> devicePropCode)
UINT16	getDevicePropValueAsUINT16(Code<UINT16> devicePropCode)
UINT32	getDevicePropValueAsUINT32(Code<UINT16> devicePropCode)
byte	getDevicePropValueAsUINT8(Code<UINT16> devicePropCode)
UINT32	getNumObjects() Get number of objects.
void	getObject(UINT32 objectHandle, java.io.OutputStream dst) Get the object from the responder.
java.util.List<UINT32>	getObjectHandles() Get list of object handle.
java.util.List<UINT32>	getObjectHandles(UINT32 storageID) Get list of object handle.
ObjectInfo	getObjectInfo(UINT32 objectHandle) Get the information of the object.
java.util.List<UINT32>	getStorageIDs() Get list of storage ID
StorageInfo	getStorageInfo(UINT32 storageID) Get storage info
void	getThumb(UINT32 objectHandle, java.io.OutputStream dst) Get the thumbnail of specified object handle from the responder.
void	initiateCapture() Send initiate capture request to the responder.
UINT32	initiateOpenCapture() Initiate open capture.
void	openSession(UINT32 sessionID) Open the session.
byte[]	receiveData()
void	receiveData(java.io.OutputStream dst)
Response	receiveResponse()
boolean	removeListener(PtpEventListener listener) Remove the listener for PTP event.
void	sendData(byte[] data)
UINT32	sendOperation(Code<UINT16> operationCode)
UINT32	sendOperation(Code<UINT16> operationCode, UINT32 p1)
UINT32	sendOperation(Code<UINT16> operationCode, UINT32 p1, UINT32 p2)
UINT32	sendOperation(Code<UINT16> operationCode, UINT32 p1, UINT32 p2, UINT32 p3)
UINT32	sendOperation(Code<UINT16> operationCode, UINT32 p1, UINT32 p2, UINT32 p3, UINT32 p4)
UINT32	sendOperation(Code<UINT16> operationCode, UINT32 p1, UINT32 p2, UINT32 p3, UINT32 p4, UINT32 p5)
void	setDevicePropValue(Code<UINT16> devicePropValue, byte value)
void	setDevicePropValue(Code<UINT16> devicePropCode, byte[] value)
void	setDevicePropValue(Code<UINT16> devicePropValue, java.lang.String value)
void	setDevicePropValue(Code<UINT16> devicePropValue, UINT16 value)
void	setDevicePropValue(Code<UINT16> devicePropValue, UINT32 value)
void	terminateOpenCapture() Terminate all capture.
void	terminateOpenCapture(UINT32 transactionID) Terminate specified capture.

Methods inherited from interface java.io.Closeable

close

Method Detail

sendOperation

UINT32 sendOperation(Code<UINT16> operationCode)
                     throws java.io.IOException

Throws:

java.io.IOException

sendOperation

UINT32 sendOperation(Code<UINT16> operationCode,
                   UINT32 p1)
                     throws java.io.IOException

Throws:

java.io.IOException

sendOperation

UINT32 sendOperation(Code<UINT16> operationCode,
                   UINT32 p1,
                   UINT32 p2)
                     throws java.io.IOException

Throws:

java.io.IOException

sendOperation

UINT32 sendOperation(Code<UINT16> operationCode,
                   UINT32 p1,
                   UINT32 p2,
                   UINT32 p3)
                     throws java.io.IOException

Throws:

java.io.IOException

sendOperation

UINT32 sendOperation(Code<UINT16> operationCode,
                   UINT32 p1,
                   UINT32 p2,
                   UINT32 p3,
                   UINT32 p4)
                     throws java.io.IOException

Throws:

java.io.IOException

sendOperation

UINT32 sendOperation(Code<UINT16> operationCode,
                   UINT32 p1,
                   UINT32 p2,
                   UINT32 p3,
                   UINT32 p4,
                   UINT32 p5)
                     throws java.io.IOException

Throws:

java.io.IOException

getDeviceInfo

DeviceInfo getDeviceInfo()
                         throws java.io.IOException,
                                PtpException

Get the DeviceInfo of the responder.

Throws:

java.io.IOException

PtpException

openSession

void openSession(UINT32 sessionID)
                 throws java.io.IOException,
                        PtpException

Open the session.

Parameters:

sessionID -

Throws:

java.io.IOException

PtpException

closeSession

void closeSession()
                  throws java.io.IOException,
                         PtpException

Close the session.

Throws:

java.io.IOException

PtpException

getStorageIDs

java.util.List<UINT32> getStorageIDs()
                                     throws java.io.IOException,
                                            PtpException

Get list of storage ID

Throws:

java.io.IOException

PtpException

getStorageInfo

StorageInfo getStorageInfo(UINT32 storageID)
                           throws java.io.IOException,
                                  PtpException

Get storage info

Parameters:

storageID -

Throws:

java.io.IOException

PtpException

getNumObjects

UINT32 getNumObjects()
                     throws java.io.IOException,
                            PtpException

Get number of objects.

Throws:

java.io.IOException

PtpException

getObjectHandles

java.util.List<UINT32> getObjectHandles()
                                        throws java.io.IOException,
                                               PtpException

Get list of object handle.

Throws:

java.io.IOException

PtpException

getObjectHandles

java.util.List<UINT32> getObjectHandles(UINT32 storageID)
                                        throws java.io.IOException,
                                               PtpException

Get list of object handle.

Parameters:

storageID -

Throws:

java.io.IOException

PtpException

getObjectInfo

ObjectInfo getObjectInfo(UINT32 objectHandle)
                         throws java.io.IOException,
                                PtpException

Get the information of the object.

Parameters:

objectHandle -

Throws:

java.io.IOException

PtpException

getObject

void getObject(UINT32 objectHandle,
             java.io.OutputStream dst)
               throws java.io.IOException,
                      PtpException

Get the object from the responder.

Parameters:

objectHandle -

dst -

Throws:

java.io.IOException

PtpException

getThumb

void getThumb(UINT32 objectHandle,
            java.io.OutputStream dst)
              throws java.io.IOException,
                     PtpException

Get the thumbnail of specified object handle from the responder.

Parameters:

objectHandle -

dst -

Throws:

java.io.IOException

PtpException

deleteObject

void deleteObject(UINT32 objectHandle)
                  throws java.io.IOException,
                         PtpException

Delete the specified object.

Parameters:

objectHandle -

Throws:

java.io.IOException

PtpException

initiateCapture

void initiateCapture()
                     throws java.io.IOException,
                            PtpException

Send initiate capture request to the responder.

Throws:

java.io.IOException

PtpException

getDevicePropDesc

DevicePropDesc<?> getDevicePropDesc(Code<UINT16> devicePropCode)
                                    throws java.io.IOException,
                                           PtpException

Get the description of the device property.

Throws:

java.io.IOException

PtpException

getDevicePropValue

byte[] getDevicePropValue(Code<UINT16> devicePropCode)
                          throws java.io.IOException,
                                 PtpException

Throws:

java.io.IOException

PtpException

getDevicePropValueAsUINT8

byte getDevicePropValueAsUINT8(Code<UINT16> devicePropCode)
                               throws java.io.IOException,
                                      PtpException

Throws:

java.io.IOException

PtpException

getDevicePropValueAsUINT16

UINT16 getDevicePropValueAsUINT16(Code<UINT16> devicePropCode)
                                  throws java.io.IOException,
                                         PtpException

Throws:

java.io.IOException

PtpException

getDevicePropValueAsUINT32

UINT32 getDevicePropValueAsUINT32(Code<UINT16> devicePropCode)
                                  throws java.io.IOException,
                                         PtpException

Throws:

java.io.IOException

PtpException

getDevicePropValueAsString

java.lang.String getDevicePropValueAsString(Code<UINT16> devicePropCode)
                                            throws java.io.IOException,
                                                   PtpException

Throws:

java.io.IOException

PtpException

setDevicePropValue

void setDevicePropValue(Code<UINT16> devicePropCode,
                      byte[] value)
                        throws java.io.IOException,
                               PtpException

Throws:

java.io.IOException

PtpException

setDevicePropValue

void setDevicePropValue(Code<UINT16> devicePropValue,
                      byte value)
                        throws java.io.IOException,
                               PtpException

Throws:

java.io.IOException

PtpException

setDevicePropValue

void setDevicePropValue(Code<UINT16> devicePropValue,
                      UINT16 value)
                        throws java.io.IOException,
                               PtpException

Throws:

java.io.IOException

PtpException

setDevicePropValue

void setDevicePropValue(Code<UINT16> devicePropValue,
                      UINT32 value)
                        throws java.io.IOException,
                               PtpException

Throws:

java.io.IOException

PtpException

setDevicePropValue

void setDevicePropValue(Code<UINT16> devicePropValue,
                      java.lang.String value)
                        throws java.io.IOException,
                               PtpException

Throws:

java.io.IOException

PtpException

terminateOpenCapture

void terminateOpenCapture()
                          throws java.io.IOException,
                                 PtpException

Terminate all capture.

Throws:

java.io.IOException

PtpException

terminateOpenCapture

void terminateOpenCapture(UINT32 transactionID)
                          throws java.io.IOException,
                                 PtpException

Terminate specified capture.

Parameters:

transactionID -

Throws:

java.io.IOException

PtpException

initiateOpenCapture

UINT32 initiateOpenCapture()
                           throws java.io.IOException,
                                  PtpException

Initiate open capture.

Returns:

Transaction ID

Throws:

java.io.IOException

PtpException

See Also:

terminateOpenCapture()

receiveResponse

Response receiveResponse()
                         throws java.io.IOException

Throws:

java.io.IOException

checkResponse

void checkResponse()
                   throws java.io.IOException,
                          PtpException

Throws:

java.io.IOException

PtpException

sendData

void sendData(byte[] data)
              throws java.io.IOException

Throws:

java.io.IOException

receiveData

byte[] receiveData()
                   throws java.io.IOException,
                          PtpException

Throws:

java.io.IOException

PtpException

receiveData

void receiveData(java.io.OutputStream dst)
                 throws java.io.IOException,
                        PtpException

Throws:

java.io.IOException

PtpException

addListener

boolean addListener(PtpEventListener listener)

Add the listener for PTP event.

Parameters:

listener -

Returns:

true if this initiator did not already contain the specified listener

removeListener

boolean removeListener(PtpEventListener listener)

Remove the listener for PTP event.

Parameters:

listener -

Returns:

true if this initiator contained the specified listener