Logo Search packages:      
Sourcecode: pwlib version File versions

PVideoInputDevice Class Reference

#include <videoio.h>

Inheritance diagram for PVideoInputDevice:

PVideoDevice PObject PVideoInput1394DcDevice PVideoInputDevice_1394AVC PVideoInputDevice_1394DC PVideoInputDevice_BeOSVideo PVideoInputDevice_FakeVideo PVideoInputDevice_VideoForWindows

List of all members.

Detailed Description

This class defines a video input device.

Definition at line 833 of file videoio.h.

Comparison functions

virtual Comparison Compare (const PObject &obj) const
virtual Comparison CompareObjectMemoryDirect (const PObject &obj) const
bool operator!= (const PObject &obj) const
bool operator< (const PObject &obj) const
bool operator<= (const PObject &obj) const
bool operator== (const PObject &obj) const
bool operator> (const PObject &obj) const
bool operator>= (const PObject &obj) const
enum  Comparison { LessThan = -1, EqualTo = 0, GreaterThan = 1 }

Run Time Type functions

virtual const char * GetClass (unsigned=0) const
virtual BOOL InternalIsDescendant (const char *clsName) const
BOOL IsClass (const char *cls) const
static const char * Class ()

I/O functions

virtual void PrintOn (ostream &strm) const
virtual void ReadFrom (istream &strm)
ostream & operator<< (ostream &strm, const PObject &obj)
istream & operator>> (istream &strm, PObject &obj)

Public Types

enum  StandardSizes {
  CIF16Width = 1408, CIF16Height = 1152, CIF4Width = 704, CIF4Height = 576,
  CIFWidth = 352, CIFHeight = 288, QCIFWidth = 176, QCIFHeight = 144,
  SQCIFWidth = 144, SQCIFHeight = 96
enum  VideoFormat {

Public Member Functions

virtual BOOL CanCaptureVideo () const
virtual BOOL Close ()
virtual int GetBrightness ()
virtual int GetChannel () const
virtual int GetColour ()
const PStringGetColourFormat () const
virtual int GetContrast ()
const PStringGetDeviceName () const
virtual PStringList GetDeviceNames () const =0
virtual BOOL GetFrame (PBYTEArray &frame)
virtual BOOL GetFrameData (BYTE *buffer, PINDEX *bytesReturned=NULL)=0
virtual BOOL GetFrameDataNoDelay (BYTE *buffer, PINDEX *bytesReturned=NULL)=0
virtual unsigned GetFrameHeight () const
virtual unsigned GetFrameRate () const
virtual BOOL GetFrameSize (unsigned &width, unsigned &height)
virtual BOOL GetFrameSizeLimits (unsigned &minWidth, unsigned &minHeight, unsigned &maxWidth, unsigned &maxHeight)
virtual unsigned GetFrameWidth () const
virtual int GetHue ()
int GetLastError () const
virtual PINDEX GetMaxFrameBytes ()=0
virtual int GetNumChannels ()
virtual BOOL GetParameters (int *whiteness, int *brightness, int *colour, int *contrast, int *hue)
const PStringGetPreferredColourFormat ()
virtual BOOL GetVFlipState ()
virtual VideoFormat GetVideoFormat () const
virtual int GetWhiteness ()
virtual BOOL IsCapturing ()=0
virtual BOOL IsOpen ()=0
virtual BOOL Open (const PString &deviceName, BOOL startImmediate=TRUE)=0
virtual BOOL OpenFull (const OpenArgs &args, BOOL startImmediate=TRUE)
virtual BOOL SetBrightness (unsigned newBrightness)
virtual BOOL SetChannel (int channelNumber)
virtual BOOL SetColour (unsigned newColour)
virtual BOOL SetColourFormat (const PString &colourFormat)
virtual BOOL SetColourFormatConverter (const PString &colourFormat)
virtual BOOL SetContrast (unsigned newContrast)
virtual BOOL SetFrameRate (unsigned rate)
virtual BOOL SetFrameSize (unsigned width, unsigned height)
virtual BOOL SetFrameSizeConverter (unsigned width, unsigned height, BOOL bScaleNotCrop)
virtual BOOL SetHue (unsigned newHue)
void SetPreferredColourFormat (const PString &colourFmt)
virtual BOOL SetVFlipState (BOOL newVFlipState)
virtual BOOL SetVideoChannelFormat (int channelNumber, VideoFormat videoFormat)
virtual BOOL SetVideoFormat (VideoFormat videoFormat)
virtual BOOL SetWhiteness (unsigned newWhiteness)
virtual BOOL Start ()=0
virtual BOOL Stop ()=0
virtual BOOL TestAllFormats ()=0
 ~PVideoInputDevice ()
Miscellaneous functions
virtual PObjectClone () const
virtual PINDEX HashFunction () const

Static Public Member Functions

static unsigned CalculateFrameBytes (unsigned width, unsigned height, const PString &colourFormat)
static PVideoInputDeviceCreateDevice (const PString &driverName, PPluginManager *pluginMgr=NULL)
static PVideoInputDeviceCreateDeviceByName (const PString &deviceName, PPluginManager *pluginMgr=NULL)
static PVideoInputDeviceCreateOpenedDevice (const PString &driverName, const PString &deviceName, BOOL startImmediate=TRUE, PPluginManager *pluginMgr=NULL)
static PStringList GetDriverNames (PPluginManager *pluginMgr=NULL)
static PStringList GetDriversDeviceNames (const PString &driverName, PPluginManager *pluginMgr=NULL)

Protected Member Functions

PINDEX GetMaxFrameBytesConverted (PINDEX rawFrameBytes) const

Protected Attributes

int channelNumber
PString colourFormat
PString deviceName
int frameBrightness
int frameColour
int frameContrast
unsigned frameHeight
int frameHue
unsigned frameRate
int frameTimeError
int frameWhiteness
unsigned frameWidth
int lastError
int msBetweenFrames
BOOL nativeVerticalFlip
PString preferredColourFormat
PTime previousFrameTime
VideoFormat videoFormat

Private Member Functions

 PCLASSINFO (PVideoInputDevice, PVideoDevice)

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

Generated by  Doxygen 1.6.0   Back to index