avcap::Connector Class Reference

#include <avcap/Connector.h>

Inheritance diagram for avcap::Connector:

Inheritance graph
[legend]

Detailed Description

This class is the abstraction of a video/audio input or output.

It is used to describe available inputs and outputs of a device and to select them by means of the API-dependent CaptureDevices implementation of the ConnectorManager. The ConnectorManager queries all available connectors of a device and provides methods to set and get the currently used ones.


Public Member Functions

 Connector (DeviceDescriptor *dd, int index, const std::string &name, int type=0, int audioset=0)
 The Constructor. Objects of this class are created by the ConnectorManager.
virtual ~Connector ()
 The Destructor.
int getIndex () const
 Returns the unique index of the connector.
int getAudioset () const
 Get mapping of audio inputs to video inputs.
virtual TunergetTuner ()
 Get the tuner associated with the Connector.
const std::string & getName () const
 Provides a textual description of the connector.
virtual bool hasTuner () const
 Test, whether a tuner is associated with the connector or not.

Protected Attributes

DeviceDescriptormDeviceDescriptor
int mIndex
int mAudioset
int mType
std::string mName


Constructor & Destructor Documentation

avcap::Connector::Connector ( DeviceDescriptor dd,
int  index,
const std::string &  name,
int  type = 0,
int  audioset = 0 
) [inline]

The Constructor. Objects of this class are created by the ConnectorManager.

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

The Destructor.


Member Function Documentation

int avcap::Connector::getIndex (  )  const [inline]

Returns the unique index of the connector.

Returns:
The index.

int avcap::Connector::getAudioset (  )  const [inline]

Get mapping of audio inputs to video inputs.

For devices which provide audio and video capturing, video inputs can correspond to zero or more audio inputs. The audio inputs are numbered from 0 to N-1, N <= 32. Each bit of the audioset corresponds to one input. For details, see the Video4Linux2 API Documentation.

Win32: A video connector can correspond to only one audio connector (only one bit can be set at a time).

virtual Tuner* avcap::Connector::getTuner (  )  [inline, virtual]

Get the tuner associated with the Connector.

If a tuner is associated whith the connector (e.g. for TV-Tuner cards), then this method returns an object of class Tuner to access the tuner specific functionality.

Returns:
object of class Tuner or 0 if there is no tuner.

Reimplemented in avcap::V4L2_Connector.

const std::string& avcap::Connector::getName (  )  const [inline]

Provides a textual description of the connector.

Returns:
connector name.

virtual bool avcap::Connector::hasTuner (  )  const [inline, virtual]

Test, whether a tuner is associated with the connector or not.

Returns:
true, if tuner is associated, false otherwise.

Reimplemented in avcap::V4L2_Connector, and avcap::DS_Connector.


Field Documentation

DeviceDescriptor* avcap::Connector::mDeviceDescriptor [protected]

int avcap::Connector::mIndex [protected]

Reimplemented in avcap::DS_Connector.

int avcap::Connector::mAudioset [protected]

Reimplemented in avcap::DS_Connector.

int avcap::Connector::mType [protected]

Reimplemented in avcap::DS_Connector.

std::string avcap::Connector::mName [protected]

Reimplemented in avcap::DS_Connector.


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