ClassesClassesClassesClasses | | | | Operators

set_framegrabber_paramset_framegrabber_paramSetFramegrabberParamset_framegrabber_paramSetFramegrabberParamSetFramegrabberParam (Operator)

Name

set_framegrabber_paramset_framegrabber_paramSetFramegrabberParamset_framegrabber_paramSetFramegrabberParamSetFramegrabberParam — Set specific parameters of an image acquistion device.

Signature

set_framegrabber_param( : : AcqHandle, Param, Value : )

Herror set_framegrabber_param(const Hlong AcqHandle, const char* Param, const char* Value)

Herror T_set_framegrabber_param(const Htuple AcqHandle, const Htuple Param, const Htuple Value)

Herror set_framegrabber_param(const HTuple& AcqHandle, const HTuple& Param, const HTuple& Value)

void HFramegrabber::SetFramegrabberParam(const HTuple& Param, const HTuple& Value) const

void SetFramegrabberParam(const HTuple& AcqHandle, const HTuple& Param, const HTuple& Value)

void HFramegrabber::SetFramegrabberParam(const HTuple& Param, const HTuple& Value) const

void HFramegrabber::SetFramegrabberParam(const HString& Param, const HString& Value) const

void HFramegrabber::SetFramegrabberParam(const char* Param, const char* Value) const

void HOperatorSetX.SetFramegrabberParam(
[in] VARIANT AcqHandle, [in] VARIANT Param, [in] VARIANT Value)

void HFramegrabberX.SetFramegrabberParam(
[in] VARIANT Param, [in] VARIANT Value)

static void HOperatorSet.SetFramegrabberParam(HTuple acqHandle, HTuple param, HTuple value)

void HFramegrabber.SetFramegrabberParam(HTuple param, HTuple value)

void HFramegrabber.SetFramegrabberParam(string param, string value)

Description

The operator set_framegrabber_paramset_framegrabber_paramSetFramegrabberParamset_framegrabber_paramSetFramegrabberParamSetFramegrabberParam sets specific parameters for the image acquisition device specified by AcqHandleAcqHandleAcqHandleAcqHandleAcqHandleacqHandle. Additional information for a specific image acquistion device is available via info_framegrabberinfo_framegrabberInfoFramegrabberinfo_framegrabberInfoFramegrabberInfoFramegrabber. A comprehensive documentation of all image acquistion device-specific parameters can be found in the corresponding interface documentation in the directory 'doc/html/reference/acquisition'"doc/html/reference/acquisition""doc/html/reference/acquisition""doc/html/reference/acquisition""doc/html/reference/acquisition""doc/html/reference/acquisition".

Attention

Basically an image acquisition handle AcqHandleAcqHandleAcqHandleAcqHandleAcqHandleacqHandle cannot be used in multiple threads. However, possible exceptions are described in the specific reference documentation of the respective image acquisition interface. Different image acquisition handles can be used safely with different threads for each handle.

For a multithreaded application all image acquisition operators (as listed in open_framegrabberopen_framegrabberOpenFramegrabberopen_framegrabberOpenFramegrabberOpenFramegrabber) are an own group in which info_framegrabberinfo_framegrabberInfoFramegrabberinfo_framegrabberInfoFramegrabberInfoFramegrabber, open_framegrabberopen_framegrabberOpenFramegrabberopen_framegrabberOpenFramegrabberOpenFramegrabber, close_framegrabberclose_framegrabberCloseFramegrabberclose_framegrabberCloseFramegrabberCloseFramegrabber and close_all_framegrabbersclose_all_framegrabbersCloseAllFramegrabbersclose_all_framegrabbersCloseAllFramegrabbersCloseAllFramegrabbers are executed exclusively.

set_framegrabber_paramset_framegrabber_paramSetFramegrabberParamset_framegrabber_paramSetFramegrabberParamSetFramegrabberParam runs in parallel with all non-exclusive operators inside and outside of this group.

Parallelization

Parameters

AcqHandleAcqHandleAcqHandleAcqHandleAcqHandleacqHandle (input_control)  framegrabber HFramegrabber, HTupleHTupleHFramegrabber, HTupleHFramegrabberX, VARIANTHtuple (integer) (IntPtr) (Hlong) (Hlong) (Hlong) (Hlong)

Handle of the acquisition device to be used.

ParamParamParamParamParamparam (input_control)  string(-array) HTupleHTupleHTupleVARIANTHtuple (string) (string) (HString) (char*) (BSTR) (char*)

Parameter name.

Suggested values: 'color_space'"color_space""color_space""color_space""color_space""color_space", 'continuous_grabbing'"continuous_grabbing""continuous_grabbing""continuous_grabbing""continuous_grabbing""continuous_grabbing", 'external_trigger'"external_trigger""external_trigger""external_trigger""external_trigger""external_trigger", 'grab_timeout'"grab_timeout""grab_timeout""grab_timeout""grab_timeout""grab_timeout", 'image_height'"image_height""image_height""image_height""image_height""image_height", 'image_width'"image_width""image_width""image_width""image_width""image_width", 'port'"port""port""port""port""port", 'start_column'"start_column""start_column""start_column""start_column""start_column", 'start_row'"start_row""start_row""start_row""start_row""start_row", 'volatile'"volatile""volatile""volatile""volatile""volatile"

ValueValueValueValueValuevalue (input_control)  string(-array) HTupleHTupleHTupleVARIANTHtuple (string / real / integer) (string / double / int / long) (HString / double / Hlong) (char* / double / Hlong) (BSTR / double / Hlong) (char* / double / Hlong)

Parameter value to be set.

Result

If the image acquisition device is open and the specified parameter / parameter value is supported, the operator set_framegrabber_paramset_framegrabber_paramSetFramegrabberParamset_framegrabber_paramSetFramegrabberParamSetFramegrabberParam returns the value 2 (H_MSG_TRUE). Otherwise an exception is raised.

Possible Predecessors

open_framegrabberopen_framegrabberOpenFramegrabberopen_framegrabberOpenFramegrabberOpenFramegrabber

Possible Successors

grab_imagegrab_imageGrabImagegrab_imageGrabImageGrabImage, grab_datagrab_dataGrabDatagrab_dataGrabDataGrabData, grab_image_startgrab_image_startGrabImageStartgrab_image_startGrabImageStartGrabImageStart, grab_image_asyncgrab_image_asyncGrabImageAsyncgrab_image_asyncGrabImageAsyncGrabImageAsync, grab_data_asyncgrab_data_asyncGrabDataAsyncgrab_data_asyncGrabDataAsyncGrabDataAsync, get_framegrabber_paramget_framegrabber_paramGetFramegrabberParamget_framegrabber_paramGetFramegrabberParamGetFramegrabberParam

See also

open_framegrabberopen_framegrabberOpenFramegrabberopen_framegrabberOpenFramegrabberOpenFramegrabber, info_framegrabberinfo_framegrabberInfoFramegrabberinfo_framegrabberInfoFramegrabberInfoFramegrabber, get_framegrabber_paramget_framegrabber_paramGetFramegrabberParamget_framegrabber_paramGetFramegrabberParamGetFramegrabberParam

Module

Foundation


ClassesClassesClassesClasses | | | | Operators