EyaParameters Class Reference

Eya main parameters class. More...

#include <eyaparameters.h>

List of all members.

Public Types
enum	WATERMARK_POSITION {   NONE, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT,   BOTTOM_RIGHT }
Public Member Functions
	EyaParameters ()
	Constructor: the values are loaded from the .conf file.
	~EyaParameters ()
	Destructor: the values are stored in the .conf file.
void	setVideoDevice (QString)
QString	getVideoDevice ()
QString	getVideoFormat ()
QString	getVideoResolution ()
QString	getVideoFrameRate ()
QString	getVideoBps ()
int	getVideoWidth ()
int	getVideoHeight ()
void	setAudioDevice (QString str)
QString	getAudioDevice ()
QString	getAudioFormat ()
QString	getAudioBps ()
bool	isAudioEnabled ()
void	setAudioEnabled (bool s)
void	setSoftGain (int g)
QString	getSoftGain ()
void	setPhotoZoom (int)
void	setPhotoModel (QString)
QString	getPhotoModel ()
QString	getPhotoPort ()
int	getCurrentPhotoIntervalIdx ()
void	setCurrentPhotoIntervalIdx (int idx)
QString	getPhotoInterval (int)
void	setPhotoInterval (int ind, int value)
WATERMARK_POSITION	getWatermarkPos ()
void	setWatermarkPos (enum WATERMARK_POSITION p)
void	setDuration (int)
QString	getDuration ()
QString	getWorkingDirectory ()
void	setWorkingDirectory (QString path)
QString	getProcessingInput ()
void	setProcessingInput (QString path)
QString	getProcessingOutput ()
void	setProcessingOutput (QString path)
bool	getCloseCameraAfterRecording ()
void	setCloseCameraAfterRecording (bool s)
QString	getWatermarking ()
Public Attributes
QString	fileName
Private Attributes
QString	audioDevice
	This identifies the device: /dev/dspX.
QString	audioFormat
	Read from the config file: usually OSS.
int	audioFrequency
	The sampling rate: read from OpenEyA.conf.
int	audioBps
	The bitrate of the audio stream.
bool	flagEnabledAudio
	Only for test: you can disable the audio acquisition.
int	softGain
	Soft gain value, not saved.
QString	videoDevice
	This identifies the video dev: /dev/videoX.
QString	videoFormat
	v4l2 or v4l
int	videoXRes
int	videoYRes
int	videoFps
	The video frame rate.
int	videoBps
	The bitrate of the video stream.
QString	photoModel
QString	photoPort
int	photoInterval [4]
	The photo intervals for the recordings of respectively 15, 30, 45 and 60 minutes.
int	currentPhotoInterval
	The current photo interval.
int	photoZoom
	The current photo zoom (set by the settingstab): not saved.
WATERMARK_POSITION	watermarkPos
	The position of the watermark: not saved.
unsigned long	duration
	Duration of the recording: used only by the alarms.
QDir	workingDirectory
	Working dir for the recording step.
QDir	processingInput
	Input dir for the processing step.
QDir	processingOutput
	Output dir for the processing step.
bool	closeCameraAfterRecording
	To close the camera when the program exits.
QString	watermarking
	The filename of the watermark.

---

Detailed Description

Eya main parameters class.

This class implements members and methods to manage the most important parameters of openeya. This class stores and loads the parameters by using the QSettings class. The main parameters variable is common to the other classes via an "extern" declaration (mainParams).

---

Member Enumeration Documentation

enum EyaParameters::WATERMARK_POSITION

Enumerator:

NONE
TOP_LEFT
TOP_RIGHT
BOTTOM_LEFT
BOTTOM_RIGHT

---

Constructor & Destructor Documentation

EyaParameters::EyaParameters

(

)

Constructor: the values are loaded from the .conf file.

EyaParameters::~EyaParameters

(

)

Destructor: the values are stored in the .conf file.

---

Member Function Documentation

QString EyaParameters::getAudioBps

(

)

QString EyaParameters::getAudioDevice

(

)

QString EyaParameters::getAudioFormat

(

)

bool EyaParameters::getCloseCameraAfterRecording

(

)

[inline]

int EyaParameters::getCurrentPhotoIntervalIdx

(

)

[inline]

QString EyaParameters::getDuration

(

)

QString EyaParameters::getPhotoInterval

(

int

ind

)

QString EyaParameters::getPhotoModel

(

)

QString EyaParameters::getPhotoPort

(

)

QString EyaParameters::getProcessingInput

(

)

[inline]

QString EyaParameters::getProcessingOutput

(

)

[inline]

QString EyaParameters::getSoftGain

(

)

[inline]

QString EyaParameters::getVideoBps

(

)

QString EyaParameters::getVideoDevice

(

)

QString EyaParameters::getVideoFormat

(

)

QString EyaParameters::getVideoFrameRate

(

)

int EyaParameters::getVideoHeight

(

)

[inline]

QString EyaParameters::getVideoResolution

(

)

int EyaParameters::getVideoWidth

(

)

[inline]

QString EyaParameters::getWatermarking

(

)

[inline]

WATERMARK_POSITION EyaParameters::getWatermarkPos

(

)

[inline]

QString EyaParameters::getWorkingDirectory

(

)

[inline]

bool EyaParameters::isAudioEnabled

(

)

[inline]

void EyaParameters::setAudioDevice

(

QString

str

)

[inline]

void EyaParameters::setAudioEnabled

(

bool

s

)

[inline]

void EyaParameters::setCloseCameraAfterRecording

(

bool

s

)

[inline]

void EyaParameters::setCurrentPhotoIntervalIdx

(

int

idx

)

[inline]

void EyaParameters::setDuration

(

int

s

)

void EyaParameters::setPhotoInterval	(	int	ind,
		int	value
	)			[inline]

void EyaParameters::setPhotoModel

(

QString

m

)

void EyaParameters::setPhotoZoom

(

int

z

)

void EyaParameters::setProcessingInput

(

QString

path

)

[inline]

void EyaParameters::setProcessingOutput

(

QString

path

)

[inline]

void EyaParameters::setSoftGain

(

int

g

)

[inline]

void EyaParameters::setVideoDevice

(

QString

dev

)

void EyaParameters::setWatermarkPos

(

enum WATERMARK_POSITION

p

)

[inline]

void EyaParameters::setWorkingDirectory

(

QString

path

)

[inline]

---

Member Data Documentation

int EyaParameters::audioBps [private]

The bitrate of the audio stream.

QString EyaParameters::audioDevice [private]

This identifies the device: /dev/dspX.

QString EyaParameters::audioFormat [private]

Read from the config file: usually OSS.

int EyaParameters::audioFrequency [private]

The sampling rate: read from OpenEyA.conf.

bool EyaParameters::closeCameraAfterRecording [private]

To close the camera when the program exits.

int EyaParameters::currentPhotoInterval [private]

The current photo interval.

unsigned long EyaParameters::duration [private]

Duration of the recording: used only by the alarms.

QString EyaParameters::fileName

bool EyaParameters::flagEnabledAudio [private]

Only for test: you can disable the audio acquisition.

int EyaParameters::photoInterval[4] [private]

The photo intervals for the recordings of respectively 15, 30, 45 and 60 minutes.

QString EyaParameters::photoModel [private]

QString EyaParameters::photoPort [private]

int EyaParameters::photoZoom [private]

The current photo zoom (set by the settingstab): not saved.

QDir EyaParameters::processingInput [private]

Input dir for the processing step.

QDir EyaParameters::processingOutput [private]

Output dir for the processing step.

int EyaParameters::softGain [private]

Soft gain value, not saved.

int EyaParameters::videoBps [private]

The bitrate of the video stream.

QString EyaParameters::videoDevice [private]

This identifies the video dev: /dev/videoX.

QString EyaParameters::videoFormat [private]

v4l2 or v4l

int EyaParameters::videoFps [private]

The video frame rate.

int EyaParameters::videoXRes [private]

int EyaParameters::videoYRes [private]

QString EyaParameters::watermarking [private]

The filename of the watermark.

WATERMARK_POSITION EyaParameters::watermarkPos [private]

The position of the watermark: not saved.

QDir EyaParameters::workingDirectory [private]

Working dir for the recording step.

---

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

• eyaparameters.h
• eyaparameters.cpp