SR::CameraController Class Reference

Interface defining camera functions to control sensor parameters. More...

#include <cameracontroller.h>

Inheritance diagram for SR::CameraController:

Public Member Functions
virtual void	setShuttertime (float shutterTime)=0
	Set camera shutter / exposure time in seconds. More...
virtual void	setGain (float gain)=0
	Set camera gain. More...
virtual float	getShuttertime ()=0
	Get current shutter / exposure time in seconds. More...
virtual float	getGain ()=0
	Get current camera gain factor. More...

Static Public Member Functions
static void	addImplementation (CameraControlFunction *controlFunction, std::string cameraType)
	Static function to make a CameraController implementation available through the CameraController::control function. More...
static UniqueCameraController	control (Camera *camera)
	Attempt to gain control of camera sensor. More...

Detailed Description

Interface defining camera functions to control sensor parameters.

Member Function Documentation

addImplementation()

static void SR::CameraController::addImplementation ( CameraControlFunction *  controlFunction, std::string  cameraType  )

static

Static function to make a CameraController implementation available through the CameraController::control function.

Parameters

controlFunction	is one of the functions that can be called when CameraController::control is called for a camera of the right type
cameraType	indicates when this controlFunction should be used

control()

static UniqueCameraController SR::CameraController::control ( Camera *  camera )

static

Attempt to gain control of camera sensor.

Parameters

camera

refers to a Camera instance that has already been created

Exceptions

CameraControllerUnavailableException

if the camera is already being controlled or if the camera can not be controlled

Returns

non-copyable UniqueCameraController object that provides access to CameraController interface until it goes out of scope

getGain()

virtual float SR::CameraController::getGain ( )

pure virtual

Get current camera gain factor.

A higher gain will produce brighter images but may affect image quality. Values produced by the sensor are multiplied by a factor derived from this gain value Implementations may vary.

Returns

current camera gain factor

Implemented in SR::UniqueCameraController.

getShuttertime()

virtual float SR::CameraController::getShuttertime ( )

pure virtual

Get current shutter / exposure time in seconds.

A higher shutter time will produce brighter images but may increase latency. The effectiveness of changing the shutter time is also dependent on the aperture of the camera.

Returns

current shutter / exposure time in seconds

Implemented in SR::UniqueCameraController.

setGain()

virtual void SR::CameraController::setGain ( float  gain )

pure virtual

Set camera gain.

A higher gain will produce brighter images but may affect image quality. Values produced by the sensor are multiplied by a factor derived from this gain value. Implementations may vary.

Implemented in SR::UniqueCameraController.

setShuttertime()

virtual void SR::CameraController::setShuttertime ( float  shutterTime )

pure virtual

Set camera shutter / exposure time in seconds.

A higher shutter time will produce brighter images but may increase latency. The effectiveness of changing the shutter time is also dependent on the aperture of the camera.

Parameters

shutterTime

in seconds

Implemented in SR::UniqueCameraController.

---

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

• cameracontroller.h