Port IMAGE - IMAGE 🛈

Stimulation

This port has no stimulus capabilities.

Specifics

Notes regarding usage on Microsoft Windows

OpenCV needs certain dll libraries that are not shipped by default with some versions of windows. This especially affects Windows 10 N and Windows Server 2012 R2. To use this feature on such machines, you will need to install the corresponding feature packs, for example the Media Feature Pack for Windows 10 or the Windows Server Essentials Media Pack.

Notes regarding recognized cameras

Only cameras that are available via the camera interface of the operating system are recognized by ecu.test. On Windows 10 for example, these cameras must be available in the app “Camera”. An exhaustive list can be found on the website of OpenCV.

If you use more than one camera, the operating system is numbering them in oder of connection (or recognition during startup). Since the number of the camera is given in each image port in the test bench configuration you have to make sure that they are either connected or recognized in the same order.

Notes regarding screenshots

If the positions of windows and screens is not recognized correctly, please try to adjust the zoom factor in the display settings of Windows. It needs to be the same for all displays, we recommend 100%.

Limitations regarding screen recording

• It is not possible to run multiple screen recordings in parallel.

• While a recording is running it is not possible to make a screenshot of any other screen than the one that is being recorded.

• Only changes will be recorded. If no changes occur on the screen that is being recorded, this will probably result in a video that cannot be opened by a media player.

• Not all resolutions are supported. The desktop resolution must not be bigger than 1920x1080.

• Screen recording is supported for image source “Screen”. Recordings for image source “Application window” are not possible.

Limitations when running on Linux

• Taking screenshots of specific windows identified by their title is not supported.

• Creating a screen recording is not supported.

Properties 🛈

Name	Available if	Default value	Valid values	Type	Description
Common
Image source	Common	camera	[camera, image, url, screen, window, stream] Display values: camera: Camera image: Image url: URL screen: Screen window: Application window stream: Stream	string	Select image source
Camera number	Common » Image source: ‘camera’	0	[ONLINE]	int	Channel number (ascending in USB plug order)
Camera backend	Common » Image source: ‘camera’	‘<auto>’	[ONLINE]	string	Backends provided by OpenCV to communicate with cameras. For some camera models a different backend can solve problems.
Frame rate	Common » Image source: ‘camera’	20.0		float	Frames per second
Width	Common » Image source: ‘camera’	640		int	Image width in pixel
Height	Common » Image source: ‘camera’	480		int	Image height in pixel
OpenCV settings	Common » Image source: ‘camera’			string	Allows the configuration of the standard OpenCV properties of the camera. The properties and values must be specified in a JSON format, e.g. {“CAP_PROP_FPS”: 42}.
Connection on demand	Common » Image source: ‘camera’	☐		bool	Must be activated if the camera is not yet available at configuration start and is only started during test execution, for example.
Live preview	Common » Image source: ‘camera’	☐		bool	Streams a live preview on the configured network port. The live stream is available under the toolhost’s IP address and the configured port, e.g. for a local tool connection: http://127.0.0.1:<port>
Open preview window	Common » Image source: ‘camera’ » Live preview	☑		bool	Opens a preview window upon loading the configuration. This window displays the current output of the image source as a livestream and will remain open as long as the test configuration is active.
Port	Common » Image source: ‘camera’ » Live preview	‘<auto>’		string	The network port that will be used for live streaming. Every live stream needs an unique port if live streaming is enabled for multiple video sources. If the value is set to <auto> a free network port will be defined by the system.
Image file	Common » Image source: ‘image’			string	Path to an image file on the tool host. The image will be available as image source during the test execution. Path can be absolute or relative to the tool host base path.
Image-URL	Common » Image source: ‘url’			string	URL to image file. Must start with http://, https:// or ftp:// .
Screen	Common » Image source: ‘screen’	0		int	Screen from which to take a screenshot. (0-N)
Bit rate ❲Mbps❳	Common » Image source: ‘screen’	8		int	Bit rate of the screen recording. A lower bit rate leads to a worse image quality but a smaller file size.
Hardware acceleration	Common » Image source: ‘screen’	☑		bool	Enable this to use hardware acceleration. This may not be supported on all systems.
Application name	Common » Image source: ‘window’			string	Application name
Stream URL	Common » Image source: ‘stream’			string	Path to the stream in the format “PROTOCOL://IP:PORT”, e.g. “tcp://127.0.0.1:50050”, “rtsp://example.com/mystream.mov” or “http://192.168.99.99/mystream.mjpg”
Stream backend	Common » Image source: ‘stream’	‘<auto>’	[ONLINE]	string	Backends provided by OpenCV to open streams. For some streams a different backend can solve playback problems.
OpenCV settings	Common » Image source: ‘stream’			string	Allows the configuration of the standard OpenCV properties for the stream. The properties and values must be specified in a JSON format, e.g. {“CAP_PROP_FPS”: 42}.
Connection on demand	Common » Image source: ‘stream’	☐		bool	Must be activated if the stream is not yet available at configuration start and is only started during test execution, for example.
Live preview	Common » Image source: ‘stream’	☐		bool	Streams a live preview on the configured network port. The live stream is available under the toolhost’s IP address and the configured port, e.g. for a local tool connection: http://127.0.0.1:<port>
Open preview window	Common » Image source: ‘stream’ » Live preview	☑		bool	Opens a preview window upon loading the configuration. This window displays the current output of the image source as a livestream and will remain open as long as the test configuration is active.
Port	Common » Image source: ‘stream’ » Live preview	‘<auto>’		string	The network port that will be used for live streaming. Every live stream needs an unique port if live streaming is enabled for multiple video sources. If the value is set to <auto> a free network port will be defined by the system.
Regular expression	Common » Image source: ‘window’	☐		bool	Name of the application is interpreted as regular expression. You can then for example type “Window na.*” to find windows that start with “Window na”. You can ignore single characters by replacing them with a dot. For example “Window .” will find “Window 1” and “Window 5”
Remove window borders	Common » Image source: ‘window’	☑		bool	Removes the left, bottom and right border on Windows (8 pixels will be truncated on each border). On Windows 10, these borders are invisible.
Crop image	Common	☐		bool	Crops the image by given pixel values from the image borders.
Left	Common » Crop image	0		int	Number of pixels removed from the left border.
Right	Common » Crop image	0		int	Number of pixels removed from the right border.
Top	Common » Crop image	0		int	Number of pixels removed from the top border.
Bottom	Common » Crop image	0		int	Number of pixels removed from the bottom border.
Show text overlay in video recordings	Common	☐		bool	Adds a text overlay with the format “timestamp package name” in the bottom left corner of video recordings.

Jobs 🛈

GetOpenCVProperty

Sets a property of the camera

Parameterization

Parameter

Name	Available if	Default value	Valid values	Type	Description
propertyName		‘CAP_PROP_ANDROID_DEVICE_TORCH’	[‘CAP_PROP_ANDROID_DEVICE_TORCH’, ‘CAP_PROP_APERTURE’, ‘CAP_PROP_ARAVIS_AUTOTRIGGER’, ‘CAP_PROP_AUDIO_BASE_INDEX’, ‘CAP_PROP_AUDIO_DATA_DEPTH’, ‘CAP_PROP_AUDIO_POS’, ‘CAP_PROP_AUDIO_SAMPLES_PER_SECOND’, ‘CAP_PROP_AUDIO_SHIFT_NSEC’, ‘CAP_PROP_AUDIO_STREAM’, ‘CAP_PROP_AUDIO_SYNCHRONIZE’, ‘CAP_PROP_AUDIO_TOTAL_CHANNELS’, ‘CAP_PROP_AUDIO_TOTAL_STREAMS’, ‘CAP_PROP_AUTOFOCUS’, ‘CAP_PROP_AUTO_EXPOSURE’, ‘CAP_PROP_AUTO_WB’, ‘CAP_PROP_BACKEND’, ‘CAP_PROP_BACKLIGHT’, ‘CAP_PROP_BITRATE’, ‘CAP_PROP_BRIGHTNESS’, ‘CAP_PROP_BUFFERSIZE’, ‘CAP_PROP_CHANNEL’, ‘CAP_PROP_CODEC_EXTRADATA_INDEX’, ‘CAP_PROP_CODEC_PIXEL_FORMAT’, ‘CAP_PROP_CONTRAST’, ‘CAP_PROP_CONVERT_RGB’, ‘CAP_PROP_DC1394_MAX’, ‘CAP_PROP_DC1394_MODE_AUTO’, ‘CAP_PROP_DC1394_MODE_MANUAL’, ‘CAP_PROP_DC1394_MODE_ONE_PUSH_AUTO’, ‘CAP_PROP_DC1394_OFF’, ‘CAP_PROP_DTS_DELAY’, ‘CAP_PROP_EXPOSURE’, ‘CAP_PROP_EXPOSUREPROGRAM’, ‘CAP_PROP_FOCUS’, ‘CAP_PROP_FORMAT’, ‘CAP_PROP_FOURCC’, ‘CAP_PROP_FPS’, ‘CAP_PROP_FRAME_COUNT’, ‘CAP_PROP_FRAME_HEIGHT’, ‘CAP_PROP_FRAME_TYPE’, ‘CAP_PROP_FRAME_WIDTH’, ‘CAP_PROP_GAIN’, ‘CAP_PROP_GAMMA’, ‘CAP_PROP_GIGA_FRAME_HEIGH_MAX’, ‘CAP_PROP_GIGA_FRAME_OFFSET_X’, ‘CAP_PROP_GIGA_FRAME_OFFSET_Y’, ‘CAP_PROP_GIGA_FRAME_SENS_HEIGH’, ‘CAP_PROP_GIGA_FRAME_SENS_WIDTH’, ‘CAP_PROP_GIGA_FRAME_WIDTH_MAX’, ‘CAP_PROP_GPHOTO2_COLLECT_MSGS’, ‘CAP_PROP_GPHOTO2_FLUSH_MSGS’, ‘CAP_PROP_GPHOTO2_PREVIEW’, ‘CAP_PROP_GPHOTO2_RELOAD_CONFIG’, ‘CAP_PROP_GPHOTO2_RELOAD_ON_CHANGE’, ‘CAP_PROP_GPHOTO2_WIDGET_ENUMERATE’, ‘CAP_PROP_GSTREAMER_QUEUE_LENGTH’, ‘CAP_PROP_GUID’, ‘CAP_PROP_HUE’, ‘CAP_PROP_HW_ACCELERATION’, ‘CAP_PROP_HW_ACCELERATION_USE_OPENCL’, ‘CAP_PROP_HW_DEVICE’, ‘CAP_PROP_IMAGES_BASE’, ‘CAP_PROP_IMAGES_LAST’, ‘CAP_PROP_INTELPERC_DEPTH_CONFIDENCE_THRESHOLD’, ‘CAP_PROP_INTELPERC_DEPTH_FOCAL_LENGTH_HORZ’, ‘CAP_PROP_INTELPERC_DEPTH_FOCAL_LENGTH_VERT’, ‘CAP_PROP_INTELPERC_DEPTH_LOW_CONFIDENCE_VALUE’, ‘CAP_PROP_INTELPERC_DEPTH_SATURATION_VALUE’, ‘CAP_PROP_INTELPERC_PROFILE_COUNT’, ‘CAP_PROP_INTELPERC_PROFILE_IDX’, ‘CAP_PROP_IOS_DEVICE_EXPOSURE’, ‘CAP_PROP_IOS_DEVICE_FLASH’, ‘CAP_PROP_IOS_DEVICE_FOCUS’, ‘CAP_PROP_IOS_DEVICE_TORCH’, ‘CAP_PROP_IOS_DEVICE_WHITEBALANCE’, ‘CAP_PROP_IRIS’, ‘CAP_PROP_ISO_SPEED’, ‘CAP_PROP_LRF_HAS_KEY_FRAME’, ‘CAP_PROP_MODE’, ‘CAP_PROP_MONOCHROME’, ‘CAP_PROP_N_THREADS’, ‘CAP_PROP_OBSENSOR_INTRINSIC_CX’, ‘CAP_PROP_OBSENSOR_INTRINSIC_CY’, ‘CAP_PROP_OBSENSOR_INTRINSIC_FX’, ‘CAP_PROP_OBSENSOR_INTRINSIC_FY’, ‘CAP_PROP_OPENNI2_MIRROR’, ‘CAP_PROP_OPENNI2_SYNC’, ‘CAP_PROP_OPENNI_APPROX_FRAME_SYNC’, ‘CAP_PROP_OPENNI_BASELINE’, ‘CAP_PROP_OPENNI_CIRCLE_BUFFER’, ‘CAP_PROP_OPENNI_FOCAL_LENGTH’, ‘CAP_PROP_OPENNI_FRAME_MAX_DEPTH’, ‘CAP_PROP_OPENNI_GENERATOR_PRESENT’, ‘CAP_PROP_OPENNI_MAX_BUFFER_SIZE’, ‘CAP_PROP_OPENNI_MAX_TIME_DURATION’, ‘CAP_PROP_OPENNI_OUTPUT_MODE’, ‘CAP_PROP_OPENNI_REGISTRATION’, ‘CAP_PROP_OPENNI_REGISTRATION_ON’, ‘CAP_PROP_OPEN_TIMEOUT_MSEC’, ‘CAP_PROP_ORIENTATION_AUTO’, ‘CAP_PROP_ORIENTATION_META’, ‘CAP_PROP_PAN’, ‘CAP_PROP_POS_AVI_RATIO’, ‘CAP_PROP_POS_FRAMES’, ‘CAP_PROP_POS_MSEC’, ‘CAP_PROP_PTS’, ‘CAP_PROP_PVAPI_BINNINGX’, ‘CAP_PROP_PVAPI_BINNINGY’, ‘CAP_PROP_PVAPI_DECIMATIONHORIZONTAL’, ‘CAP_PROP_PVAPI_DECIMATIONVERTICAL’, ‘CAP_PROP_PVAPI_FRAMESTARTTRIGGERMODE’, ‘CAP_PROP_PVAPI_MULTICASTIP’, ‘CAP_PROP_PVAPI_PIXELFORMAT’, ‘CAP_PROP_READ_TIMEOUT_MSEC’, ‘CAP_PROP_RECTIFICATION’, ‘CAP_PROP_ROLL’, ‘CAP_PROP_SAR_DEN’, ‘CAP_PROP_SAR_NUM’, ‘CAP_PROP_SATURATION’, ‘CAP_PROP_SETTINGS’, ‘CAP_PROP_SHARPNESS’, ‘CAP_PROP_SPEED’, ‘CAP_PROP_STREAM_OPEN_TIME_USEC’, ‘CAP_PROP_TEMPERATURE’, ‘CAP_PROP_TILT’, ‘CAP_PROP_TRIGGER’, ‘CAP_PROP_TRIGGER_DELAY’, ‘CAP_PROP_VIDEO_STREAM’, ‘CAP_PROP_VIDEO_TOTAL_CHANNELS’, ‘CAP_PROP_VIEWFINDER’, ‘CAP_PROP_WB_TEMPERATURE’, ‘CAP_PROP_WHITE_BALANCE_BLUE_U’, ‘CAP_PROP_WHITE_BALANCE_RED_V’, ‘CAP_PROP_XI_ACQ_BUFFER_SIZE’, ‘CAP_PROP_XI_ACQ_BUFFER_SIZE_UNIT’, ‘CAP_PROP_XI_ACQ_FRAME_BURST_COUNT’, ‘CAP_PROP_XI_ACQ_TIMING_MODE’, ‘CAP_PROP_XI_ACQ_TRANSPORT_BUFFER_COMMIT’, ‘CAP_PROP_XI_ACQ_TRANSPORT_BUFFER_SIZE’, ‘CAP_PROP_XI_AEAG’, ‘CAP_PROP_XI_AEAG_LEVEL’, ‘CAP_PROP_XI_AEAG_ROI_HEIGHT’, ‘CAP_PROP_XI_AEAG_ROI_OFFSET_X’, ‘CAP_PROP_XI_AEAG_ROI_OFFSET_Y’, ‘CAP_PROP_XI_AEAG_ROI_WIDTH’, ‘CAP_PROP_XI_AE_MAX_LIMIT’, ‘CAP_PROP_XI_AG_MAX_LIMIT’, ‘CAP_PROP_XI_APPLY_CMS’, ‘CAP_PROP_XI_AUTO_BANDWIDTH_CALCULATION’, ‘CAP_PROP_XI_AUTO_WB’, ‘CAP_PROP_XI_AVAILABLE_BANDWIDTH’, ‘CAP_PROP_XI_BINNING_HORIZONTAL’, ‘CAP_PROP_XI_BINNING_PATTERN’, ‘CAP_PROP_XI_BINNING_SELECTOR’, ‘CAP_PROP_XI_BINNING_VERTICAL’, ‘CAP_PROP_XI_BPC’, ‘CAP_PROP_XI_BUFFERS_QUEUE_SIZE’, ‘CAP_PROP_XI_BUFFER_POLICY’, ‘CAP_PROP_XI_CC_MATRIX_00’, ‘CAP_PROP_XI_CC_MATRIX_01’, ‘CAP_PROP_XI_CC_MATRIX_02’, ‘CAP_PROP_XI_CC_MATRIX_03’, ‘CAP_PROP_XI_CC_MATRIX_10’, ‘CAP_PROP_XI_CC_MATRIX_11’, ‘CAP_PROP_XI_CC_MATRIX_12’, ‘CAP_PROP_XI_CC_MATRIX_13’, ‘CAP_PROP_XI_CC_MATRIX_20’, ‘CAP_PROP_XI_CC_MATRIX_21’, ‘CAP_PROP_XI_CC_MATRIX_22’, ‘CAP_PROP_XI_CC_MATRIX_23’, ‘CAP_PROP_XI_CC_MATRIX_30’, ‘CAP_PROP_XI_CC_MATRIX_31’, ‘CAP_PROP_XI_CC_MATRIX_32’, ‘CAP_PROP_XI_CC_MATRIX_33’, ‘CAP_PROP_XI_CHIP_TEMP’, ‘CAP_PROP_XI_CMS’, ‘CAP_PROP_XI_COLOR_FILTER_ARRAY’, ‘CAP_PROP_XI_COLUMN_FPN_CORRECTION’, ‘CAP_PROP_XI_COOLING’, ‘CAP_PROP_XI_COUNTER_SELECTOR’, ‘CAP_PROP_XI_COUNTER_VALUE’, ‘CAP_PROP_XI_DATA_FORMAT’, ‘CAP_PROP_XI_DEBOUNCE_EN’, ‘CAP_PROP_XI_DEBOUNCE_POL’, ‘CAP_PROP_XI_DEBOUNCE_T0’, ‘CAP_PROP_XI_DEBOUNCE_T1’, ‘CAP_PROP_XI_DEBUG_LEVEL’, ‘CAP_PROP_XI_DECIMATION_HORIZONTAL’, ‘CAP_PROP_XI_DECIMATION_PATTERN’, ‘CAP_PROP_XI_DECIMATION_SELECTOR’, ‘CAP_PROP_XI_DECIMATION_VERTICAL’, ‘CAP_PROP_XI_DEFAULT_CC_MATRIX’, ‘CAP_PROP_XI_DEVICE_MODEL_ID’, ‘CAP_PROP_XI_DEVICE_RESET’, ‘CAP_PROP_XI_DEVICE_SN’, ‘CAP_PROP_XI_DOWNSAMPLING’, ‘CAP_PROP_XI_DOWNSAMPLING_TYPE’, ‘CAP_PROP_XI_EXPOSURE’, ‘CAP_PROP_XI_EXPOSURE_BURST_COUNT’, ‘CAP_PROP_XI_EXP_PRIORITY’, ‘CAP_PROP_XI_FFS_ACCESS_KEY’, ‘CAP_PROP_XI_FFS_FILE_ID’, ‘CAP_PROP_XI_FFS_FILE_SIZE’, ‘CAP_PROP_XI_FRAMERATE’, ‘CAP_PROP_XI_FREE_FFS_SIZE’, ‘CAP_PROP_XI_GAIN’, ‘CAP_PROP_XI_GAIN_SELECTOR’, ‘CAP_PROP_XI_GAMMAC’, ‘CAP_PROP_XI_GAMMAY’, ‘CAP_PROP_XI_GPI_LEVEL’, ‘CAP_PROP_XI_GPI_MODE’, ‘CAP_PROP_XI_GPI_SELECTOR’, ‘CAP_PROP_XI_GPO_MODE’, ‘CAP_PROP_XI_GPO_SELECTOR’, ‘CAP_PROP_XI_HDR’, ‘CAP_PROP_XI_HDR_KNEEPOINT_COUNT’, ‘CAP_PROP_XI_HDR_T1’, ‘CAP_PROP_XI_HDR_T2’, ‘CAP_PROP_XI_HEIGHT’, ‘CAP_PROP_XI_HOUS_BACK_SIDE_TEMP’, ‘CAP_PROP_XI_HOUS_TEMP’, ‘CAP_PROP_XI_HW_REVISION’, ‘CAP_PROP_XI_IMAGE_BLACK_LEVEL’, ‘CAP_PROP_XI_IMAGE_DATA_BIT_DEPTH’, ‘CAP_PROP_XI_IMAGE_DATA_FORMAT’, ‘CAP_PROP_XI_IMAGE_DATA_FORMAT_RGB32_ALPHA’, ‘CAP_PROP_XI_IMAGE_IS_COLOR’, ‘CAP_PROP_XI_IMAGE_PAYLOAD_SIZE’, ‘CAP_PROP_XI_IS_COOLED’, ‘CAP_PROP_XI_IS_DEVICE_EXIST’, ‘CAP_PROP_XI_KNEEPOINT1’, ‘CAP_PROP_XI_KNEEPOINT2’, ‘CAP_PROP_XI_LED_MODE’, ‘CAP_PROP_XI_LED_SELECTOR’, ‘CAP_PROP_XI_LENS_APERTURE_VALUE’, ‘CAP_PROP_XI_LENS_FEATURE’, ‘CAP_PROP_XI_LENS_FEATURE_SELECTOR’, ‘CAP_PROP_XI_LENS_FOCAL_LENGTH’, ‘CAP_PROP_XI_LENS_FOCUS_DISTANCE’, ‘CAP_PROP_XI_LENS_FOCUS_MOVE’, ‘CAP_PROP_XI_LENS_FOCUS_MOVEMENT_VALUE’, ‘CAP_PROP_XI_LENS_MODE’, ‘CAP_PROP_XI_LIMIT_BANDWIDTH’, ‘CAP_PROP_XI_LUT_EN’, ‘CAP_PROP_XI_LUT_INDEX’, ‘CAP_PROP_XI_LUT_VALUE’, ‘CAP_PROP_XI_MANUAL_WB’, ‘CAP_PROP_XI_OFFSET_X’, ‘CAP_PROP_XI_OFFSET_Y’, ‘CAP_PROP_XI_OUTPUT_DATA_BIT_DEPTH’, ‘CAP_PROP_XI_OUTPUT_DATA_PACKING’, ‘CAP_PROP_XI_OUTPUT_DATA_PACKING_TYPE’, ‘CAP_PROP_XI_RECENT_FRAME’, ‘CAP_PROP_XI_REGION_MODE’, ‘CAP_PROP_XI_REGION_SELECTOR’, ‘CAP_PROP_XI_ROW_FPN_CORRECTION’, ‘CAP_PROP_XI_SENSOR_BOARD_TEMP’, ‘CAP_PROP_XI_SENSOR_CLOCK_FREQ_HZ’, ‘CAP_PROP_XI_SENSOR_CLOCK_FREQ_INDEX’, ‘CAP_PROP_XI_SENSOR_DATA_BIT_DEPTH’, ‘CAP_PROP_XI_SENSOR_FEATURE_SELECTOR’, ‘CAP_PROP_XI_SENSOR_FEATURE_VALUE’, ‘CAP_PROP_XI_SENSOR_MODE’, ‘CAP_PROP_XI_SENSOR_OUTPUT_CHANNEL_COUNT’, ‘CAP_PROP_XI_SENSOR_TAPS’, ‘CAP_PROP_XI_SHARPNESS’, ‘CAP_PROP_XI_SHUTTER_TYPE’, ‘CAP_PROP_XI_TARGET_TEMP’, ‘CAP_PROP_XI_TEST_PATTERN’, ‘CAP_PROP_XI_TEST_PATTERN_GENERATOR_SELECTOR’, ‘CAP_PROP_XI_TIMEOUT’, ‘CAP_PROP_XI_TRANSPORT_PIXEL_FORMAT’, ‘CAP_PROP_XI_TRG_DELAY’, ‘CAP_PROP_XI_TRG_SELECTOR’, ‘CAP_PROP_XI_TRG_SOFTWARE’, ‘CAP_PROP_XI_TRG_SOURCE’, ‘CAP_PROP_XI_TS_RST_MODE’, ‘CAP_PROP_XI_TS_RST_SOURCE’, ‘CAP_PROP_XI_USED_FFS_SIZE’, ‘CAP_PROP_XI_WB_KB’, ‘CAP_PROP_XI_WB_KG’, ‘CAP_PROP_XI_WB_KR’, ‘CAP_PROP_XI_WIDTH’, ‘CAP_PROP_ZOOM’]	string	Name of the OpenCV property

Return value

Name	Available if	Default value	Valid values	Type	Description
result				float	Value of the OpenCV property

SetOpenCVProperty

Sets a property of the camera

Parameterization

Parameter

Name	Available if	Default value	Valid values	Type	Description
propertyName		‘CAP_PROP_ANDROID_DEVICE_TORCH’	[‘CAP_PROP_ANDROID_DEVICE_TORCH’, ‘CAP_PROP_APERTURE’, ‘CAP_PROP_ARAVIS_AUTOTRIGGER’, ‘CAP_PROP_AUDIO_BASE_INDEX’, ‘CAP_PROP_AUDIO_DATA_DEPTH’, ‘CAP_PROP_AUDIO_POS’, ‘CAP_PROP_AUDIO_SAMPLES_PER_SECOND’, ‘CAP_PROP_AUDIO_SHIFT_NSEC’, ‘CAP_PROP_AUDIO_STREAM’, ‘CAP_PROP_AUDIO_SYNCHRONIZE’, ‘CAP_PROP_AUDIO_TOTAL_CHANNELS’, ‘CAP_PROP_AUDIO_TOTAL_STREAMS’, ‘CAP_PROP_AUTOFOCUS’, ‘CAP_PROP_AUTO_EXPOSURE’, ‘CAP_PROP_AUTO_WB’, ‘CAP_PROP_BACKEND’, ‘CAP_PROP_BACKLIGHT’, ‘CAP_PROP_BITRATE’, ‘CAP_PROP_BRIGHTNESS’, ‘CAP_PROP_BUFFERSIZE’, ‘CAP_PROP_CHANNEL’, ‘CAP_PROP_CODEC_EXTRADATA_INDEX’, ‘CAP_PROP_CODEC_PIXEL_FORMAT’, ‘CAP_PROP_CONTRAST’, ‘CAP_PROP_CONVERT_RGB’, ‘CAP_PROP_DC1394_MAX’, ‘CAP_PROP_DC1394_MODE_AUTO’, ‘CAP_PROP_DC1394_MODE_MANUAL’, ‘CAP_PROP_DC1394_MODE_ONE_PUSH_AUTO’, ‘CAP_PROP_DC1394_OFF’, ‘CAP_PROP_DTS_DELAY’, ‘CAP_PROP_EXPOSURE’, ‘CAP_PROP_EXPOSUREPROGRAM’, ‘CAP_PROP_FOCUS’, ‘CAP_PROP_FORMAT’, ‘CAP_PROP_FOURCC’, ‘CAP_PROP_FPS’, ‘CAP_PROP_FRAME_COUNT’, ‘CAP_PROP_FRAME_HEIGHT’, ‘CAP_PROP_FRAME_TYPE’, ‘CAP_PROP_FRAME_WIDTH’, ‘CAP_PROP_GAIN’, ‘CAP_PROP_GAMMA’, ‘CAP_PROP_GIGA_FRAME_HEIGH_MAX’, ‘CAP_PROP_GIGA_FRAME_OFFSET_X’, ‘CAP_PROP_GIGA_FRAME_OFFSET_Y’, ‘CAP_PROP_GIGA_FRAME_SENS_HEIGH’, ‘CAP_PROP_GIGA_FRAME_SENS_WIDTH’, ‘CAP_PROP_GIGA_FRAME_WIDTH_MAX’, ‘CAP_PROP_GPHOTO2_COLLECT_MSGS’, ‘CAP_PROP_GPHOTO2_FLUSH_MSGS’, ‘CAP_PROP_GPHOTO2_PREVIEW’, ‘CAP_PROP_GPHOTO2_RELOAD_CONFIG’, ‘CAP_PROP_GPHOTO2_RELOAD_ON_CHANGE’, ‘CAP_PROP_GPHOTO2_WIDGET_ENUMERATE’, ‘CAP_PROP_GSTREAMER_QUEUE_LENGTH’, ‘CAP_PROP_GUID’, ‘CAP_PROP_HUE’, ‘CAP_PROP_HW_ACCELERATION’, ‘CAP_PROP_HW_ACCELERATION_USE_OPENCL’, ‘CAP_PROP_HW_DEVICE’, ‘CAP_PROP_IMAGES_BASE’, ‘CAP_PROP_IMAGES_LAST’, ‘CAP_PROP_INTELPERC_DEPTH_CONFIDENCE_THRESHOLD’, ‘CAP_PROP_INTELPERC_DEPTH_FOCAL_LENGTH_HORZ’, ‘CAP_PROP_INTELPERC_DEPTH_FOCAL_LENGTH_VERT’, ‘CAP_PROP_INTELPERC_DEPTH_LOW_CONFIDENCE_VALUE’, ‘CAP_PROP_INTELPERC_DEPTH_SATURATION_VALUE’, ‘CAP_PROP_INTELPERC_PROFILE_COUNT’, ‘CAP_PROP_INTELPERC_PROFILE_IDX’, ‘CAP_PROP_IOS_DEVICE_EXPOSURE’, ‘CAP_PROP_IOS_DEVICE_FLASH’, ‘CAP_PROP_IOS_DEVICE_FOCUS’, ‘CAP_PROP_IOS_DEVICE_TORCH’, ‘CAP_PROP_IOS_DEVICE_WHITEBALANCE’, ‘CAP_PROP_IRIS’, ‘CAP_PROP_ISO_SPEED’, ‘CAP_PROP_LRF_HAS_KEY_FRAME’, ‘CAP_PROP_MODE’, ‘CAP_PROP_MONOCHROME’, ‘CAP_PROP_N_THREADS’, ‘CAP_PROP_OBSENSOR_INTRINSIC_CX’, ‘CAP_PROP_OBSENSOR_INTRINSIC_CY’, ‘CAP_PROP_OBSENSOR_INTRINSIC_FX’, ‘CAP_PROP_OBSENSOR_INTRINSIC_FY’, ‘CAP_PROP_OPENNI2_MIRROR’, ‘CAP_PROP_OPENNI2_SYNC’, ‘CAP_PROP_OPENNI_APPROX_FRAME_SYNC’, ‘CAP_PROP_OPENNI_BASELINE’, ‘CAP_PROP_OPENNI_CIRCLE_BUFFER’, ‘CAP_PROP_OPENNI_FOCAL_LENGTH’, ‘CAP_PROP_OPENNI_FRAME_MAX_DEPTH’, ‘CAP_PROP_OPENNI_GENERATOR_PRESENT’, ‘CAP_PROP_OPENNI_MAX_BUFFER_SIZE’, ‘CAP_PROP_OPENNI_MAX_TIME_DURATION’, ‘CAP_PROP_OPENNI_OUTPUT_MODE’, ‘CAP_PROP_OPENNI_REGISTRATION’, ‘CAP_PROP_OPENNI_REGISTRATION_ON’, ‘CAP_PROP_OPEN_TIMEOUT_MSEC’, ‘CAP_PROP_ORIENTATION_AUTO’, ‘CAP_PROP_ORIENTATION_META’, ‘CAP_PROP_PAN’, ‘CAP_PROP_POS_AVI_RATIO’, ‘CAP_PROP_POS_FRAMES’, ‘CAP_PROP_POS_MSEC’, ‘CAP_PROP_PTS’, ‘CAP_PROP_PVAPI_BINNINGX’, ‘CAP_PROP_PVAPI_BINNINGY’, ‘CAP_PROP_PVAPI_DECIMATIONHORIZONTAL’, ‘CAP_PROP_PVAPI_DECIMATIONVERTICAL’, ‘CAP_PROP_PVAPI_FRAMESTARTTRIGGERMODE’, ‘CAP_PROP_PVAPI_MULTICASTIP’, ‘CAP_PROP_PVAPI_PIXELFORMAT’, ‘CAP_PROP_READ_TIMEOUT_MSEC’, ‘CAP_PROP_RECTIFICATION’, ‘CAP_PROP_ROLL’, ‘CAP_PROP_SAR_DEN’, ‘CAP_PROP_SAR_NUM’, ‘CAP_PROP_SATURATION’, ‘CAP_PROP_SETTINGS’, ‘CAP_PROP_SHARPNESS’, ‘CAP_PROP_SPEED’, ‘CAP_PROP_STREAM_OPEN_TIME_USEC’, ‘CAP_PROP_TEMPERATURE’, ‘CAP_PROP_TILT’, ‘CAP_PROP_TRIGGER’, ‘CAP_PROP_TRIGGER_DELAY’, ‘CAP_PROP_VIDEO_STREAM’, ‘CAP_PROP_VIDEO_TOTAL_CHANNELS’, ‘CAP_PROP_VIEWFINDER’, ‘CAP_PROP_WB_TEMPERATURE’, ‘CAP_PROP_WHITE_BALANCE_BLUE_U’, ‘CAP_PROP_WHITE_BALANCE_RED_V’, ‘CAP_PROP_XI_ACQ_BUFFER_SIZE’, ‘CAP_PROP_XI_ACQ_BUFFER_SIZE_UNIT’, ‘CAP_PROP_XI_ACQ_FRAME_BURST_COUNT’, ‘CAP_PROP_XI_ACQ_TIMING_MODE’, ‘CAP_PROP_XI_ACQ_TRANSPORT_BUFFER_COMMIT’, ‘CAP_PROP_XI_ACQ_TRANSPORT_BUFFER_SIZE’, ‘CAP_PROP_XI_AEAG’, ‘CAP_PROP_XI_AEAG_LEVEL’, ‘CAP_PROP_XI_AEAG_ROI_HEIGHT’, ‘CAP_PROP_XI_AEAG_ROI_OFFSET_X’, ‘CAP_PROP_XI_AEAG_ROI_OFFSET_Y’, ‘CAP_PROP_XI_AEAG_ROI_WIDTH’, ‘CAP_PROP_XI_AE_MAX_LIMIT’, ‘CAP_PROP_XI_AG_MAX_LIMIT’, ‘CAP_PROP_XI_APPLY_CMS’, ‘CAP_PROP_XI_AUTO_BANDWIDTH_CALCULATION’, ‘CAP_PROP_XI_AUTO_WB’, ‘CAP_PROP_XI_AVAILABLE_BANDWIDTH’, ‘CAP_PROP_XI_BINNING_HORIZONTAL’, ‘CAP_PROP_XI_BINNING_PATTERN’, ‘CAP_PROP_XI_BINNING_SELECTOR’, ‘CAP_PROP_XI_BINNING_VERTICAL’, ‘CAP_PROP_XI_BPC’, ‘CAP_PROP_XI_BUFFERS_QUEUE_SIZE’, ‘CAP_PROP_XI_BUFFER_POLICY’, ‘CAP_PROP_XI_CC_MATRIX_00’, ‘CAP_PROP_XI_CC_MATRIX_01’, ‘CAP_PROP_XI_CC_MATRIX_02’, ‘CAP_PROP_XI_CC_MATRIX_03’, ‘CAP_PROP_XI_CC_MATRIX_10’, ‘CAP_PROP_XI_CC_MATRIX_11’, ‘CAP_PROP_XI_CC_MATRIX_12’, ‘CAP_PROP_XI_CC_MATRIX_13’, ‘CAP_PROP_XI_CC_MATRIX_20’, ‘CAP_PROP_XI_CC_MATRIX_21’, ‘CAP_PROP_XI_CC_MATRIX_22’, ‘CAP_PROP_XI_CC_MATRIX_23’, ‘CAP_PROP_XI_CC_MATRIX_30’, ‘CAP_PROP_XI_CC_MATRIX_31’, ‘CAP_PROP_XI_CC_MATRIX_32’, ‘CAP_PROP_XI_CC_MATRIX_33’, ‘CAP_PROP_XI_CHIP_TEMP’, ‘CAP_PROP_XI_CMS’, ‘CAP_PROP_XI_COLOR_FILTER_ARRAY’, ‘CAP_PROP_XI_COLUMN_FPN_CORRECTION’, ‘CAP_PROP_XI_COOLING’, ‘CAP_PROP_XI_COUNTER_SELECTOR’, ‘CAP_PROP_XI_COUNTER_VALUE’, ‘CAP_PROP_XI_DATA_FORMAT’, ‘CAP_PROP_XI_DEBOUNCE_EN’, ‘CAP_PROP_XI_DEBOUNCE_POL’, ‘CAP_PROP_XI_DEBOUNCE_T0’, ‘CAP_PROP_XI_DEBOUNCE_T1’, ‘CAP_PROP_XI_DEBUG_LEVEL’, ‘CAP_PROP_XI_DECIMATION_HORIZONTAL’, ‘CAP_PROP_XI_DECIMATION_PATTERN’, ‘CAP_PROP_XI_DECIMATION_SELECTOR’, ‘CAP_PROP_XI_DECIMATION_VERTICAL’, ‘CAP_PROP_XI_DEFAULT_CC_MATRIX’, ‘CAP_PROP_XI_DEVICE_MODEL_ID’, ‘CAP_PROP_XI_DEVICE_RESET’, ‘CAP_PROP_XI_DEVICE_SN’, ‘CAP_PROP_XI_DOWNSAMPLING’, ‘CAP_PROP_XI_DOWNSAMPLING_TYPE’, ‘CAP_PROP_XI_EXPOSURE’, ‘CAP_PROP_XI_EXPOSURE_BURST_COUNT’, ‘CAP_PROP_XI_EXP_PRIORITY’, ‘CAP_PROP_XI_FFS_ACCESS_KEY’, ‘CAP_PROP_XI_FFS_FILE_ID’, ‘CAP_PROP_XI_FFS_FILE_SIZE’, ‘CAP_PROP_XI_FRAMERATE’, ‘CAP_PROP_XI_FREE_FFS_SIZE’, ‘CAP_PROP_XI_GAIN’, ‘CAP_PROP_XI_GAIN_SELECTOR’, ‘CAP_PROP_XI_GAMMAC’, ‘CAP_PROP_XI_GAMMAY’, ‘CAP_PROP_XI_GPI_LEVEL’, ‘CAP_PROP_XI_GPI_MODE’, ‘CAP_PROP_XI_GPI_SELECTOR’, ‘CAP_PROP_XI_GPO_MODE’, ‘CAP_PROP_XI_GPO_SELECTOR’, ‘CAP_PROP_XI_HDR’, ‘CAP_PROP_XI_HDR_KNEEPOINT_COUNT’, ‘CAP_PROP_XI_HDR_T1’, ‘CAP_PROP_XI_HDR_T2’, ‘CAP_PROP_XI_HEIGHT’, ‘CAP_PROP_XI_HOUS_BACK_SIDE_TEMP’, ‘CAP_PROP_XI_HOUS_TEMP’, ‘CAP_PROP_XI_HW_REVISION’, ‘CAP_PROP_XI_IMAGE_BLACK_LEVEL’, ‘CAP_PROP_XI_IMAGE_DATA_BIT_DEPTH’, ‘CAP_PROP_XI_IMAGE_DATA_FORMAT’, ‘CAP_PROP_XI_IMAGE_DATA_FORMAT_RGB32_ALPHA’, ‘CAP_PROP_XI_IMAGE_IS_COLOR’, ‘CAP_PROP_XI_IMAGE_PAYLOAD_SIZE’, ‘CAP_PROP_XI_IS_COOLED’, ‘CAP_PROP_XI_IS_DEVICE_EXIST’, ‘CAP_PROP_XI_KNEEPOINT1’, ‘CAP_PROP_XI_KNEEPOINT2’, ‘CAP_PROP_XI_LED_MODE’, ‘CAP_PROP_XI_LED_SELECTOR’, ‘CAP_PROP_XI_LENS_APERTURE_VALUE’, ‘CAP_PROP_XI_LENS_FEATURE’, ‘CAP_PROP_XI_LENS_FEATURE_SELECTOR’, ‘CAP_PROP_XI_LENS_FOCAL_LENGTH’, ‘CAP_PROP_XI_LENS_FOCUS_DISTANCE’, ‘CAP_PROP_XI_LENS_FOCUS_MOVE’, ‘CAP_PROP_XI_LENS_FOCUS_MOVEMENT_VALUE’, ‘CAP_PROP_XI_LENS_MODE’, ‘CAP_PROP_XI_LIMIT_BANDWIDTH’, ‘CAP_PROP_XI_LUT_EN’, ‘CAP_PROP_XI_LUT_INDEX’, ‘CAP_PROP_XI_LUT_VALUE’, ‘CAP_PROP_XI_MANUAL_WB’, ‘CAP_PROP_XI_OFFSET_X’, ‘CAP_PROP_XI_OFFSET_Y’, ‘CAP_PROP_XI_OUTPUT_DATA_BIT_DEPTH’, ‘CAP_PROP_XI_OUTPUT_DATA_PACKING’, ‘CAP_PROP_XI_OUTPUT_DATA_PACKING_TYPE’, ‘CAP_PROP_XI_RECENT_FRAME’, ‘CAP_PROP_XI_REGION_MODE’, ‘CAP_PROP_XI_REGION_SELECTOR’, ‘CAP_PROP_XI_ROW_FPN_CORRECTION’, ‘CAP_PROP_XI_SENSOR_BOARD_TEMP’, ‘CAP_PROP_XI_SENSOR_CLOCK_FREQ_HZ’, ‘CAP_PROP_XI_SENSOR_CLOCK_FREQ_INDEX’, ‘CAP_PROP_XI_SENSOR_DATA_BIT_DEPTH’, ‘CAP_PROP_XI_SENSOR_FEATURE_SELECTOR’, ‘CAP_PROP_XI_SENSOR_FEATURE_VALUE’, ‘CAP_PROP_XI_SENSOR_MODE’, ‘CAP_PROP_XI_SENSOR_OUTPUT_CHANNEL_COUNT’, ‘CAP_PROP_XI_SENSOR_TAPS’, ‘CAP_PROP_XI_SHARPNESS’, ‘CAP_PROP_XI_SHUTTER_TYPE’, ‘CAP_PROP_XI_TARGET_TEMP’, ‘CAP_PROP_XI_TEST_PATTERN’, ‘CAP_PROP_XI_TEST_PATTERN_GENERATOR_SELECTOR’, ‘CAP_PROP_XI_TIMEOUT’, ‘CAP_PROP_XI_TRANSPORT_PIXEL_FORMAT’, ‘CAP_PROP_XI_TRG_DELAY’, ‘CAP_PROP_XI_TRG_SELECTOR’, ‘CAP_PROP_XI_TRG_SOFTWARE’, ‘CAP_PROP_XI_TRG_SOURCE’, ‘CAP_PROP_XI_TS_RST_MODE’, ‘CAP_PROP_XI_TS_RST_SOURCE’, ‘CAP_PROP_XI_USED_FFS_SIZE’, ‘CAP_PROP_XI_WB_KB’, ‘CAP_PROP_XI_WB_KG’, ‘CAP_PROP_XI_WB_KR’, ‘CAP_PROP_XI_WIDTH’, ‘CAP_PROP_ZOOM’]	string	Name of the OpenCV property
propertyValue				float	Value of the OpenCV property

StartRecording

Starts recording

StopRecording

Stops recording

2025-12-05