avcap::V4L2_Tuner Class Reference

#include <avcap/linux/V4L2_Tuner.h>

Inheritance diagram for avcap::V4L2_Tuner:

Inheritance graph
[legend]

Detailed Description

Implementation of the Tuner class for Video4Linux2 -devices.


Public Member Functions

 V4L2_Tuner (V4L2_DeviceDescriptor *dd, int index, const std::string &name, int type, int caps, uint high, uint low)
virtual ~V4L2_Tuner ()
bool isRadioTuner () const
 Determine whether the tuner is able to receive radio frequencies.
bool isTVTuner () const
 Determine whether the tuner is able to receive TV frequencies.
int setStereo ()
 Set the audio mode to stereo.
int setMono ()
 Set the audio mode to mono.
int setSAP ()
 Set the audio mode to secondary audio program (SAP).
int setLang1 ()
 Set the audio mode to language 1.
int setLang2 ()
 Set the audio mode to language 2.
double getFreq () const
 Returns the current frequency in MHz.
double getFreqStep () const
 Returns the step with in which the frequency can be increased or decreased.
double getMinFreq () const
 Returns the minimum possible frequency in MHz which can be applied to the tuner.
double getMaxFreq () const
 Returns the maximum possible frequency in MHz which can be applied to the tuner.
const std::string getName () const
 Returns the tuner name.
int finetune (int maxsteps)
 This method tries to readjust and to fine-tune the frequency by means of the current AFC-value.
int getAFCValue () const
 Get the current automatic frequency control (AFC) value.
int getSignalStrength () const
 Return the strength of the signal.
int increaseFreq ()
 Increase the frequency a step corresponding to getFreqStep().
int decreaseFreq ()
 Decrease the frequency a step corresponding to getFreqStep().
int setFreq (double f)
 Set the new frequency. The frequency is given in MHz.


Constructor & Destructor Documentation

avcap::V4L2_Tuner::V4L2_Tuner ( V4L2_DeviceDescriptor dd,
int  index,
const std::string &  name,
int  type,
int  caps,
uint  high,
uint  low 
)

virtual avcap::V4L2_Tuner::~V4L2_Tuner (  )  [virtual]


Member Function Documentation

bool avcap::V4L2_Tuner::isRadioTuner (  )  const [inline, virtual]

Determine whether the tuner is able to receive radio frequencies.

The default implementation returns false.

Returns:
true if radio tuner, false else

Reimplemented from avcap::Tuner.

bool avcap::V4L2_Tuner::isTVTuner (  )  const [inline, virtual]

Determine whether the tuner is able to receive TV frequencies.

The default implementation returns false.

Returns:
true if TV tuner, false else

Reimplemented from avcap::Tuner.

int avcap::V4L2_Tuner::setStereo (  )  [virtual]

Set the audio mode to stereo.

The default implementation is noop and returns -1.

Returns:
0, if successful, -1 else.

Reimplemented from avcap::Tuner.

int avcap::V4L2_Tuner::setMono (  )  [virtual]

Set the audio mode to mono.

Default implementation is noop and return -1.

Returns:
0, if successful, -1 else.

Reimplemented from avcap::Tuner.

int avcap::V4L2_Tuner::setSAP (  )  [virtual]

Set the audio mode to secondary audio program (SAP).

The default implementation is noop and returns -1.

Returns:
0, if successful, -1 else.

Reimplemented from avcap::Tuner.

int avcap::V4L2_Tuner::setLang1 (  )  [virtual]

Set the audio mode to language 1.

The default implementation is noop and returns -1.

Returns:
0, if successful, -1 else.

Reimplemented from avcap::Tuner.

int avcap::V4L2_Tuner::setLang2 (  )  [virtual]

Set the audio mode to language 2.

The default implementation is noop and returns -1.

Returns:
0, if successful, -1 else.

Reimplemented from avcap::Tuner.

double avcap::V4L2_Tuner::getFreq (  )  const [virtual]

Returns the current frequency in MHz.

The default implementation is noop and returns -1.

Returns:
tuner frequency

Reimplemented from avcap::Tuner.

double avcap::V4L2_Tuner::getFreqStep (  )  const [inline, virtual]

Returns the step with in which the frequency can be increased or decreased.

The default implementation is noop and returns -1.

Returns:
frequency step width

Reimplemented from avcap::Tuner.

double avcap::V4L2_Tuner::getMinFreq (  )  const [inline, virtual]

Returns the minimum possible frequency in MHz which can be applied to the tuner.

The default implementation is noop and returns -1.

Returns:
minimal tuner frequency

Reimplemented from avcap::Tuner.

double avcap::V4L2_Tuner::getMaxFreq (  )  const [inline, virtual]

Returns the maximum possible frequency in MHz which can be applied to the tuner.

The default implementation is noop and returns -1.

Returns:
maximal tuner frequency

Reimplemented from avcap::Tuner.

const std::string avcap::V4L2_Tuner::getName (  )  const [inline, virtual]

Returns the tuner name.

Default implementation returns an empty string.

Returns:
tuner name

Reimplemented from avcap::Tuner.

int avcap::V4L2_Tuner::finetune ( int  maxsteps  )  [virtual]

This method tries to readjust and to fine-tune the frequency by means of the current AFC-value.

The default implementation is noop and returns -1.

Returns:
0, if successful, -1 else.

Reimplemented from avcap::Tuner.

int avcap::V4L2_Tuner::getAFCValue (  )  const [virtual]

Get the current automatic frequency control (AFC) value.

If the afc value is negative, the frequency is too low, if positive it is too high. /*! The default implementation is noop and returns -1.

Returns:
afc

Reimplemented from avcap::Tuner.

int avcap::V4L2_Tuner::getSignalStrength (  )  const [virtual]

Return the strength of the signal.

The default implementation is noop and returns -1.

Returns:
signal strength

Reimplemented from avcap::Tuner.

int avcap::V4L2_Tuner::increaseFreq (  )  [virtual]

Increase the frequency a step corresponding to getFreqStep().

The default implementation is noop and returns -1.

Returns:
0, if successful, -1 else.

Reimplemented from avcap::Tuner.

int avcap::V4L2_Tuner::decreaseFreq (  )  [virtual]

Decrease the frequency a step corresponding to getFreqStep().

The default implementation is noop and returns -1.

Returns:
0, if successful, -1 else.

Reimplemented from avcap::Tuner.

int avcap::V4L2_Tuner::setFreq ( double  f  )  [virtual]

Set the new frequency. The frequency is given in MHz.

The default implementation is noop and returns -1.

Parameters:
f The new frequency.
Returns:
0, if successful, -1 else.

Reimplemented from avcap::Tuner.


The documentation for this class was generated from the following file:
Generated on Mon Nov 30 11:10:33 2009 for avcap-0.1 by  doxygen 1.5.1