CDSwcOpenAPIclass Class Reference

#include <DSwcOpenAPIclass.h>

List of all members.

Public Types

enum EKnownChipsetCat {
  CC_Unknown = 0, CC_SAA8112 = 1, CC_SAA8116 = 3, CC_CREALIVEULTRA = 4,
  CC_LOGIFUSION = 5
}

The chipsets that DSwcOpen knows about. More...

enum EVidCapPropertySupport { PS_no = 0, PS_get = 1, PS_set = 2, PS_both = 3 }

The capability that DSwcOpen may support for a certain property. More...

enum EVidCapProperty {
  CP_FirstElement = 0, CP_Brightness = CP_FirstElement, CP_Contrast = 1, CP_Hue = 2,
  CP_Saturation = 3, CP_Sharpness = 4, CP_Gamma = 5, CP_ColorEnable = 6,
  CP_WhiteBalance = 7, CP_BacklightCompensation = 8, CP_WhiteBalanceMode = 9, CP_WhiteBalRed = 10,
  CP_WhiteBalBlue = 11, CP_FlickerFree = 12, CP_Flicker50_60 = 13, CP_FPS = 14,
  CP_Exposure = 15, CP_Gain = 16, CP_FlipHorizontal = 17, CP_FlipVertical = 18,
  CP_AutoExposure = 19, CP_AutoAll = 20, CP_ActualFrameRate = 21, CP_LED = 22,
  CP_Setting = 23, CP_ExtTrigger = 24, CP_SWTrigger = 25, CP_Pan = 26,
  CP_Tilt = 27, CP_Roll = 28, CP_Zoom = 29, CP_Iris = 30,
  CP_Focus = 31, CP_LastElement = CP_Focus
}

All the properties that DSwcOpen may support for a certain webcam. More...

Public Member Functions

CDSwcOpenAPIclass ()

virtual ~CDSwcOpenAPIclass ()

hr>

bool EnumCams ()

The interface.

void GetCamStrings (char *(*camNames[]), unsigned int *numCamNames)

void GetDevStrings (char *(*devNames[]), unsigned int *numDevNames)

void GetCamSerials (char *(*camSerials[]), unsigned int *numCamSerials)

bool SetCam (int camNumber)

bool CamProperty_Support (EVidCapProperty prop, EVidCapPropertySupport *pValue)

bool CamProperty_Range (EVidCapProperty prop, long *pMin, long *pMax, long *pDelta)

bool CamProperty_Set (EVidCapProperty prop, long value)

bool CamProperty_Get (EVidCapProperty prop, long *pValue)

bool CamChipset (EKnownChipsetCat *pValue)

char * ErrString ()

int DllUsers ()

Member Enumeration Documentation

enum CDSwcOpenAPIclass::EKnownChipsetCat

The chipsets that DSwcOpen knows about.

Enumerator:

CC_Unknown

CC_SAA8112

CC_SAA8116

CC_CREALIVEULTRA

CC_LOGIFUSION

enum CDSwcOpenAPIclass::EVidCapPropertySupport

The capability that DSwcOpen may support for a certain property.

Enumerator:

PS_no

PS_get

PS_set

PS_both

enum CDSwcOpenAPIclass::EVidCapProperty

All the properties that DSwcOpen may support for a certain webcam.

Enumerator:

CP_FirstElement

CP_Brightness Specifies the brightness, also called the black level.

** standard props copied from VideoProcAmp (MSDN VideoProcAmpProperty Enumeration Page) please be aware that the properties are sometimes not implemented according to the standard - so check the range before using it Also the range of properties supported depends on the cam model

CP_Contrast Specifies the contrast, expressed as gain factor.

CP_Hue Specifies the hue, in degrees.

CP_Saturation Specifies the saturation.

CP_Sharpness Specifies the sharpness.

CP_Gamma Specifies the gamma.

CP_ColorEnable Specifies the color enable setting. The possible values are 0 (off) and 1 (on).

CP_WhiteBalance Specifies the white balance setting.

CP_BacklightCompensation Specifies the backlight compensation setting. Possible values are 0 (off) and 1 (on).

CP_WhiteBalanceMode
***from Private Properties

The webcam white balance selector Possible values are (0=Warm, 1=Outdoor, 2=FL, 3=Freeze,4=Auto)

CP_WhiteBalRed The red part of the manual white balance.

CP_WhiteBalBlue The blue part of the manual white balance.

CP_FlickerFree Another two setting which changes some scan frequencies Possible values are 0 (off) and 1 (on).

CP_Flicker50_60 Possible values are (0=50Hz, 1=60Hz).

CP_FPS The framerate setting Value range (0=5,1=10,2=15,3=20,4=25,5=30,6=60)

CP_Exposure The exposure time setting Value range (0..10 / 0=1/5, 1=1/10, 2=1/25...)

CP_Gain The gain setting.

CP_FlipHorizontal Flip the image in a direction Possible values are (0=not,1=flipped)

CP_FlipVertical

CP_AutoExposure The Auto checkboxes Possible values are (0=auto, 1=not)

CP_AutoAll

CP_ActualFrameRate frame duration in msec - get only

CP_LED
*** Control parameters (experimental or not even working :o) )

One can switch the LED a bit Possible values are (=16 on, =17 slow blink, =18 fast blink)

CP_Setting Load, Save and Factory buttons control (set only) Possible values are (=0 Load User, =1 Save User, =2 Load Factory)

CP_ExtTrigger
*** CamControl parameters (mostly set only)

CP_SWTrigger

CP_Pan

CP_Tilt

CP_Roll

CP_Zoom

CP_Iris

CP_Focus

CP_LastElement

Constructor & Destructor Documentation

CDSwcOpenAPIclass::CDSwcOpenAPIclass ( )

virtual CDSwcOpenAPIclass::~CDSwcOpenAPIclass ( ) [virtual]

hr>

Member Function Documentation

bool CDSwcOpenAPIclass::EnumCams ( )

The interface.
Enumerates the video capture devices - must be calles once
Parameters:

none

Returns:
true for success
false on error (failed for some reason)

void CDSwcOpenAPIclass::GetCamStrings ( char **[] camNames,

unsigned int * numCamNames

)

Provides the enumerated camera names
Returns a pointer to a zero based array of ASCIIZ strings and the number of strings that are valid
!!!!! You don't own the strings so just make a copy !!!!!
Parameters:

camNames - a pointer var receiving the char array ptr

numCamNames - an int var receiving number of strings

void CDSwcOpenAPIclass::GetDevStrings ( char **[] devNames,

unsigned int * numDevNames

)

Provides the enumerated device names
Returns a pointer to a zero based array of ASCIIZ strings and the number of strings that are valid returns Camera driver internal (unique) names
!!!!! You don't own the strings so just make a copy !!!!!
Parameters:

devNames - a pointer var receiving the char array ptr

numCamNames - an int var receiving number of strings

void CDSwcOpenAPIclass::GetCamSerials ( char **[] camSerials,

unsigned int * numCamSerials

)

Provides the enumerated camera serials - use it if more than one camera of a type is connected
Returns a pointer to a zero based array of ASCIIZ strings and the number of strings that are valid
!!!!! You don't own the strings so just make a copy !!!!!
Parameters:

camSerials - a pointer var receiving the char array ptr

numCamSerials - an int var receiving number of strings

bool CDSwcOpenAPIclass::SetCam ( int camNumber )

Sets the camera with the array index CamNumber to the current cam
Parameters:

camNumber - the number of the cam to make active set -1 to disconnect

Returns:
true for success
false on error or just because there were no cams

bool CDSwcOpenAPIclass::CamProperty_Support ( EVidCapProperty prop,

EVidCapPropertySupport * pValue

)

Returns the support type of a property of the cam
Parameters:

prop - the property to get information about

pValue - a variable receiving the kind of support

Returns:
true for success
false on error or just because there were no cams

bool CDSwcOpenAPIclass::CamProperty_Range ( EVidCapProperty prop,

long * pMin,

long * pMax,

long * pDelta

)

Returns the value range of a property of the cam
Parameters:

prop - the property to get information about

pMin,pMax,pDelta - 3 variables receiving the range of the prop

Returns:
true for success
false on error or just because there were no cams

bool CDSwcOpenAPIclass::CamProperty_Set ( EVidCapProperty prop,

long value

)

Sends a property value to the cam
Parameters:

prop - the property to get information about

value - the new value to set

Returns:
true for success
false on error or just because there were no cams

bool CDSwcOpenAPIclass::CamProperty_Get ( EVidCapProperty prop,

long * pValue

)

Returns a property value from the cam
Parameters:

prop - the property to get information about

pValue - a variable receiving the current prop value

Returns:
true for success
false on error or just because there were no cams

bool CDSwcOpenAPIclass::CamChipset ( EKnownChipsetCat * pValue )

Returns the chipset type of the camera (EKnownChipsetCat)
Parameters:

none

Returns:
true for success
false on error (failed for some reason)

char* CDSwcOpenAPIclass::ErrString ( ) [inline]

int CDSwcOpenAPIclass::DllUsers ( )

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

DSwcOpenAPIclass.h

Generated on Tue Oct 31 23:59:08 2006 for DSwcOpen by

1.4.6-NO


Public Types
enum	EKnownChipsetCat { CC_Unknown = 0, CC_SAA8112 = 1, CC_SAA8116 = 3, CC_CREALIVEULTRA = 4, CC_LOGIFUSION = 5 }
	The chipsets that DSwcOpen knows about. More...
enum	EVidCapPropertySupport { PS_no = 0, PS_get = 1, PS_set = 2, PS_both = 3 }
	The capability that DSwcOpen may support for a certain property. More...
enum	EVidCapProperty { CP_FirstElement = 0, CP_Brightness = CP_FirstElement, CP_Contrast = 1, CP_Hue = 2, CP_Saturation = 3, CP_Sharpness = 4, CP_Gamma = 5, CP_ColorEnable = 6, CP_WhiteBalance = 7, CP_BacklightCompensation = 8, CP_WhiteBalanceMode = 9, CP_WhiteBalRed = 10, CP_WhiteBalBlue = 11, CP_FlickerFree = 12, CP_Flicker50_60 = 13, CP_FPS = 14, CP_Exposure = 15, CP_Gain = 16, CP_FlipHorizontal = 17, CP_FlipVertical = 18, CP_AutoExposure = 19, CP_AutoAll = 20, CP_ActualFrameRate = 21, CP_LED = 22, CP_Setting = 23, CP_ExtTrigger = 24, CP_SWTrigger = 25, CP_Pan = 26, CP_Tilt = 27, CP_Roll = 28, CP_Zoom = 29, CP_Iris = 30, CP_Focus = 31, CP_LastElement = CP_Focus }
	All the properties that DSwcOpen may support for a certain webcam. More...
Public Member Functions
	CDSwcOpenAPIclass ()
virtual	~CDSwcOpenAPIclass ()
	hr>
bool	EnumCams ()
	The interface.
void	GetCamStrings (char (camNames[]), unsigned int *numCamNames)
void	GetDevStrings (char (devNames[]), unsigned int *numDevNames)
void	GetCamSerials (char (camSerials[]), unsigned int *numCamSerials)
bool	SetCam (int camNumber)
bool	CamProperty_Support (EVidCapProperty prop, EVidCapPropertySupport *pValue)
bool	CamProperty_Range (EVidCapProperty prop, long pMin, long pMax, long *pDelta)
bool	CamProperty_Set (EVidCapProperty prop, long value)
bool	CamProperty_Get (EVidCapProperty prop, long *pValue)
bool	CamChipset (EKnownChipsetCat *pValue)
char *	ErrString ()
int	DllUsers ()