set_framegrabber_param (Operator)

Name

set_framegrabber_param — Set specific parameters of a image acquistion device.

Synopsis

set_framegrabber_param( : : AcqHandle, Param, Value : )

Description

The operator set_framegrabber_param sets specific parameters for the image acquisition device specified by AcqHandle.

Parameters

AcqHandle (input_control)	framegrabber → (integer)
Handle of the acquisition device to be used.

Param (input_control)	string(-array) → (string)
Parameter name.
Suggested values: 'color_space', 'continuous_grabbing', 'external_trigger', 'grab_timeout', 'image_height', 'image_width', 'port', 'start_column', 'start_row', 'volatile'

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

Parallelization Information

set_framegrabber_param is reentrant and processed without parallelization.

Possible Predecessors

open_framegrabber

Possible Successors

grab_image, grab_data, grab_image_start, grab_image_async, grab_data_async, get_framegrabber_param

See also

open_framegrabber, info_framegrabber, get_framegrabber_param

Module

Foundation