IGrabber

Interface for grabbing images [Legacy API: 1st generation]. More...

Enumerations
enum	CVC_TIMEOUT_SETTING { CVC_TIMEOUT_DEFAULT = 0 , CVC_TIMEOUT_INFINITE = -1 , CVC_TIMEOUT_STATUS = -2 }
	Specific constants for timeout definitions. More...

Functions
cvbbool_t	CanGrabber (IMG Image)
	This function verifies whether the image supports the Grabber interface. More...
cvbres_t	GetDriverID (IMG Image, cvbguid_t &pID)
	Returns the ID of the driver associated with the passed image. More...
cvbres_t	GetModule (IMG Image, void **ppA, void **ppB, void **ppC)
	Returns a number of device dependant handles to an image acquisition device. More...
cvbres_t	SetTimeout (IMG Image, cvbuint32_t dwTimeout)
	Defines the timeout for all Grabber functions. More...
cvbres_t	Snap (IMG Image)
	Acquires a single image. More...

Detailed Description

Interface for grabbing images [Legacy API: 1st generation].

Enumeration Type Documentation

CVC_TIMEOUT_SETTING

enum CVC_TIMEOUT_SETTING

Specific constants for timeout definitions.

C-specific defines

# define IMPORT(t) extern "C" t __stdcall
... defines the call conventions for the DLL functions.

Attention

This enumeration is deprecated and no longer used. The list below descripes the specific constant declarations and typedefs. There are declared in the header file iCVCDriver.* .

Enumerator
CVC_TIMEOUT_DEFAULT	Use the default timeout of 10s.
CVC_TIMEOUT_INFINITE	Wait as long as possible.
CVC_TIMEOUT_STATUS	Check the timeout status.

Function Documentation

CanGrabber()

cvbbool_t CanGrabber

(

IMG

Image

)

This function verifies whether the image supports the Grabber interface.

Parameters

[in]

Image

Handle of image object.

Returns

TRUE if the image supports the Grabber interface, FALSE otherwise.

Supported platforms:

Win32
Win64
Linux

Examples:

Visual Basic - VB Driver PingPong Example
Visual C++ - VC MDI Example (DLL only)

GetDriverID()

cvbres_t GetDriverID	(	IMG	Image,
		cvbguid_t &	pID
	)

Returns the ID of the driver associated with the passed image.

Use FindDriverName to get the name of the driver as a string.

Parameters

[in]	Image	Handle of image object.
[out]	pID	GUID of Driver.

Returns

0 : OK
<0 : an error occured

Supported platforms:

Win32
Win64
Linux

Related Topics:

FindDriverName

Examples:

Delphi - Delphi Hardware Access Example (needs ICP AMVS or AMSTD) Visual C++ - VC Async Acquisition Example

Example Code in Delphi:

The GUIDs of the supported drivers are specified in the header file of the Driver Dll. For example in iCVCDriver.h for Visual C..

procedure OpenTest;
var img1 : IMG;
    imgNew : IMG;
    guid : TGUID ;
 
begin
  CVImage1.LoadImageByDialog;
  Img1 := IMG ( CVImage1.Image);
 
  // verfy image source
  if (CanGrabber (Img1)) then
  begin
    // get driver id
    GetDriverID(Img1, guid);
    // is it a X64-Analog ?
    if (IsEqualGUID (guid, X64AN_ID)) then // X64AN_ID see driver-header file
    begin
      // X64-Analog supports ICameraSelect2
      CS2SetCamPort ( Img1, 1, 0, imgNew);  // switch to port 1
      ReleaseImage(Img1);
      Img1 := imgNew;
      CVdisplay1.Image := LongInt (Img1);
      CVDisplay1.refresh;
     end;
    end // isEqualIID  X64AN
    else
      ShowMessage ('GUID is not equal no  X64AN');
  end; / CanGrabber
end;

GetModule()

cvbres_t GetModule	(	IMG	Image,
		void **	ppA,
		void **	ppB,
		void **	ppC
	)

Returns a number of device dependant handles to an image acquisition device.

Further details can be found in the CVB Driver User Guide for your image acquisition device.

Parameters

[in]	Image	Handle of image object.
[out]	ppA	First parameter (driver-dependent).
[out]	ppB	Second parameter (driver-dependent).
[out]	ppC	Third parameter (driver-dependent).

Returns

0 : OK
<0 : an error occured

Supported platforms:

Win32
Win64
Linux

Related Topics:

IDeviceControl Interface

Examples:

Delphi - Delphi Hardware Access Example (needs ICP AMVS or AMSTD)

SetTimeout()

cvbres_t SetTimeout	(	IMG	Image,
		cvbuint32_t	dwTimeout
	)

Defines the timeout for all Grabber functions.

This value might be dependent on the minimum or maximum timeout periods allowed by the image acquisition device.

Parameters

[in]	Image	Handle of image object.
[in]	dwTimeout	For more information regarding the specific acquisition device please have a look at the specific Driver User Guide.

Returns

0 : OK
<0 : an error occured

Supported platforms:

Win32
Win64
Linux

Related Topics:

Utilities-dll function SetDefaultTimeout.
Timeout constants (see CVC_TIMEOUT_SETTING).

Snap()

cvbres_t Snap

(

IMG

Image

)

Acquires a single image.

Parameters

[in]

Image

Handle of image object.

Returns

0 : OK
<0 : an error occured

Supported platforms:

Win32
Win64
Linux

Examples:

Visual C++ - VC MDI Example (DLL only)