PVideoOutputDevice Class Reference

#include <videoio.h>

Inheritance diagram for PVideoOutputDevice:

List of all members.

Public Member Functions
	PVideoOutputDevice ()
virtual	~PVideoOutputDevice ()
virtual BOOL	Close ()
virtual BOOL	Start ()
virtual BOOL	Stop ()
virtual BOOL	CanCaptureVideo () const
virtual BOOL	SetFrameData (unsigned x, unsigned y, unsigned width, unsigned height, const BYTE *data, BOOL endFrame=TRUE)=0
Static Public Member Functions
static PStringList	GetDriverNames (PPluginManager *pluginMgr=NULL)
static PStringList	GetDriversDeviceNames (const PString &driverName, PPluginManager *pluginMgr=NULL)
static PVideoOutputDevice *	CreateDevice (const PString &driverName, PPluginManager *pluginMgr=NULL)
static PVideoOutputDevice *	CreateDeviceByName (const PString &deviceName, PPluginManager *pluginMgr=NULL)
static PVideoOutputDevice *	CreateOpenedDevice (const PString &driverName, const PString &deviceName, BOOL startImmediate=TRUE, PPluginManager *pluginMgr=NULL)

---

Detailed Description

This class defines a video output device.- typically, a window.

---

Constructor & Destructor Documentation

PVideoOutputDevice::PVideoOutputDevice

(

)

Create a new video output device.

virtual PVideoOutputDevice::~PVideoOutputDevice

(

)

[inline, virtual]

Close the video output device on destruction.

References Close().

---

Member Function Documentation

static PStringList PVideoOutputDevice::GetDriverNames

(

PPluginManager *

pluginMgr = NULL

)

[static]

Get the list of available video output drivers (plug-ins)

Parameters:

pluginMgr

Plug in manager, use default if NULL

static PStringList PVideoOutputDevice::GetDriversDeviceNames	(	const PString &	driverName,
		PPluginManager *	pluginMgr = NULL
	)			[static]

Get video output devices that correspond to the specified driver name. If driverName is an empty string or the value "*" then this will return a list of unique device names across all of the available drivers. If two drivers have identical names for devices, then the string returned will be of the form driver+''+device.

Parameters:

driverName	Name of driver
pluginMgr	Plug in manager, use default if NULL

static PVideoOutputDevice* PVideoOutputDevice::CreateDevice	(	const PString &	driverName,
		PPluginManager *	pluginMgr = NULL
	)			[static]

Create the video output device that corresponds to the specified driver name.

Parameters:

driverName	Name of driver
pluginMgr	Plug in manager, use default if NULL

static PVideoOutputDevice* PVideoOutputDevice::CreateDeviceByName	(	const PString &	deviceName,
		PPluginManager *	pluginMgr = NULL
	)			[static]

Parameters:

deviceName	Name of device
pluginMgr	Plug in manager, use default if NULL

static PVideoOutputDevice* PVideoOutputDevice::CreateOpenedDevice	(	const PString &	driverName,
		const PString &	deviceName,
		BOOL	startImmediate = TRUE,
		PPluginManager *	pluginMgr = NULL
	)			[static]

Create an opened video output device that corresponds to the specified names. If the driverName parameter is an empty string or "*" then CreateDeviceByName is used with the deviceName parameter which is assumed to be a value returned from GetDriversDeviceNames().

Parameters:

driverName	Name of driver
deviceName	Name of device
startImmediate	Immediately start display
pluginMgr	Plug in manager, use default if NULL

virtual BOOL PVideoOutputDevice::Close

(

)

[inline, virtual]

Close the device.

Implements PVideoDevice.

Referenced by ~PVideoOutputDevice().

virtual BOOL PVideoOutputDevice::Start

(

)

[inline, virtual]

Start the video device I/O display.

Implements PVideoDevice.

virtual BOOL PVideoOutputDevice::Stop

(

)

[inline, virtual]

Stop the video device I/O display.

Implements PVideoDevice.

virtual BOOL PVideoOutputDevice::CanCaptureVideo

(

)

const [virtual]

Is the device a camera, and obtain video

Implements PVideoDevice.

virtual BOOL PVideoOutputDevice::SetFrameData	(	unsigned	x,
		unsigned	y,
		unsigned	width,
		unsigned	height,
		const BYTE *	data,
		BOOL	endFrame = TRUE
	)			[pure virtual]

Set a section of the output frame buffer.

Implemented in PVideoOutputDeviceRGB.

---

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

• videoio.h