This class defines a video input device

Inheritance:

Public Methods

static PStringList	GetDriverNames (PPluginManager* pluginMgr = NULL) Return the list of available video input drivers
static PStringList	GetDriversDeviceNames ( const PString &driverName, PPluginManager* pluginMgr = NULL ) Return video devices that correspond to the specified name
static PVideoInputDevice*	CreateDevice ( const PString &driverName, PPluginManager* pluginMgr = NULL ) Return the video input device that corresponds to the specified name
static PVideoInputDevice*	CreateOpenedDevice ( const PString & driverName, const PString & deviceName, BOOL startImmediate = TRUE, PPluginManager* pluginMgr = NULL ) Return opened video input device that corresponds to the specified name
virtual BOOL	CanCaptureVideo () const Is the device a camera, and obtain video
virtual BOOL	Open ( const PString & deviceName, BOOL startImmediate = TRUE ) Open the device given the device name.
virtual BOOL	IsCapturing () Determine if the video device I/O capture is in progress
virtual PINDEX	GetMaxFrameBytes () Get the maximum frame size in bytes.
virtual BOOL	GetFrame ( PBYTEArray & frame ) Grab a frame
virtual BOOL	GetFrameData ( BYTE* buffer, PINDEX* bytesReturned = NULL ) Grab a frame, after a delay as specified by the frame rate.
virtual BOOL	GetFrameDataNoDelay ( BYTE* buffer, PINDEX* bytesReturned = NULL ) Grab a frame.
virtual BOOL	TestAllFormats () Try all known video formats & see which ones are accepted by the video driver

Public Members

Create a new video input device

Inherited from PVideoDevice:

Public Methods

virtual BOOL OpenFull( const OpenArgs & args, BOOL startImmediate = TRUE )

virtual BOOL IsOpen()

virtual BOOL Close()

virtual BOOL Start()

virtual BOOL Stop()

const PString& GetDeviceName() const

virtual PStringList GetDeviceNames() const

virtual BOOL SetVideoFormat( VideoFormat videoFormat )

virtual VideoFormat GetVideoFormat() const

virtual int GetNumChannels()

virtual BOOL SetChannel( int channelNumber )

virtual int GetChannel() const

virtual BOOL SetColourFormatConverter( const PString & colourFormat )

virtual BOOL SetColourFormat( const PString & colourFormat )

const PString& GetColourFormat() const

virtual BOOL SetFrameRate( unsigned rate )

virtual unsigned GetFrameRate() const

virtual BOOL GetFrameSizeLimits( unsigned & minWidth, unsigned & minHeight, unsigned & maxWidth, unsigned & maxHeight )

virtual BOOL SetFrameSizeConverter( unsigned width, unsigned height, BOOL bScaleNotCrop )

virtual BOOL SetFrameSize( unsigned width, unsigned height )

virtual BOOL GetFrameSize( unsigned & width, unsigned & height )

virtual unsigned GetFrameWidth() const

virtual unsigned GetFrameHeight() const

static unsigned CalculateFrameBytes( unsigned width, unsigned height, const PString & colourFormat )

int GetLastError() const

virtual int GetBrightness()

virtual BOOL SetBrightness(unsigned newBrightness)

virtual int GetWhiteness()

virtual BOOL SetWhiteness(unsigned newWhiteness)

virtual int GetColour()

virtual BOOL SetColour(unsigned newColour)

virtual int GetContrast()

virtual BOOL SetContrast(unsigned newContrast)

virtual int GetHue()

virtual BOOL SetHue(unsigned newHue)

virtual BOOL GetParameters( int* whiteness, int* brightness, int* colour, int* contrast, int* hue )

virtual BOOL SetVideoChannelFormat( int channelNumber, VideoFormat videoFormat )

virtual BOOL GetVFlipState()

virtual BOOL SetVFlipState( BOOL newVFlipState )

void SetPreferredColourFormat(const PString & colourFmt)

const PString& GetPreferredColourFormat()

Inherited from PObject:

Public Methods

Run Time Type functions

I/O functions

Public Members

Comparison functions

Documentation

This class defines a video input device

Create a new video input device

Create a new video input device

static PStringList GetDriverNames(PPluginManager* pluginMgr = NULL)

Return the list of available video input drivers

static PStringList GetDriversDeviceNames( const PString &driverName, PPluginManager* pluginMgr = NULL )

Return video devices that correspond to the specified name

static PVideoInputDevice* CreateDevice( const PString &driverName, PPluginManager* pluginMgr = NULL )

Return the video input device that corresponds to the specified name

static PVideoInputDevice* CreateOpenedDevice( const PString & driverName, const PString & deviceName, BOOL startImmediate = TRUE, PPluginManager* pluginMgr = NULL )

Return opened video input device that corresponds to the specified name

virtual BOOL CanCaptureVideo() const

Is the device a camera, and obtain video

virtual BOOL Open( const PString & deviceName, BOOL startImmediate = TRUE ) = 0

Open the device given the device name.

Parameters:

deviceName - Device name to open
startImmediate - Immediately start device

virtual BOOL IsCapturing() = 0

Determine if the video device I/O capture is in progress

virtual PINDEX GetMaxFrameBytes() = 0

Get the maximum frame size in bytes.

Note a particular device may be able to provide variable length frames (eg motion JPEG) so will be the maximum size of all frames.

virtual BOOL GetFrame( PBYTEArray & frame ) = 0

Grab a frame

virtual BOOL GetFrameData( BYTE* buffer, PINDEX* bytesReturned = NULL ) = 0

Grab a frame, after a delay as specified by the frame rate.

Parameters:

- buffer Buffer to receive frame
bytesReturned - OPtional bytes returned.

virtual BOOL GetFrameDataNoDelay( BYTE* buffer, PINDEX* bytesReturned = NULL ) = 0

Grab a frame. Do not delay according to the current frame rate parameter.

Parameters:

- buffer Buffer to receive frame
bytesReturned - OPtional bytes returned.

virtual BOOL TestAllFormats() = 0

Try all known video formats & see which ones are accepted by the video driver

This class has no child classes.

Alphabetic index HTML hierarchy of classes or Java