xvsdk  3.2.0
Public Types | Public Member Functions | List of all members
xv::ColorCamera Class Referenceabstract

A class to handle callbacks of the color image. More...

#include <xv-sdk.h>

Public Types

enum class  Resolution {
  RGB_1920x1080 = 0 , RGB_1280x720 = 1 , RGB_640x480 = 2 , RGB_320x240 = 3 ,
  RGB_2560x1920 = 4 , RGB_3840x2160 = 5
}
 
enum class  Mode { AF , MF , Unknown }
 
using Data = ColorImage const &
 

Public Member Functions

virtual bool setCompensation (int compensation)=0
 
virtual bool setAwb (int awb)=0
 
virtual bool setResolution (const Resolution &resolution)=0
 
virtual bool isSupportAFRGB ()=0
 
virtual bool setRGBMode (const Mode &mode)=0
 
virtual bool setRGBFocalDistance (unsigned char distance)=0
 
virtual bool startCameras (int camIndex=1)=0
 
virtual bool stopCameras (int camIndex=1)=0
 
virtual bool setCamsResolution (const xv::ColorCamera::Resolution &resolution, int camIndex=1)=0
 
virtual bool setCamsFramerate (float framerate, int camIndex=1)=0
 
virtual int registerCam2Callback (std::function< void(ColorImage const &)> c)=0
 
virtual bool unregisterCam2Callback (int callbackID)=0
 
virtual bool start ()=0
 start streaming.
 
virtual bool stop ()=0
 stop streaming.
 
virtual int registerCallback (std::function< void(ColorImage const &)>)=0
 Register callback to receive data.
 
virtual bool unregisterCallback (int callbackId)=0
 Unregister callback.
 
virtual const std::vector< Calibration > & calibration ()
 Get the camera calibration. More...
 
virtual bool setResolution (int resolution)
 
virtual bool setFramerate (float framerate)
 
virtual bool setExposure (int aecMode=0, int exposureGain=0, float exposureTimeMs=0.0)
 Exposure setting. More...
 
virtual bool setBrightness (int brightness)
 Set output image brightness. Only valid in auto exposure mode. More...
 

Detailed Description

A class to handle callbacks of the color image.

Member Enumeration Documentation

◆ Resolution

Enumerator
RGB_1920x1080 

RGB 1080p.

RGB_1280x720 

RGB 720p.

RGB_640x480 

RGB 480p.

RGB_320x240 

RGB QVGA (not supported now)

RGB_2560x1920 

RGB 5m (not supported now)

Member Function Documentation

◆ calibration()

virtual const std::vector<Calibration>& xv::Camera::calibration ( )
virtualinherited

Get the camera calibration.

The frames coordinates are defined according to the IMU frame coordinates. If 2 fisheyes cameras the first is left and second is right camera.

◆ setBrightness()

virtual bool xv::Camera::setBrightness ( int  brightness)
virtualinherited

Set output image brightness. Only valid in auto exposure mode.

Parameters
[in]brightnessbrightness of image, [0,255]

◆ setExposure()

virtual bool xv::Camera::setExposure ( int  aecMode = 0,
int  exposureGain = 0,
float  exposureTimeMs = 0.0 
)
virtualinherited

Exposure setting.

Parameters
[in]aecMode0:auto exposure 1:manual exposure
[in]exposureGainOnly valid in manual exposure mode, [0,255]
[in]exposureTimeMsOnly valid in manual exposure mode, in milliseconds

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