avcap::Tuner Class Reference

#include <avcap/Tuner_avcap.h>

Inheritance diagram for avcap::Tuner:

Inheritance graph
[legend]

Detailed Description

Interface of a tuner.

This class provides access to the tuner functionality of TV or Radio-cards. Applications can adjust things like frequency, audio mode etc. Applications don't create Tuner objects themselfes but get them from the Connector the tuner is associated with. The connector in turn can be obtained from the ConnectorManager of the CaptureDevice.


Public Member Functions

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


Constructor & Destructor Documentation

virtual avcap::Tuner::~Tuner (  )  [inline, virtual]


Member Function Documentation

virtual bool avcap::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 in avcap::V4L2_Tuner, and avcap::DS_Tuner.

virtual bool avcap::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 in avcap::V4L2_Tuner, and avcap::DS_Tuner.

virtual int avcap::Tuner::setStereo (  )  [inline, virtual]

Set the audio mode to stereo.

The default implementation is noop and returns -1.

Returns:
0, if successful, -1 else.

Reimplemented in avcap::V4L2_Tuner, and avcap::DS_Tuner.

virtual int avcap::Tuner::setMono (  )  [inline, virtual]

Set the audio mode to mono.

Default implementation is noop and return -1.

Returns:
0, if successful, -1 else.

Reimplemented in avcap::V4L2_Tuner, and avcap::DS_Tuner.

virtual int avcap::Tuner::setSAP (  )  [inline, 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 in avcap::V4L2_Tuner, and avcap::DS_Tuner.

virtual int avcap::Tuner::setLang1 (  )  [inline, virtual]

Set the audio mode to language 1.

The default implementation is noop and returns -1.

Returns:
0, if successful, -1 else.

Reimplemented in avcap::V4L2_Tuner, and avcap::DS_Tuner.

virtual int avcap::Tuner::setLang2 (  )  [inline, virtual]

Set the audio mode to language 2.

The default implementation is noop and returns -1.

Returns:
0, if successful, -1 else.

Reimplemented in avcap::V4L2_Tuner, and avcap::DS_Tuner.

virtual double avcap::Tuner::getFreq (  )  const [inline, virtual]

Returns the current frequency in MHz.

The default implementation is noop and returns -1.

Returns:
tuner frequency

Reimplemented in avcap::V4L2_Tuner, and avcap::DS_Tuner.

virtual double avcap::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 in avcap::V4L2_Tuner, and avcap::DS_Tuner.

virtual double avcap::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 in avcap::V4L2_Tuner, and avcap::DS_Tuner.

virtual double avcap::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 in avcap::V4L2_Tuner, and avcap::DS_Tuner.

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

Returns the tuner name.

Default implementation returns an empty string.

Returns:
tuner name

Reimplemented in avcap::V4L2_Tuner, and avcap::DS_Tuner.

virtual int avcap::Tuner::finetune ( int  maxsteps  )  [inline, 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 in avcap::V4L2_Tuner.

virtual int avcap::Tuner::getAFCValue (  )  const [inline, 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 in avcap::V4L2_Tuner.

virtual int avcap::Tuner::getSignalStrength (  )  const [inline, virtual]

Return the strength of the signal.

The default implementation is noop and returns -1.

Returns:
signal strength

Reimplemented in avcap::V4L2_Tuner, and avcap::DS_Tuner.

virtual int avcap::Tuner::increaseFreq (  )  [inline, virtual]

Increase the frequency a step corresponding to getFreqStep().

The default implementation is noop and returns -1.

Returns:
0, if successful, -1 else.

Reimplemented in avcap::V4L2_Tuner, and avcap::DS_Tuner.

virtual int avcap::Tuner::decreaseFreq (  )  [inline, virtual]

Decrease the frequency a step corresponding to getFreqStep().

The default implementation is noop and returns -1.

Returns:
0, if successful, -1 else.

Reimplemented in avcap::V4L2_Tuner, and avcap::DS_Tuner.

virtual int avcap::Tuner::setFreq ( double  f  )  [inline, 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 in avcap::V4L2_Tuner, and avcap::DS_Tuner.


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