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

A class to handle callbacks of the eyetracking camera. More...

#include <xv-sdk.h>

Public Types

using Data = EyetrackingImage const &
 

Public Member Functions

virtual bool setExposure (int leftGain, float leftTimeMs, int rightGain, float rightTimeMs)=0
 Set eyetracking exposure. More...
 
virtual bool setLedBrighness (int eye, int led, int brightness)=0
 Set eyetracking led brightness (in s) More...
 
virtual bool start ()=0
 start streaming.
 
virtual bool stop ()=0
 stop streaming.
 
virtual int registerCallback (std::function< void(EyetrackingImage 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 eyetracking camera.

Member Function Documentation

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.

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]
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
virtual bool xv::EyetrackingCamera::setExposure ( int  leftGain,
float  leftTimeMs,
int  rightGain,
float  rightTimeMs 
)
pure virtual

Set eyetracking exposure.

Parameters
[in]leftGainLeft eye exposure gain, [0, 255]
[in]leftTimeMsLeft eye exposure time, in milliseconds
[in]rightGainRight eye exposure gain, [0, 255]
[in]rightTimeMsRight eye exposure time, in milliseconds
virtual bool xv::EyetrackingCamera::setLedBrighness ( int  eye,
int  led,
int  brightness 
)
pure virtual

Set eyetracking led brightness (in s)

Parameters
[in]eye0:left, 1:right, 2:both
[in]led[0,7]:led index, 8:all
[in]brightness[0,255], 0 is off

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