avcap::DS_DeviceDescriptor Class Reference

#include <avcap/windows/DS_DeviceDescriptor.h>

Inheritance diagram for avcap::DS_DeviceDescriptor:

Inheritance graph
[legend]

Detailed Description

Implementation of the DeviceDescriptor for DirectShow.


Public Member Functions

 DS_DeviceDescriptor (const std::string &card)
virtual ~DS_DeviceDescriptor ()
virtual CaptureDevicegetDevice ()
 Factory-method to create a API-dependent CaptureDevice-object.
int open ()
 Open the underlying device.
int close ()
 Close the underlying device.
virtual const std::string & getName () const
 Returns the unique identifier of the device.
const DEV_HANDLE_T getHandle () const
 Returns the API-specific device handle used to reference the device.
DEV_HANDLE_T getHandle ()
bool isAVDev () const
 Device is an audio/video device. The default implementation returns false.
bool isVideoCaptureDev () const
 Device is capable to capture some data. The default implementation returns false.
bool isVBIDev () const
 Device is a VBI device. The default implementation returns false.
bool isTuner () const
 Device has a tuner. The default implementation returns false.
bool isAudioDev () const
 Device is an audio device. The default implementation returns false.
bool isRadioDev () const
 Device is a radio device. The default implementation returns false.
bool isOverlayDev () const
 Device supports video overlay. The default implementation returns false.
bool isVfWDevice () const
 Device is a VFW (Video for Windows) device.

Data Fields

unsigned long mRegister


Constructor & Destructor Documentation

avcap::DS_DeviceDescriptor::DS_DeviceDescriptor ( const std::string &  card  ) 

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


Member Function Documentation

virtual CaptureDevice* avcap::DS_DeviceDescriptor::getDevice (  )  [virtual]

Factory-method to create a API-dependent CaptureDevice-object.

Applications must not create their own instances of a CaptureDevice but use this method to access the proper API-dependent unique device-object. You can use this object anywhere between successive calls to open() and close(), i.e. it is not valid before open() and not after close(). The ownership of the object remains at the descriptor, so the caller must not delete the object after usage. Only one CaptureDevice-object will be created for each DeviceDescriptor, so multiple calls to getDevice() will always return the same object instance.

Returns:
the CaptureDevice-instance or 0, if not available.

Implements avcap::DeviceDescriptor.

int avcap::DS_DeviceDescriptor::open (  )  [virtual]

Open the underlying device.

The CaptureDevice-Object returned by getDevice(), which is actually used to perform capturing is not valid before open() is called.

Returns:
0 success, -1 on failure, e.g. open() has been already called before

Implements avcap::DeviceDescriptor.

int avcap::DS_DeviceDescriptor::close (  )  [virtual]

Close the underlying device.

The CaptureDevice-Object returned by getDevice(), which is actually used to perform capturing, is not valid after close() is called.

Returns:
0 success, -1 failure

Implements avcap::DeviceDescriptor.

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

Returns the unique identifier of the device.

Returns:
unique identifier of device

Implements avcap::DeviceDescriptor.

const DEV_HANDLE_T avcap::DS_DeviceDescriptor::getHandle (  )  const [inline, virtual]

Returns the API-specific device handle used to reference the device.

Returns:
the device handle

Implements avcap::DeviceDescriptor.

DEV_HANDLE_T avcap::DS_DeviceDescriptor::getHandle (  )  [inline]

bool avcap::DS_DeviceDescriptor::isAVDev (  )  const [virtual]

Device is an audio/video device. The default implementation returns false.

Reimplemented from avcap::DeviceDescriptor.

bool avcap::DS_DeviceDescriptor::isVideoCaptureDev (  )  const [virtual]

Device is capable to capture some data. The default implementation returns false.

Reimplemented from avcap::DeviceDescriptor.

bool avcap::DS_DeviceDescriptor::isVBIDev (  )  const [virtual]

Device is a VBI device. The default implementation returns false.

Reimplemented from avcap::DeviceDescriptor.

bool avcap::DS_DeviceDescriptor::isTuner (  )  const [virtual]

Device has a tuner. The default implementation returns false.

Reimplemented from avcap::DeviceDescriptor.

bool avcap::DS_DeviceDescriptor::isAudioDev (  )  const [virtual]

Device is an audio device. The default implementation returns false.

Reimplemented from avcap::DeviceDescriptor.

bool avcap::DS_DeviceDescriptor::isRadioDev (  )  const [virtual]

Device is a radio device. The default implementation returns false.

Reimplemented from avcap::DeviceDescriptor.

bool avcap::DS_DeviceDescriptor::isOverlayDev (  )  const [virtual]

Device supports video overlay. The default implementation returns false.

Reimplemented from avcap::DeviceDescriptor.

bool avcap::DS_DeviceDescriptor::isVfWDevice (  )  const

Device is a VFW (Video for Windows) device.

Returns:
true VFW device, else false


Field Documentation

unsigned long avcap::DS_DeviceDescriptor::mRegister


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