avcap::DS_FormatManager Class Reference

#include <avcap/windows/DS_FormatManager.h>

Inheritance diagram for avcap::DS_FormatManager:

[legend]

---

Detailed Description

Implementation of the FormatManager for DirectShow.

A capture device that still uses a VFW (Video for Windows) driver can select the available formats only by using the VFW driver-supplied dialog box. But GUI-related stuff is out of the scope of this library.

Public Member Functions
	DS_FormatManager (DS_DeviceDescriptor *dd)
virtual	~DS_FormatManager ()
virtual int	setFormat (Format *fmt)
	Set the format to capture.
virtual Format *	getFormat ()
	Get the current format.
virtual int	setResolution (int w, int h)
	Set the image with and height.
virtual int	getWidth ()
	Returns the image with.
virtual int	getHeight ()
	Returns the image height.
virtual int	getBytesPerLine ()
	Returns the bytes per line.
virtual int	setFramerate (int fps)
	Set the framerate.
virtual int	getFramerate ()
	Get the current framerate.
virtual int	flush ()
	Flushes the format, i.e. the driver is advised to apply the current format settings.
virtual size_t	getImageSize ()
	The number of bytes that an image of the current size requires to be stored in memory, including padding.
virtual const VideoStandard *	getVideoStandard ()
	Get the currently used video standard.
virtual int	setVideoStandard (const VideoStandard *std)
	Set the video standard to use.
virtual void	query ()

---

Constructor & Destructor Documentation

avcap::DS_FormatManager::DS_FormatManager

(

DS_DeviceDescriptor *

dd

)

virtual avcap::DS_FormatManager::~DS_FormatManager

(

)

[virtual]

---

Member Function Documentation

virtual int avcap::DS_FormatManager::setFormat

(

Format *

fmt

)

[virtual]

Set the format to capture.

Parameters:

fmt

The new format.

Returns:

0, if successful, -1 else

Reimplemented from avcap::FormatManager.

virtual Format* avcap::DS_FormatManager::getFormat

(

)

[virtual]

Get the current format.

Returns:

The format.

Reimplemented from avcap::FormatManager.

virtual int avcap::DS_FormatManager::setResolution	(	int	w,
		int	h
	)			[virtual]

Set the image with and height.

Parameters:

	w	: width
	h	: height

Returns:

0, if successful, -1 else

Reimplemented from avcap::FormatManager.

virtual int avcap::DS_FormatManager::getWidth

(

)

[virtual]

Returns the image with.

Returns:

width

Reimplemented from avcap::FormatManager.

virtual int avcap::DS_FormatManager::getHeight

(

)

[virtual]

Returns the image height.

Returns:

height

Reimplemented from avcap::FormatManager.

virtual int avcap::DS_FormatManager::getBytesPerLine

(

)

[virtual]

Returns the bytes per line.

Returns:

bpl

Reimplemented from avcap::FormatManager.

virtual int avcap::DS_FormatManager::setFramerate

(

int

fps

)

[virtual]

Set the framerate.

The default implementation returns -1

Parameters:

fps

: the number of frames per second.

Returns:

0 if successful, -1 on failure

Reimplemented from avcap::FormatManager.

virtual int avcap::DS_FormatManager::getFramerate

(

)

[virtual]

Get the current framerate.

The default implementation returns -1 /*!

Returns:

the frames per second

Reimplemented from avcap::FormatManager.

virtual int avcap::DS_FormatManager::flush

(

)

[virtual]

Flushes the format, i.e. the driver is advised to apply the current format settings.

Returns:

0, if successful, -1 else

Reimplemented from avcap::FormatManager.

virtual size_t avcap::DS_FormatManager::getImageSize

(

)

[virtual]

The number of bytes that an image of the current size requires to be stored in memory, including padding.

Returns:

size

Reimplemented from avcap::FormatManager.

virtual const VideoStandard* avcap::DS_FormatManager::getVideoStandard

(

)

[virtual]

Get the currently used video standard.

The default implementation returns 0

Returns:

the current standard or 0, if not applicable

Reimplemented from avcap::FormatManager.

virtual int avcap::DS_FormatManager::setVideoStandard

(

const VideoStandard *

std

)

[virtual]

Set the video standard to use.

Attention: not all video standards can be set in conjunction with each connector and format. The default implementation returns -1

Parameters:

std

The new video standard.

Returns:

0, if successful, -1 else

Reimplemented from avcap::FormatManager.

virtual void avcap::DS_FormatManager::query

(

)

[virtual]

Called during initialisation by the CaptureDevice to query for the objects that the implementation of this class manages.

Implements avcap::FormatManager.

---

The documentation for this class was generated from the following file:

• include/avcap/windows/DS_FormatManager.h

---