Manipulates the underlying camera system. More...

#include <camera.h>

Public Member Functions
virtual	~Camera ()=default
	Destructor.

virtual Status	initialize ()=0
	Initialize the camera. This is required before performing any operation on the camera. More...

virtual Status	start ()=0
	Start the camera. This starts the streaming of data from the camera. More...

virtual Status	stop ()=0
	Stop the camera. This makes the camera to stop streaming. More...

virtual Status	setMode (const std::string &mode, const std::string &modeFilename={})=0
	Puts the camera into the given mode. More...

virtual Status	getAvailableModes (std::vector< std::string > &availableModes) const =0
	Returns all the modes that are supported by the camera. More...

virtual Status	setFrameType (const std::string &frameType)=0
	Set the camera frame type to the given type. More...

virtual Status	getAvailableFrameTypes (std::vector< std::string > &availableFrameTypes) const =0
	Returns all the frame types that are supported by the camera. More...

virtual Status	requestFrame (Frame *frame, FrameUpdateCallback cb=nullptr)=0
	Captures data from the camera and assigns it to the given frame. If cb parameter is not given this operation will be blocking. If a callback is provided this operation will be unblocking and once the data for the frame is ready, an internal thread will call the specified callback. More...

virtual Status	getDetails (CameraDetails &details) const =0
	Gets the current details of the camera. More...

virtual Status	getAvailableControls (std::vector< std::string > &controls) const =0
	Gets the camera's list of controls. More...

virtual Status	setControl (const std::string &control, const std::string &value)=0
	Sets a specific camera control. More...

virtual Status	getControl (const std::string &control, std::string &value) const =0
	Gets the value of a specific camera control. More...

virtual Status	getImageSensors (std::vector< std::shared_ptr< DepthSensorInterface >> &sensors)=0
	Gets the image sensor of the camera. This gives direct access to low level configuration of the camera sensor(s). More...

virtual Status	getEeproms (std::vector< std::shared_ptr< StorageInterface >> &eeproms)=0
	Gets the eeprom(s) used internally by the camera. This gives direct access to the eeprom(s) of the camera. More...

virtual Status	getTemperatureSensors (std::vector< std::shared_ptr< TemperatureSensorInterface >> &sensors)=0
	Gets the temperature sensors used internally by the camera. This gives direct access to the temperature sensor(s) of the camera. More...

Detailed Description

Manipulates the underlying camera system.

Definition at line 54 of file camera.h.

Member Function Documentation

◆ getAvailableControls()

virtual Status aditof::Camera::getAvailableControls ( std::vector< std::string > & controls ) const

pure virtual

Gets the camera's list of controls.

Parameters

[out] controls

Returns: Status

◆ getAvailableFrameTypes()

virtual Status aditof::Camera::getAvailableFrameTypes ( std::vector< std::string > & availableFrameTypes ) const

pure virtual

Returns all the frame types that are supported by the camera.

Parameters

[out] availableFrameTypes

Returns: Status

◆ getAvailableModes()

virtual Status aditof::Camera::getAvailableModes ( std::vector< std::string > & availableModes ) const

pure virtual

Returns all the modes that are supported by the camera.

Parameters

[out] availableModes

Returns: Status

◆ getControl()

virtual Status aditof::Camera::getControl	(	const std::string &	control,
		std::string &	value
	)		const

pure virtual

Gets the value of a specific camera control.

Parameters

[in]	control	- Control name
[out]	value	- Control value

Returns: Status

◆ getDetails()

virtual Status aditof::Camera::getDetails ( CameraDetails & details ) const

pure virtual

Gets the current details of the camera.

Parameters

[out] details

Returns: Status

◆ getEeproms()

virtual Status aditof::Camera::getEeproms ( std::vector< std::shared_ptr< StorageInterface >> & eeproms )

pure virtual

Gets the eeprom(s) used internally by the camera. This gives direct access to the eeprom(s) of the camera.

Parameters

[out] eeproms - List of internal eeproms

Returns: Status

◆ getImageSensors()

virtual Status aditof::Camera::getImageSensors ( std::vector< std::shared_ptr< DepthSensorInterface >> & sensors )

pure virtual

Gets the image sensor of the camera. This gives direct access to low level configuration of the camera sensor(s).

Parameters

[out] sensors - List of internal image sensors

Returns: Status

◆ getTemperatureSensors()

virtual Status aditof::Camera::getTemperatureSensors ( std::vector< std::shared_ptr< TemperatureSensorInterface >> & sensors )

pure virtual

Gets the temperature sensors used internally by the camera. This gives direct access to the temperature sensor(s) of the camera.

Parameters

[out] sensors - List of internal temperature sensors

Returns: Status

◆ initialize()

virtual Status aditof::Camera::initialize ( )

pure virtual

Initialize the camera. This is required before performing any operation on the camera.

Returns: Status

◆ requestFrame()

virtual Status aditof::Camera::requestFrame	(	Frame *	frame,
		FrameUpdateCallback	cb = `nullptr`
	)

pure virtual

Captures data from the camera and assigns it to the given frame. If cb parameter is not given this operation will be blocking. If a callback is provided this operation will be unblocking and once the data for the frame is ready, an internal thread will call the specified callback.

Parameters

frame	- The frame to which the camera data should be assign
cb	- Callback to be called when frame is updated

Returns: Status

◆ setControl()

virtual Status aditof::Camera::setControl	(	const std::string &	control,
		const std::string &	value
	)

pure virtual

Sets a specific camera control.

Parameters

[in]	control	- Control name
[in]	value	- Control value

Returns: Status

◆ setFrameType()

virtual Status aditof::Camera::setFrameType ( const std::string & frameType )

pure virtual

Set the camera frame type to the given type.

Parameters

frameType - The frame type of the camera

Returns: Status

◆ setMode()

virtual Status aditof::Camera::setMode	(	const std::string &	mode,
		const std::string &	modeFilename = `{}`
	)

pure virtual

Puts the camera into the given mode.

Parameters

mode	- The mode of the camera
modeFilename	- When there is a need to use a custom mode then mode parameter needs to be set to 'custom' and a firmware file needs to be provided.

Returns: Status

◆ start()

virtual Status aditof::Camera::start ( )

pure virtual

Start the camera. This starts the streaming of data from the camera.

Returns: Status

◆ stop()

virtual Status aditof::Camera::stop ( )

pure virtual

Stop the camera. This makes the camera to stop streaming.

Returns: Status

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

/home/vsts/work/1/s/sdk/include/aditof/camera.h

Public Member Functions

Detailed Description

Member Function Documentation

◆ getAvailableControls()

◆ getAvailableFrameTypes()

◆ getAvailableModes()

◆ getControl()

◆ getDetails()

◆ getEeproms()

◆ getImageSensors()

◆ getTemperatureSensors()

◆ initialize()

◆ requestFrame()

◆ setControl()

◆ setFrameType()

◆ setMode()

◆ start()

◆ stop()