set_framegrabber_paramset_framegrabber_paramSetFramegrabberParamSetFramegrabberParam (Operator)

Name

set_framegrabber_paramset_framegrabber_paramSetFramegrabberParamSetFramegrabberParam — Set specific parameters of an image acquistion device.

Signature

set_framegrabber_param( : : AcqHandle, Param, Value : )

The operator set_framegrabber_paramset_framegrabber_paramSetFramegrabberParamSetFramegrabberParamSetFramegrabberParam sets specific parameters for the image acquisition device specified by AcqHandleAcqHandleAcqHandleAcqHandleacqHandle. Additional information for a specific image acquisition device is available via info_framegrabberinfo_framegrabberInfoFramegrabberInfoFramegrabberInfoFramegrabber. 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".

Attention

For a multithreaded application all image acquisition operators (as listed in open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberOpenFramegrabber) are an own group in which info_framegrabberinfo_framegrabberInfoFramegrabberInfoFramegrabberInfoFramegrabber, open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberOpenFramegrabber, close_framegrabberclose_framegrabberCloseFramegrabberCloseFramegrabberCloseFramegrabber and close_all_framegrabbersclose_all_framegrabbersCloseAllFramegrabbersCloseAllFramegrabbersCloseAllFramegrabbers are executed exclusively.

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

Execution Information

Multithreading type: reentrant (runs in parallel with non-exclusive operators).
Multithreading scope: global (may be called from any thread).
Processed without parallelization.

This operator modifies the state of the following input parameter:

AcqHandleAcqHandleAcqHandleAcqHandleacqHandle

The value of this parameter may not be shared across multiple threads without external synchronization.

Parameters

AcqHandleAcqHandleAcqHandleAcqHandleacqHandle (input_control, state is modified) framegrabber → (integer)

Handle of the acquisition device to be used.

ParamParamParamParamparam (input_control) string(-array) → (string)

Parameter name.

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

ValueValueValueValuevalue (input_control) string(-array) → (string / real / integer)

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_paramSetFramegrabberParamSetFramegrabberParamSetFramegrabberParam returns the value 2 (H_MSG_TRUE). Otherwise an exception is raised.