au.edu.jcu.v4l4j

Class Tuner

java.lang.Object

au.edu.jcu.v4l4j.Tuner

public class Tuner
extends Object

Instances of this class are used to represent a tuner attached to a video input. Methods in this class control the frequency of the tuner and report the received signal strength and the automatic frequency control (when its value is negative, the frequency is too low and when positive, it is too high). The AFC may not be available on all hardware. If not, getAFC() returns a value of 0.Tuners are not directly instantiated. Instead, to retrieve the Tuner associated with a frame grabber, call FrameGrabber.getTuner() on the associated FrameGrabber object. Alternatively, you can also obtain a list of Tuner objects by calling VideoDevice.getTunerList(). Methods in this class must not be called once the associated video device has been released. Otherwise, a StateException will be thrown.

Author:

gilles

Method Summary

Modifier and Type	Method and Description
int	getAFC() This method returns the current AFC (Automatic Frequency Control) value.
double	getFrequency() This method returns the current frequency of this tuner.
int	getIndex() This method returns the index of this tuner.
TunerInfo	getInfo() This method returns the TunerInfo object associated with this tuner.
int	getRSSI() This method returns the current received signal strength.
void	setFrequency(double f) This method sets the frequency of this tuner.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getFrequency

public double getFrequency()

This method returns the current frequency of this tuner.

Returns:

the current frequency

Throws:

StateException - if the associated frame grabber has been released and this tuner must not be used anymore.

setFrequency

public void setFrequency(double f)

This method sets the frequency of this tuner.

Parameters:

f - the new frequency

Throws:

StateException - if the associated frame grabber has been released and this tuner must not be used anymore.

getAFC

public int getAFC()

This method returns the current AFC (Automatic Frequency Control) value. When its value is negative, the frequency is too low and when positive, it is too high.

Returns:

the current AFC value

Throws:

StateException - if the associated frame grabber has been released and this tuner must not be used anymore.

getRSSI

public int getRSSI()

This method returns the current received signal strength.

Returns:

the current received signal strength

Throws:

StateException - if the associated frame grabber has been released and this tuner must not be used anymore.

getIndex

public int getIndex()

This method returns the index of this tuner.

Returns:

the index of this tuner

Throws:

StateException - if the associated frame grabber has been released and this tuner must not be used anymore.

getInfo

public TunerInfo getInfo()

This method returns the TunerInfo object associated with this tuner.

Returns:

the TunerInfo object associated with this tuner.

Throws:

StateException - if the associated frame grabber has been released and this tuner must not be used anymore.