avcap::QT_DeviceDescriptor Class Reference

#include <avcap/osx/QT_DeviceDescriptor.h>

Inheritance diagram for avcap::QT_DeviceDescriptor:

Inheritance graph
[legend]

Detailed Description

Implementation of the DeviceDescriptor for QuickTime.


Public Member Functions

 QT_DeviceDescriptor (int device, int input, const std::string &dev_name, const std::string &driver_name, SeqGrabComponent current_grabber, SGChannel current_channel)
 QT_DeviceDescriptor ()
virtual ~QT_DeviceDescriptor ()
virtual CaptureDevicegetDevice ()
 Factory-method to create a API-dependent CaptureDevice-object.
virtual int open ()
 Open the underlying device.
virtual int close ()
 Close the underlying device.
virtual const std::string & getName () const
 Returns the unique identifier of the device.
virtual const std::string & getDriver () const
 Returns the name of the driver.
bool isVideoCaptureDev () const
 Device is capable to capture some data. The default implementation returns false.
virtual const DEV_HANDLE_T getHandle () const
 Returns the API-specific device handle used to reference the device.
SeqGrabComponent getGrabber (void)
 Get the SequenceGrabber-Component.
SGChannel getChannel (void)
 Get the SequenceGrabber-Channel associated with the device.
VideoDigitizerComponent getDigitizer (void)
 Get the VideoDigitizer associated with the device.


Constructor & Destructor Documentation

avcap::QT_DeviceDescriptor::QT_DeviceDescriptor ( int  device,
int  input,
const std::string &  dev_name,
const std::string &  driver_name,
SeqGrabComponent  current_grabber,
SGChannel  current_channel 
)

avcap::QT_DeviceDescriptor::QT_DeviceDescriptor (  ) 

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


Member Function Documentation

virtual CaptureDevice* avcap::QT_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.

virtual int avcap::QT_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.

Reimplemented in avcap::QT_DeviceEnumerator.

virtual int avcap::QT_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.

Reimplemented in avcap::QT_DeviceEnumerator.

virtual const std::string& avcap::QT_DeviceDescriptor::getName (  )  const [virtual]

Returns the unique identifier of the device.

Returns:
unique identifier of device

Implements avcap::DeviceDescriptor.

virtual const std::string& avcap::QT_DeviceDescriptor::getDriver (  )  const [virtual]

Returns the name of the driver.

The default implementation returns an empty string.

Returns:
driver

Reimplemented from avcap::DeviceDescriptor.

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

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

Reimplemented from avcap::DeviceDescriptor.

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

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

Returns:
the device handle

Implements avcap::DeviceDescriptor.

SeqGrabComponent avcap::QT_DeviceDescriptor::getGrabber ( void   )  [inline]

Get the SequenceGrabber-Component.

Returns:
the SequenceGrabber-Component.

SGChannel avcap::QT_DeviceDescriptor::getChannel ( void   )  [inline]

Get the SequenceGrabber-Channel associated with the device.

Returns:
the SequenceGrabber-Channel.

VideoDigitizerComponent avcap::QT_DeviceDescriptor::getDigitizer ( void   )  [inline]

Get the VideoDigitizer associated with the device.

Returns:
the VideoDigitizer.


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