avcap::ConnectorManager Class Reference

#include <avcap/ConnectorManager.h>

Inheritance diagram for avcap::ConnectorManager:

Inheritance graph
[legend]

Detailed Description

This class is the interface to query and select the available video/audio inputs/outputs.

This class manages STL-lists of objects of class Connector which describe an input or output of a capture device. Applications can get these lists and get/set the currently used connector of a special type. The methods to deal with outputs are only of partial interest for capturing but have been added for completeness. Application must use the API-dependent CaptureDevice-object to get an ConnectorManager. The default implementations of the mehtods in this class are a noop.


Public Member Functions

 ConnectorManager (DeviceDescriptor *dd)
 Construct the manager and query for available inputs and outputs for audio and video.
virtual ~ConnectorManager ()=0
 The destructor. */.
virtual ConnectorgetVideoInput ()
 Returns the Connector describing the currently used video input.
virtual int setVideoInput (Connector *c)
 Sets the currently used video input.
virtual ConnectorgetAudioInput ()
 Returns the Connector describing the currently used audio input.
virtual int setAudioInput (Connector *c)
 Sets the currently used audio input.
virtual ConnectorgetVideoOutput ()
 Returns the Connector describing the currently used video output.
virtual int setVideoOutput (Connector *c)
 Sets the currently used video output.
virtual ConnectorgetAudioOutput ()
 Returns the Connector describing the currently used audio output.
virtual int setAudioOutput (Connector *c)
 Sets the currently used audio output.
const ListTypegetVideoInputList () const
 Get the list of available video inputs of the device.
const ListTypegetAudioInputList () const
 Get the list of available audio inputs of the device.
const ListTypegetVideoOutputList () const
 Get the list of available video outputs of the device.
const ListTypegetAudioOutputList () const
 Get the list of available audio outputs of the device.
virtual void query ()=0
 This method is called after creation to query for video/audio in- and outputs.

Protected Attributes

ListType mVideoInputs
ListType mAudioInputs
ListType mVideoOutputs
ListType mAudioOutputs


Constructor & Destructor Documentation

ConnectorManager::ConnectorManager ( DeviceDescriptor dd  ) 

Construct the manager and query for available inputs and outputs for audio and video.

The manager is usualy created by an CaptureDevice object.

Parameters:
dd The DeviceDescriptor to acces the device.

ConnectorManager::~ConnectorManager (  )  [pure virtual]

The destructor. */.


Member Function Documentation

virtual Connector* avcap::ConnectorManager::getVideoInput (  )  [inline, virtual]

Returns the Connector describing the currently used video input.

The default-implementation returns 0.

Returns:
video input connector.

Reimplemented in avcap::V4L1_ConnectorManager, avcap::V4L2_ConnectorManager, and avcap::DS_ConnectorManager.

virtual int avcap::ConnectorManager::setVideoInput ( Connector c  )  [inline, virtual]

Sets the currently used video input.

The default-implementation is a noop and returns -1.

Parameters:
c The connector to use for the video input.
Returns:
0, if succesful, -1 else

Reimplemented in avcap::V4L1_ConnectorManager, avcap::V4L2_ConnectorManager, and avcap::DS_ConnectorManager.

virtual Connector* avcap::ConnectorManager::getAudioInput (  )  [inline, virtual]

Returns the Connector describing the currently used audio input.

The default-implementation returns 0.

Returns:
audio input connector.

Reimplemented in avcap::V4L2_ConnectorManager, and avcap::DS_ConnectorManager.

virtual int avcap::ConnectorManager::setAudioInput ( Connector c  )  [inline, virtual]

Sets the currently used audio input.

The default-implementation is a noop and returns -1.

Parameters:
c The connector to use for the audio input.
Returns:
0, if succesful, -1 else

Reimplemented in avcap::V4L2_ConnectorManager, and avcap::DS_ConnectorManager.

virtual Connector* avcap::ConnectorManager::getVideoOutput (  )  [inline, virtual]

Returns the Connector describing the currently used video output.

The default-implementation returns 0.

Returns:
video output connector.

Reimplemented in avcap::V4L2_ConnectorManager, and avcap::DS_ConnectorManager.

virtual int avcap::ConnectorManager::setVideoOutput ( Connector c  )  [inline, virtual]

Sets the currently used video output.

The default-implementation is a noop and returns -1.

Parameters:
c The connector to use for the video input.
Returns:
0, if succesful, -1 else

Reimplemented in avcap::V4L2_ConnectorManager, and avcap::DS_ConnectorManager.

virtual Connector* avcap::ConnectorManager::getAudioOutput (  )  [inline, virtual]

Returns the Connector describing the currently used audio output.

The default-implementation returns 0.

Returns:
audio output connector.

Reimplemented in avcap::V4L2_ConnectorManager, and avcap::DS_ConnectorManager.

virtual int avcap::ConnectorManager::setAudioOutput ( Connector c  )  [inline, virtual]

Sets the currently used audio output.

The default-implementation is a noop and returns -1.

Parameters:
c The connector to use for the audio output.
Returns:
0, if succesful, -1 else

Reimplemented in avcap::V4L2_ConnectorManager, and avcap::DS_ConnectorManager.

const ListType& avcap::ConnectorManager::getVideoInputList (  )  const [inline]

Get the list of available video inputs of the device.

Returns:
STL-list of pointers to objects of type Connector describing the available video inputs.

const ListType& avcap::ConnectorManager::getAudioInputList (  )  const [inline]

Get the list of available audio inputs of the device.

Returns:
STL-list of pointers to objects of type Connector describing the available audio inputs.

const ListType& avcap::ConnectorManager::getVideoOutputList (  )  const [inline]

Get the list of available video outputs of the device.

Returns:
STL-list of pointers to objects of type Connector describing the available video outputs.

const ListType& avcap::ConnectorManager::getAudioOutputList (  )  const [inline]

Get the list of available audio outputs of the device.

Returns:
STL-list of pointers to objects of type Connector describing the available audio outputs.

virtual void avcap::ConnectorManager::query (  )  [pure virtual]

This method is called after creation to query for video/audio in- and outputs.

Implements avcap::Manager< T >.

Implemented in avcap::AVC_ConnectorManager, avcap::V4L1_ConnectorManager, avcap::V4L2_ConnectorManager, avcap::QT_ConnectorManager, and avcap::DS_ConnectorManager.


Field Documentation

ListType avcap::ConnectorManager::mVideoInputs [protected]

ListType avcap::ConnectorManager::mAudioInputs [protected]

ListType avcap::ConnectorManager::mVideoOutputs [protected]

ListType avcap::ConnectorManager::mAudioOutputs [protected]


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