org.theta4j

Class Theta

java.lang.Object

org.theta4j.Theta

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public final class Theta
extends java.lang.Object
implements java.io.Closeable

This class provides the interface for RICOH THETA on PTP-IP.

Constructor Summary

Constructors

Constructor and Description
Theta()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addListener(ThetaEventListener listener) Add an event listener.
void	close()
void	deleteObject(long objectHandle) Deletes the object specified by the ObjectHandle.
long	getAudioVolume() Acquires or set the volume for the shutter sound.
int	getAutoPowerOffDelay() Acquires the time in minutes to start the auto power off.
BatteryLevel	getBatteryLevel() Acquires the battery charge level.
CaptureStatus	getCaptureStatus() Acquires the camera shooting execution status.
ChannelNumber	getChannelNumber() Acquires the wireless LAN channel number.
java.util.Date	getDateTime() Acquires the date and time.
DeviceInfo	getDeviceInfo() Returns information and capabilities about the Responder device.
ErrorInfo	getErrorInfo() Acquires the error information.
int	getExposureBiasCompensation() Acquires or set the exposure bias compensation value.
ISOSpeed	getExposureIndex() Acquires the ISO sensitivity.
java.lang.String	getGPSInfo() Acquires the GPS information.
long	getNumObjects() Returns the total number of objects present in the all storage.
void	getObject(long objectHandle, java.io.OutputStream dst) Retrieves the object's data and writes to the dst.
java.util.List<java.lang.Long>	getObjectHandles() Returns a list of the object handles.
ObjectInfo	getObjectInfo(long objectHandle) Returns a ObjectInfo for the object specified by the objectHandle.
int	getRecordingTime() Acquires the video recording time in seconds.
int	getRemainingRecordingTime() Acquires the amount of time remaining in seconds for recording video.
void	getResizedImageObject(long objectHandle, java.io.OutputStream dst) Retrieves the object's resized data and writes to the dst.
ShutterSpeed	getShutterSpeed() Acquires the shutter speed.
int	getSleepDelay() Acquires the time in seconds to start sleep.
StillCaptureMode	getStillCaptureMode() Acquires the still image shooting method.¥
java.util.List<java.lang.Long>	getStorageIDs() Returns a list of the currently valid StorageIDs.
StorageInfo	getStorageInfo(long storageID) Returns a StorageInfo of the storage area indicated in the storageID.
void	getThumb(long objectHandle, java.io.OutputStream dst) Retrieves the object's thumbnail data and writes to the dst.
long	getTimelapseInterval() Acquires the shooting interval in msec for interval shooting.
int	getTimelapseNumber() Acquires the upper limit value for interval shooting.
WhiteBalance	getWhiteBalance() Acquires the white balance.
void	initiateCapture() Starts shooting.
long	initiateOpenCapture() Starts the video recording or the interval shooting.
boolean	removeListener(ThetaEventListener listener) Remove an event listener.
void	setAudioVolume(long audioVolume) Set the volume for the shutter sound.
void	setAutoPowerOffDelay(int autoPowerOffDelay) Sets the time in minutes to start the auto power off.
void	setChannelNumber(ChannelNumber channelNumber) Sets the wireless LAN channel number.
void	setDateTime(java.util.Date dateTime) Sets the date and time.
void	setExposureBiasCompensation(int exposureBiasCompensation) Sets the exposure bias compensation value.
void	setExposureIndex(ISOSpeed isoSpeed) Sets the ISO sensitivity.
void	setGPSInfo(java.lang.String gpsInfo) Sets the GPS information.
void	setShutterSpeed(ShutterSpeed shutterSpeed) Sets the shutter speed.
void	setSleepDelay(int sleepDelay) Sets the time in seconds to start sleep.
void	setStillCaptureMode(StillCaptureMode stillCaptureMode) Sets the still image shooting method.
void	setTimelapseInterval(long timelapseInterval) Sets the shooting interval in msec for interval shooting.
void	setTimelapseNumber(int timelapseNumber) Sets the upper limit value for interval shooting.
void	setWhiteBalance(WhiteBalance whiteBalance) Sets the white balance.
void	terminateOpenCapture() Exits the all continuous shooting.
void	terminateOpenCapture(long transactionID) Exits a continuous shooting specified by TransactionID.
void	turnOffWLAN() Turns off the Wireless LAN.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Theta

public Theta()
      throws java.io.IOException

Throws:

java.io.IOException

Method Detail

getDeviceInfo

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

Returns information and capabilities about the Responder device.

Throws:

java.io.IOException

PtpException

getStorageIDs

public java.util.List<java.lang.Long> getStorageIDs()
                                             throws java.io.IOException,
                                                    PtpException

Returns a list of the currently valid StorageIDs.

Throws:

java.io.IOException

PtpException

getStorageInfo

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

Returns a StorageInfo of the storage area indicated in the storageID.

Parameters:

storageID - The StorageID of the storage area to acquire the StorageInfo.

Throws:

java.io.IOException

PtpException

getNumObjects

public long getNumObjects()
                   throws java.io.IOException,
                          PtpException

Returns the total number of objects present in the all storage.

Throws:

java.io.IOException

PtpException

getObjectHandles

public java.util.List<java.lang.Long> getObjectHandles()
                                                throws java.io.IOException,
                                                       PtpException

Returns a list of the object handles.

Throws:

java.io.IOException

PtpException

getObjectInfo

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

Returns a ObjectInfo for the object specified by the objectHandle.

Parameters:

objectHandle - The ObjectHandle of the object to acquire the ObjectInfo.

Throws:

java.io.IOException

PtpException

getObject

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

Retrieves the object's data and writes to the dst.

Parameters:

objectHandle - The ObjectHandle of the object to acquire the data.

dst - The destination for the object's data.

Throws:

java.io.IOException

PtpException

getThumb

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

Retrieves the object's thumbnail data and writes to the dst.

Parameters:

objectHandle - The ObjectHandle of the object to acquire the thumbnail data.

dst - The destination for the object's thumbnail data.

Throws:

java.io.IOException

PtpException

deleteObject

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

Deletes the object specified by the ObjectHandle.

Parameters:

objectHandle - The ObjectHandle of the object to delete.

Throws:

java.io.IOException

PtpException

initiateCapture

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

Starts shooting.

Throws:

java.io.IOException

PtpException

terminateOpenCapture

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

Exits the all continuous shooting.

Throws:

java.io.IOException

PtpException

terminateOpenCapture

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

Exits a continuous shooting specified by TransactionID.

Parameters:

transactionID - The TransactionID returned by Theta#initiateOpenCapture().

Throws:

java.io.IOException

PtpException

See Also:

initiateOpenCapture()

initiateOpenCapture

public long initiateOpenCapture()
                         throws java.io.IOException,
                                PtpException

Starts the video recording or the interval shooting.

After starts, it can exit by the #terminateOpenCapture(long)

Throws:

java.io.IOException

PtpException

See Also:

terminateOpenCapture(long)

getResizedImageObject

public void getResizedImageObject(long objectHandle,
                         java.io.OutputStream dst)
                           throws java.io.IOException,
                                  PtpException

Retrieves the object's resized data and writes to the dst.

Parameters:

objectHandle - The ObjectHandle of the object to acquire the resized data.

dst - The destination for the object's resized data.

Throws:

java.io.IOException

PtpException

turnOffWLAN

public void turnOffWLAN()
                 throws java.io.IOException,
                        PtpException

Turns off the Wireless LAN.

Throws:

java.io.IOException

PtpException

getBatteryLevel

public BatteryLevel getBatteryLevel()
                             throws java.io.IOException,
                                    PtpException

Acquires the battery charge level.

Throws:

java.io.IOException

PtpException

getWhiteBalance

public WhiteBalance getWhiteBalance()
                             throws java.io.IOException,
                                    PtpException

Acquires the white balance.

Throws:

java.io.IOException

PtpException

setWhiteBalance

public void setWhiteBalance(WhiteBalance whiteBalance)
                     throws java.io.IOException,
                            PtpException

Sets the white balance.

Returns to the default value when the power is turned off.

Throws:

java.io.IOException

PtpException

getExposureIndex

public ISOSpeed getExposureIndex()
                          throws java.io.IOException,
                                 PtpException

Acquires the ISO sensitivity.

Throws:

java.io.IOException

PtpException

setExposureIndex

public void setExposureIndex(ISOSpeed isoSpeed)
                      throws java.io.IOException,
                             PtpException

Sets the ISO sensitivity.

Returns to the default value when the power is turned off.

ISO sensitivity can be changed when ShutterSpeed is AUTO.

Parameters:

isoSpeed - An ISO speed

Throws:

java.io.IOException

PtpException

getExposureBiasCompensation

public int getExposureBiasCompensation()
                                throws java.io.IOException,
                                       PtpException

Acquires or set the exposure bias compensation value.

Throws:

java.io.IOException

PtpException

setExposureBiasCompensation

public void setExposureBiasCompensation(int exposureBiasCompensation)
                                 throws java.io.IOException,
                                        PtpException

Sets the exposure bias compensation value.

Returns to the default value when the power is turned off.

Parameters:

exposureBiasCompensation - An exposure bias compensation value to set.

Throws:

java.io.IOException

PtpException

getDateTime

public java.util.Date getDateTime()
                           throws java.io.IOException,
                                  PtpException

Acquires the date and time.

Throws:

java.io.IOException

PtpException

setDateTime

public void setDateTime(java.util.Date dateTime)
                 throws java.io.IOException,
                        PtpException

Sets the date and time.

Parameters:

dateTime - A date and time to set.

Throws:

java.io.IOException

PtpException

getStillCaptureMode

public StillCaptureMode getStillCaptureMode()
                                     throws java.io.IOException,
                                            PtpException

Acquires the still image shooting method.¥

Throws:

java.io.IOException

PtpException

setStillCaptureMode

public void setStillCaptureMode(StillCaptureMode stillCaptureMode)
                         throws java.io.IOException,
                                PtpException

Sets the still image shooting method.

Returns to the default value when the power is turned off or when #initiateOpenCapture() ends.

Parameters:

stillCaptureMode - A still capture mode to set.

Throws:

java.io.IOException

PtpException

getTimelapseNumber

public int getTimelapseNumber()
                       throws java.io.IOException,
                              PtpException

Acquires the upper limit value for interval shooting.

Throws:

java.io.IOException

PtpException

setTimelapseNumber

public void setTimelapseNumber(int timelapseNumber)
                        throws java.io.IOException,
                               PtpException

Sets the upper limit value for interval shooting.

Returns to the default value when the power is turned off.

This property cannot be set when the StillCaptureMode is interval shooting mode. So, this property has to be set before switching the StillCaptureMode to interval shooting mode.

Parameters:

timelapseNumber - The upper limit value for interval shooting. The valid range is in 0 or 2-65535. The 0 means unlimited.

Throws:

java.io.IOException

PtpException

getTimelapseInterval

public long getTimelapseInterval()
                          throws java.io.IOException,
                                 PtpException

Acquires the shooting interval in msec for interval shooting.

Throws:

java.io.IOException

PtpException

setTimelapseInterval

public void setTimelapseInterval(long timelapseInterval)
                          throws java.io.IOException,
                                 PtpException

Sets the shooting interval in msec for interval shooting.

Returns to the default value when the power is turned off.

This property cannot be set when the StillCaptureMode is interval shooting mode. So, this property has to be set before switching the StillCaptureMode to interval shooting mode.

Parameters:

timelapseInterval - The shooting interval in msec for interval shooting. The valid range is in 5000-3600000.

Throws:

java.io.IOException

PtpException

getAudioVolume

public long getAudioVolume()
                    throws java.io.IOException,
                           PtpException

Acquires or set the volume for the shutter sound.

Throws:

java.io.IOException

PtpException

setAudioVolume

public void setAudioVolume(long audioVolume)
                    throws java.io.IOException,
                           PtpException

Set the volume for the shutter sound.

Returns to the default value when the power is turned off. // TODO: Confirm the actual behavior.

Parameters:

audioVolume - The volume for the shutter sound. The valid range is in 0-100.

Throws:

java.io.IOException

PtpException

getErrorInfo

public ErrorInfo getErrorInfo()
                       throws java.io.IOException,
                              PtpException

Acquires the error information.

Throws:

java.io.IOException

PtpException

getShutterSpeed

public ShutterSpeed getShutterSpeed()
                             throws java.io.IOException,
                                    PtpException

Acquires the shutter speed.

Throws:

java.io.IOException

PtpException

setShutterSpeed

public void setShutterSpeed(ShutterSpeed shutterSpeed)
                     throws java.io.IOException,
                            PtpException

Sets the shutter speed.

Returns to the default value when the power is turned off.

Parameters:

shutterSpeed - The shutter speed to set.

Throws:

java.io.IOException

PtpException

getGPSInfo

public java.lang.String getGPSInfo()
                            throws java.io.IOException,
                                   PtpException

Acquires the GPS information.

Throws:

java.io.IOException

PtpException

setGPSInfo

public void setGPSInfo(java.lang.String gpsInfo)
                throws java.io.IOException,
                       PtpException

Sets the GPS information.

Returns to the default value when the power is turned off.

Parameters:

gpsInfo - The GPS information to set.

Throws:

java.io.IOException

PtpException

getAutoPowerOffDelay

public int getAutoPowerOffDelay()
                         throws java.io.IOException,
                                PtpException

Acquires the time in minutes to start the auto power off.

Throws:

java.io.IOException

PtpException

setAutoPowerOffDelay

public void setAutoPowerOffDelay(int autoPowerOffDelay)
                          throws java.io.IOException,
                                 PtpException

Sets the time in minutes to start the auto power off.

Parameters:

autoPowerOffDelay - The time in minutes to start the auto power off. The valid range is in 0-30. The 0 disables the auto power off.

Throws:

java.io.IOException

PtpException

getSleepDelay

public int getSleepDelay()
                  throws java.io.IOException,
                         PtpException

Acquires the time in seconds to start sleep.

Throws:

java.io.IOException

PtpException

setSleepDelay

public void setSleepDelay(int sleepDelay)
                   throws java.io.IOException,
                          PtpException

Sets the time in seconds to start sleep.

Parameters:

sleepDelay - The time in seconds to start sleep. The valid range is in 0-1800. Does not switch to sleep mode with 0.

Throws:

java.io.IOException

PtpException

getChannelNumber

public ChannelNumber getChannelNumber()
                               throws java.io.IOException,
                                      PtpException

Acquires the wireless LAN channel number.

Throws:

java.io.IOException

PtpException

setChannelNumber

public void setChannelNumber(ChannelNumber channelNumber)
                      throws java.io.IOException

Sets the wireless LAN channel number.

This operation effects after wireless LAN OFF/ON.

Parameters:

channelNumber - The wireless LAN channel number to set.

Throws:

java.io.IOException

getCaptureStatus

public CaptureStatus getCaptureStatus()
                               throws java.io.IOException,
                                      PtpException

Acquires the camera shooting execution status.

Throws:

java.io.IOException

PtpException

getRecordingTime

public int getRecordingTime()
                     throws java.io.IOException,
                            PtpException

Acquires the video recording time in seconds. (Model: RICOH THETA m15)

Throws:

java.io.IOException

PtpException

getRemainingRecordingTime

public int getRemainingRecordingTime()
                              throws java.io.IOException,
                                     PtpException

Acquires the amount of time remaining in seconds for recording video. (Model: RICOH THETA m15)

Throws:

java.io.IOException

PtpException

addListener

public boolean addListener(ThetaEventListener listener)

Add an event listener.

Parameters:

listener - An event listener to add.

Returns:

true if this instance did not already contain the specified listener.

removeListener

public boolean removeListener(ThetaEventListener listener)

Remove an event listener.

Parameters:

listener - An event listener to add.

Returns:

true if the instance contained the specified listener.

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException