com.ricoh.camera.sdk.wireless.api

Interface CameraDevice

public interface CameraDevice

This interface for information and operations on a camera device.

While connecting, Storages, Status, Images, CameraDeviceSettings and CaptureSettings are cached and updated in the background.
[Note]
- There are cases that Images is not updated (ex: when an image was deleted). In this case, Images can be updated by updateImages method.

Method Summary

Modifier and Type	Method and Description
void	addEventListener(CameraEventListener listener) Adds the specified event listener to the camera device.
Response	connect(DeviceInterface deviceInterface) Connects the camera device with a specified device interface.
Response	disconnect(DeviceInterface deviceInterface) Disconnects the camera device with a specified device interface.
boolean	equals(java.lang.Object obj)
Response	focus() Does auto-focus.
Response	getCameraDeviceSettings(java.util.List<CameraDeviceSetting> settings) Gets settings for camera device
Response	getCaptureSettings(java.util.List<CaptureSetting> settings) Gets settings for capture
CameraEventListener[]	getEventListeners() Returns the event listeners of the camera device.
java.lang.String	getFirmwareVersion() Returns the firmware version of the camera device.
java.util.List<CameraImage>	getImages() Returns latest cached image list retrieved from the camera device.
java.lang.String	getManufacturer() Returns the manufacturer of the camera device.
java.lang.String	getModel() Returns the model of the camera device.
java.lang.String	getSerialNumber() Returns the serial number of the camera device.
CameraStatus	getStatus() Returns the status of the camera device.
java.util.List<CameraStorage>	getStorages() Returns the storages of the camera device.
boolean	isConnected(DeviceInterface deviceInterface) Returns true if the camera device is connected by the interface.
void	removeEventListener(CameraEventListener listener) Removes the specified event listener from the camera device.
Response	setCameraDeviceSettings(java.util.List<CameraDeviceSetting> settings) Sets settings for camera device
Response	setCaptureSettings(java.util.List<CaptureSetting> settings) Sets settings for capture
StartCaptureResponse	startCapture(boolean withFocus) Starts a capture.
Response	startLiveView() Starts liveview.
Response	stopCapture() Stops the capture.
Response	stopLiveView() Stops liveview.
Response	updateImages() Updates a cache of image list with retrieving from the camera device.

Method Detail

getManufacturer

java.lang.String getManufacturer()

Returns the manufacturer of the camera device.

Returns:

The manufacturer

getModel

java.lang.String getModel()

Returns the model of the camera device.

Returns:

The model

getFirmwareVersion

java.lang.String getFirmwareVersion()

Returns the firmware version of the camera device.

Returns:

The firmware version

getSerialNumber

java.lang.String getSerialNumber()

Returns the serial number of the camera device.

Returns:

The serial number

addEventListener

void addEventListener(CameraEventListener listener)

Adds the specified event listener to the camera device.

Parameters:

listener - The event listener

removeEventListener

void removeEventListener(CameraEventListener listener)

Removes the specified event listener from the camera device.

Parameters:

listener - The event listener

getEventListeners

CameraEventListener[] getEventListeners()

Returns the event listeners of the camera device.

Returns:

The event listeners

getStorages

java.util.List<CameraStorage> getStorages()

Returns the storages of the camera device.

Returns:

The storages

getStatus

CameraStatus getStatus()

Returns the status of the camera device.

Returns:

The status

getImages

java.util.List<CameraImage> getImages()

Returns latest cached image list retrieved from the camera device.

Returns:

The images

updateImages

Response updateImages()

Updates a cache of image list with retrieving from the camera device.

Returns:

The operation response

connect

Response connect(DeviceInterface deviceInterface)

Connects the camera device with a specified device interface.

Parameters:

deviceInterface - The interface for connection

Returns:

The operation response

disconnect

Response disconnect(DeviceInterface deviceInterface)

Disconnects the camera device with a specified device interface.

Parameters:

deviceInterface - The interface for connection

Returns:

The operation response

isConnected

boolean isConnected(DeviceInterface deviceInterface)

Returns true if the camera device is connected by the interface.

Parameters:

deviceInterface - The interface for connection

Returns:

true If the camera device is connected by the interface and false otherwise

startLiveView

Response startLiveView()

Starts liveview. LiveViewFrames are received by CameraEventListener class.

Returns:

The operation response

stopLiveView

Response stopLiveView()

Stops liveview.

Returns:

The operation response

focus

Response focus()

Does auto-focus.

Returns:

The operation response

Throws:

java.lang.UnsupportedOperationException - If the camera device is not supported

startCapture

StartCaptureResponse startCapture(boolean withFocus)

Starts a capture. This behavior is different depends on the CaptureMethod.
If a capture has been started with CaptureMethod:MOVIE, the capture is stopped by stopCapture method.

Parameters:

withFocus - true If capturing with doing auto-focus (Only valid for CaptureMethod:STILL_IMAGE)

Returns:

The operation response having the capture

Throws:

java.lang.UnsupportedOperationException - If the camera device is not supported

stopCapture

Response stopCapture()

Stops the capture. If a capture has been started with CaptureMethod:MOVIE, the capture is stopped by this method.

Returns:

The operation response

Throws:

java.lang.UnsupportedOperationException - If the camera device is not supported

getCaptureSettings

Response getCaptureSettings(java.util.List<CaptureSetting> settings)

Gets settings for capture

Parameters:

settings - The settings

Returns:

The operation response

setCaptureSettings

Response setCaptureSettings(java.util.List<CaptureSetting> settings)

Sets settings for capture

Parameters:

settings - The settings

Returns:

The operation response

getCameraDeviceSettings

Response getCameraDeviceSettings(java.util.List<CameraDeviceSetting> settings)

Gets settings for camera device

Parameters:

settings - The settings

Returns:

The operation response

setCameraDeviceSettings

Response setCameraDeviceSettings(java.util.List<CameraDeviceSetting> settings)

Sets settings for camera device

Parameters:

settings - The settings

Returns:

The operation response

equals

boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object