The class for information and operations on a camera device. More...

#include <ricoh_camera_sdk/camera_device.hpp>

Public Member Functions
virtual	~CameraDevice ()=default

virtual bool	operator== (const CameraDevice &obj) const =0

virtual bool	operator!= (const CameraDevice &obj) const =0

virtual Response	connect (DeviceInterface deviceInterface)=0
	Connects the camera device with a specified device interface. More...

virtual Response	disconnect (DeviceInterface deviceInterface)=0
	Disconnects the camera device with a specified device interface. More...

virtual bool	isConnected (DeviceInterface deviceInterface) const =0
	Returns `true` if the camera device is connected by the interface. More...

virtual const std::string &	getManufacturer () const =0
	Returns the manufacturer of the camera device. More...

virtual const std::string &	getModel () const =0
	Returns the model of the camera device. More...

virtual const std::string &	getFirmwareVersion () const =0
	Returns the serial number of the camera device. More...

virtual const std::string &	getSerialNumber () const =0
	Returns the serial number of the camera device. More...

virtual const CameraStatus &	getStatus () const =0
	Returns the status of the camera device. More...

virtual const CameraStorageList &	getStorages () const =0
	Returns the storage list of the camera device. More...

virtual const CameraImageList &	getImages () const =0
	Returns the image information list. More...

virtual void	addEventListener (const std::shared_ptr< CameraEventListener > &listener)=0
	Adds the specified event listener to the camera device. More...

virtual void	removeEventListener (const std::shared_ptr< CameraEventListener > &listener)=0
	Removes the specified event listener from the camera device. More...

virtual const std::vector< std::shared_ptr< CameraEventListener > > &	getEventListeners () const =0
	Returns the event listeners of the camera device. More...

virtual Response	focus ()=0
	Performs auto focus. More...

virtual Response	focus (const Point &point)=0
	Performs auto focus at specified focus point. More...

virtual Response	focus (int adjustment)=0
	Adjusts focus. More...

virtual StartCaptureResponse	startCapture (bool withFocus=true)=0
	Starts a capture. More...

virtual StartCaptureResponse	startCapture (const Point &point)=0
	Starts a capture with doing auto-focus at specified focus point. More...

virtual Response	stopCapture ()=0
	Stop a capture. More...

virtual Response	startLiveView ()=0
	Starts a live view. More...

virtual Response	stopLiveView ()=0
	Stops a live view. More...

virtual Response	getCameraDeviceSettings (const std::vector< CameraDeviceSetting * > &settings) const =0
	Gets settings for camera device. More...

virtual Response	setCameraDeviceSettings (const std::vector< const CameraDeviceSetting * > &settings) const =0
	Sets settings for camera device. More...

virtual Response	getCaptureSettings (const std::vector< CaptureSetting * > &settings) const =0
	Gets settings for capture. More...

virtual Response	setCaptureSettings (const std::vector< const CaptureSetting * > &settings) const =0
	Sets settings for capture. More...

Detailed Description

The class for information and operations on a camera device.

Constructor & Destructor Documentation

virtual Ricoh::CameraController::CameraDevice::~CameraDevice ( )

virtualdefault

Member Function Documentation

virtual void Ricoh::CameraController::CameraDevice::addEventListener ( const std::shared_ptr< CameraEventListener > & listener )

pure virtual

Adds the specified event listener to the camera device.

Parameters

listener The event listener

virtual Response Ricoh::CameraController::CameraDevice::connect ( DeviceInterface deviceInterface )

pure virtual

Connects the camera device with a specified device interface.

Parameters

deviceInterface The interface for connection

Returns: The operation response

virtual Response Ricoh::CameraController::CameraDevice::disconnect ( DeviceInterface deviceInterface )

pure virtual

Disconnects the camera device with a specified device interface.

Parameters

deviceInterface The interface for connection

Returns: The operation response

virtual Response Ricoh::CameraController::CameraDevice::focus ( )

pure virtual

Performs auto focus.

Returns: The operation response

virtual Response Ricoh::CameraController::CameraDevice::focus ( const Point & point )

pure virtual

Performs auto focus at specified focus point.

Parameters

point The focus point.

Returns: The operation response

virtual Response Ricoh::CameraController::CameraDevice::focus ( int adjustment )

pure virtual

Adjusts focus.

Parameters

adjustment The movement of image surface

Returns: The operation response

virtual Response Ricoh::CameraController::CameraDevice::getCameraDeviceSettings ( const std::vector< CameraDeviceSetting * > & settings ) const

pure virtual

Gets settings for camera device.

Parameters

settings The settings

Returns: The operation response

virtual Response Ricoh::CameraController::CameraDevice::getCaptureSettings ( const std::vector< CaptureSetting * > & settings ) const

pure virtual

Gets settings for capture.

Parameters

settings The settings

Returns: The operation response

virtual const std::vector<std::shared_ptr<CameraEventListener> >& Ricoh::CameraController::CameraDevice::getEventListeners ( ) const

pure virtual

Returns the event listeners of the camera device.

Returns: The event listeners

virtual const std::string& Ricoh::CameraController::CameraDevice::getFirmwareVersion ( ) const

pure virtual

Returns the serial number of the camera device.

virtual const CameraImageList& Ricoh::CameraController::CameraDevice::getImages ( ) const

pure virtual

Returns the image information list.

Image list is updated automatically while connected in the background.

Returns: The image list

virtual const std::string& Ricoh::CameraController::CameraDevice::getManufacturer ( ) const

pure virtual

Returns the manufacturer of the camera device.

virtual const std::string& Ricoh::CameraController::CameraDevice::getModel ( ) const

pure virtual

Returns the model of the camera device.

virtual const std::string& Ricoh::CameraController::CameraDevice::getSerialNumber ( ) const

pure virtual

Returns the serial number of the camera device.

virtual const CameraStatus& Ricoh::CameraController::CameraDevice::getStatus ( ) const

pure virtual

Returns the status of the camera device.

Returns: The status

virtual const CameraStorageList& Ricoh::CameraController::CameraDevice::getStorages ( ) const

pure virtual

Returns the storage list of the camera device.

Returns: The storage list

virtual bool Ricoh::CameraController::CameraDevice::isConnected ( DeviceInterface deviceInterface ) const

pure virtual

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

virtual bool Ricoh::CameraController::CameraDevice::operator!= ( const CameraDevice & obj ) const

pure virtual

virtual bool Ricoh::CameraController::CameraDevice::operator== ( const CameraDevice & obj ) const

pure virtual

virtual void Ricoh::CameraController::CameraDevice::removeEventListener ( const std::shared_ptr< CameraEventListener > & listener )

pure virtual

Removes the specified event listener from the camera device.

Parameters

listener The event listener

virtual Response Ricoh::CameraController::CameraDevice::setCameraDeviceSettings ( const std::vector< const CameraDeviceSetting * > & settings ) const

pure virtual

Sets settings for camera device.

Parameters

settings The settings

Returns: The operation response

virtual Response Ricoh::CameraController::CameraDevice::setCaptureSettings ( const std::vector< const CaptureSetting * > & settings ) const

pure virtual

Sets settings for capture.

Parameters

settings The settings

Returns: The operation response

virtual StartCaptureResponse Ricoh::CameraController::CameraDevice::startCapture ( bool withFocus = true )

pure virtual

Starts a capture.

Parameters

withFocus true If capturing with doing auto-focus. Default value is true.

Returns: The operation response having the capture

virtual StartCaptureResponse Ricoh::CameraController::CameraDevice::startCapture ( const Point & point )

pure virtual

Starts a capture with doing auto-focus at specified focus point.

Parameters

point The focus point.

Returns: The operation response having the capture

virtual Response Ricoh::CameraController::CameraDevice::startLiveView ( )

pure virtual

Starts a live view.

Returns: The operation response

virtual Response Ricoh::CameraController::CameraDevice::stopCapture ( )

pure virtual

Stop a capture.

Returns: The operation response

virtual Response Ricoh::CameraController::CameraDevice::stopLiveView ( )

pure virtual

Stops a live view.

Returns: The operation response

The documentation for this class was generated from the following file:

include/ricoh_camera_sdk/camera_device.hpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation