Property Identifiers

A lot of common property identifiers are described here. More...

Macros

#define  IC4_PROPID_ACQUISITION_BURST_FRAME_COUNT   "AcquisitionBurstFrameCount"

Number of frames to acquire for each trigger.
#define  IC4_PROPID_ACQUISITION_BURST_INTERVAL   "AcquisitionBurstInterval"

Minimum interval between frames in an acquisition burst.
#define IC4_PROPID_ACQUISITION_FRAME_RATE   "AcquisitionFrameRate"

Controls the acquisition rate at which the frames are captured.
#define IC4_PROPID_ACQUISITION_MODE   "AcquisitionMode"

Sets the acquisition mode of the device.
#define IC4_PROPID_ACQUISITION_START   "AcquisitionStart"

Starts the Acquisition of the device.
#define IC4_PROPID_ACQUISITION_STOP   "AcquisitionStop"

Stops the Acquisition of the device at the end of the current Frame.
#define IC4_PROPID_ACTION_DEVICE_KEY   "ActionDeviceKey"

Provides the device key that allows the device to check the validity of action commands.
#define IC4_PROPID_ACTION_GROUP_KEY   "ActionGroupKey"

Provides the key that the device will use to validate the action on reception of the action protocol message.
#define IC4_PROPID_ACTION_GROUP_MASK   "ActionGroupMask"

Provides the mask that the device will use to validate the action on reception of the action protocol message.

#define IC4_PROPID_ACTION_QUEUE_SIZE   "ActionQueueSize"

Indicates the size of the scheduled action commands queue.
#define IC4_PROPID_ACTION_SCHEDULER_CANCEL   "ActionSchedulerCancel"

Cancels all scheduled actions.
#define IC4_PROPID_ACTION_SCHEDULER_COMMIT   "ActionSchedulerCommit"

Schedules the action to be executed time specified by ActionSchedulerTime, with optional repetition in intervals of ActionSchedulerInterval.
#define IC4_PROPID_ACTION_SCHEDULER_INTERVAL   "ActionSchedulerInterval"

Action repetition interval.

#define IC4_PROPID_ACTION_SCHEDULER_STATUS   "ActionSchedulerStatus"

Indicates whether there are actions scheduled.
#define IC4_PROPID_ACTION_SCHEDULER_TIME   "ActionSchedulerTime"

Camera time for when the action is to be scheduled.
#define IC4_PROPID_ACTION_SELECTOR   "ActionSelector"

Selects to which Action Signal further Action settings apply.
#define IC4_PROPID_AUTO_FOCUS_ROI_ENABLE   "AutoFocusROIEnable"

Enable the region of interest for auto focus.
#define IC4_PROPID_AUTO_FOCUS_ROI_HEIGHT   "AutoFocusROIHeight"

Vertical size of the auto focus region of interest.
#define IC4_PROPID_AUTO_FOCUS_ROI_LEFT   "AutoFocusROILeft"

Horizontal offset of the auto focus region of interest.
#define IC4_PROPID_AUTO_FOCUS_ROI_TOP   "AutoFocusROITop"

Vertical offset of the auto focus region of interest.

#define IC4_PROPID_AUTO_FOCUS_ROI_WIDTH   "AutoFocusROIWidth"

Horizontal size of the auto focus region of interest.
#define IC4_PROPID_AUTO_FUNCTIONS_ROI_ENABLE   "AutoFunctionsROIEnable"

Enable the region of interest for auto functions.
#define IC4_PROPID_AUTO_FUNCTIONS_ROI_HEIGHT   "AutoFunctionsROIHeight"

Vertical size of the auto functions region of interest.
#define IC4_PROPID_AUTO_FUNCTIONS_ROI_LEFT   "AutoFunctionsROILeft"

Horizontal offset of the auto functions region of interest.
#define IC4_PROPID_AUTO_FUNCTIONS_ROI_PRESET   "AutoFunctionsROIPreset"

Select a predefined region of interest for auto functions.
#define IC4_PROPID_AUTO_FUNCTIONS_ROI_TOP   "AutoFunctionsROITop"

Vertical offset of the auto functions region of interest.
#define IC4_PROPID_AUTO_FUNCTIONS_ROI_WIDTH   "AutoFunctionsROIWidth"

Horizontal size of the auto functions region of interest.
#define IC4_PROPID_BALANCE_RATIO   "BalanceRatio"

Controls ratio of the selected color component to a reference color component.

#define IC4_PROPID_BALANCE_RATIO_SELECTOR   "BalanceRatioSelector"

This enumeration selects a balance ratio control to configuration.
#define IC4_PROPID_BALANCE_WHITE_AUTO   "BalanceWhiteAuto"

Controls the mode for automatic white balancing between the color channels.
#define IC4_PROPID_BALANCE_WHITE_AUTO_PRESET   "BalanceWhiteAutoPreset"

Selects a specific preset for automatic white balance.
#define IC4_PROPID_BALANCE_WHITE_MODE   "BalanceWhiteMode"

Configures the way auto white balance works.
#define IC4_PROPID_BALANCE_WHITE_TEMPERATURE   "BalanceWhiteTemperature"

Adjusts the white balance controls to match the ambient light temperature.
#define IC4_PROPID_BALANCE_WHITE_TEMPERATURE_PRESET   "BalanceWhiteTemperaturePreset"

Selects a specific white balance preset.
#define IC4_PROPID_BINNING_HORIZONTAL   "BinningHorizontal"

Number of horizontal photo-sensitive cells to combine together.

#define IC4_PROPID_BINNING_VERTICAL   "BinningVertical"

Number of vertical photo-sensitive cells to combine together.
#define IC4_PROPID_BLACK_LEVEL   "BlackLevel"

Controls the analog black level as an absolute physical value.
#define IC4_PROPID_CHUNK_BLOCK_ID   "ChunkBlockId"

Returns the block ID (frame number) of the image.
#define IC4_PROPID_CHUNK_ENABLE   "ChunkEnable"

Enables the inclusion of the selected Chunk data in the payload of the image.
#define IC4_PROPID_CHUNK_EXPOSURE_TIME   "ChunkExposureTime"

Returns the exposure time used to capture the image.
#define IC4_PROPID_CHUNK_GAIN   "ChunkGain"

Returns the gain used to capture the image.
#define IC4_PROPID_CHUNK_IMAGE   "ChunkImage"

Returns the entire image data included in the payload.
#define IC4_PROPID_CHUNK_IMX174_FRAME_ID   "ChunkIMX174FrameId"

IMX174 double exposure frame id.
#define IC4_PROPID_CHUNK_IMX174_FRAME_SET   "ChunkIMX174FrameSet"

IMX174 double exposure frame set identifier.
#define IC4_PROPID_CHUNK_MODE_ACTIVE   "ChunkModeActive"

Activates the inclusion of Chunk data in the payload of the image.
#define IC4_PROPID_CHUNK_MULTI_FRAME_SET_FRAME_ID   "ChunkMultiFrameSetFrameId"

Returns the frame id in the frame set in Multi Frame Set Output Mode.
#define IC4_PROPID_CHUNK_MULTI_FRAME_SET_ID   "ChunkMultiFrameSetId"

Returns the id of the frame set in Multi Frame Set Output Mode.
#define IC4_PROPID_CHUNK_SELECTOR   "ChunkSelector"

Selects which Chunk to enable or control.
#define IC4_PROPID_COLOR_TRANSFORMATION_ENABLE   "ColorTransformationEnable"

Activates the selected Color Transformation module.
#define IC4_PROPID_COLOR_TRANSFORMATION_SELECTOR   "ColorTransformationSelector"

Selects which Color Transformation module is controlled by the various Color Transformation features.
#define IC4_PROPID_COLOR_TRANSFORMATION_VALUE   "ColorTransformationValue"

Represents the value of the selected Gain factor or Offset inside the Transformation matrix.
#define IC4_PROPID_COLOR_TRANSFORMATION_VALUE_SELECTOR   "ColorTransformationValueSelector"

Selects the Gain factor or Offset of the Transformation matrix to access in the selected Color Transformation module.
#define IC4_PROPID_CONTRAST   "Contrast"

Controls Contrast.
#define IC4_PROPID_DECIMATION_HORIZONTAL   "DecimationHorizontal"

Horizontal sub-sampling of the image.
#define IC4_PROPID_DECIMATION_VERTICAL   "DecimationVertical"

Vertical sub-sampling of the image.

#define IC4_PROPID_DENOISE   "Denoise"

Controls the strength of the denoise algorithm.
#define IC4_PROPID_DEVICE_EVENT_CHANNEL_COUNT   "DeviceEventChannelCount"

Indicates the number of event channels supported by the device.
#define IC4_PROPID_DEVICE_FACTORY_RESET   "DeviceFactoryReset"

Resets all user-programmable non-volatile memory to default.
#define IC4_PROPID_DEVICE_FIRMWARE_VERSION   "DeviceFirmwareVersion"

Version of the device.

#define IC4_PROPID_DEVICE_LINK_HEARTBEAT_TIMEOUT   "DeviceLinkHeartbeatTimeout"

Controls the current heartbeat timeout of the specific Link.
#define IC4_PROPID_DEVICE_LINK_SELECTOR   "DeviceLinkSelector"

Selects which Link of the device to control.
#define IC4_PROPID_DEVICE_MODEL_NAME   "DeviceModelName"

Model of the device.

#define IC4_PROPID_DEVICE_RESET   "DeviceReset"

Resets the device to its power up state.
#define IC4_PROPID_DEVICE_SCAN_TYPE   "DeviceScanType"

Returns the scan type of the sensor of the device.
#define IC4_PROPID_DEVICE_SERIAL_NUMBER   "DeviceSerialNumber"

Device's serial number.

#define IC4_PROPID_DEVICE_SFNC_VERSION_MAJOR   "DeviceSFNCVersionMajor"

Major version of the Standard Features Naming Convention that was used to create the device's GenICam XML.
#define IC4_PROPID_DEVICE_SFNC_VERSION_MINOR   "DeviceSFNCVersionMinor"

Minor version of the Standard Features Naming Convention that was used to create the device's GenICam XML.
#define IC4_PROPID_DEVICE_SFNC_VERSION_SUB_MINOR   "DeviceSFNCVersionSubMinor"

Sub minor version of the Standard Features Naming Convention that was used to create the device's GenICam XML.
#define IC4_PROPID_DEVICE_STREAM_CHANNEL_COUNT   "DeviceStreamChannelCount"

Indicates the number of streaming channels supported by the device.
#define IC4_PROPID_DEVICE_STREAM_CHANNEL_ENDIANNESS   "DeviceStreamChannelEndianness"

Endianess of multi-byte pixel data for this stream.
#define IC4_PROPID_DEVICE_STREAM_CHANNEL_LINK   "DeviceStreamChannelLink"

Index of device`s Link to use for streaming the specifed stream channel.
#define IC4_PROPID_DEVICE_STREAM_CHANNEL_PACKET_SIZE   "DeviceStreamChannelPacketSize"

Specifies the stream packet size, in bytes, to send on the selected channel.
#define IC4_PROPID_DEVICE_STREAM_CHANNEL_SELECTOR   "DeviceStreamChannelSelector"

Selects the stream channel to control.
#define IC4_PROPID_DEVICE_STREAM_CHANNEL_TYPE   "DeviceStreamChannelType"

Reports the type of the stream channel.

#define IC4_PROPID_DEVICE_TEMPERATURE   "DeviceTemperature"

Device temperature in degrees Celsius (°C).

#define IC4_PROPID_DEVICE_TEMPERATURE_SELECTOR   "DeviceTemperatureSelector"

Selects the location within the device, where the temperature will be measured.

#define IC4_PROPID_DEVICE_TL_TYPE   "DeviceTLType"

Transport Layer type of the device.
#define IC4_PROPID_DEVICE_TL_VERSION_MAJOR   "DeviceTLVersionMajor"

Major version of the Transport Layer of the device.
#define IC4_PROPID_DEVICE_TL_VERSION_MINOR   "DeviceTLVersionMinor"

Minor version of the Transport Layer of the device.
#define IC4_PROPID_DEVICE_TL_VERSION_SUB_MINOR   "DeviceTLVersionSubMinor"

Sub minor version of the Transport Layer of the device.
#define IC4_PROPID_DEVICE_TYPE   "DeviceType"

Returns the device type.

#define IC4_PROPID_DEVICE_USER_ID   "DeviceUserID"

User-programmable device identifier.

#define IC4_PROPID_DEVICE_VENDOR_NAME   "DeviceVendorName"

Name of the manufacturer of the device.
#define IC4_PROPID_DEVICE_VERSION   "DeviceVersion"

Version of the device.

#define IC4_PROPID_DISABLE_INFO_OVERLAY   "DisableInfoOverlay"

Disables the HDMI format info overlay.

#define IC4_PROPID_EVENT_EXPOSURE_END   "EventExposureEnd"

Unique identifier of the Exposure End event.
#define IC4_PROPID_EVENT_EXPOSURE_END_FRAME_ID   "EventExposureEndFrameID"

Frame ID of the Exposure End event.
#define IC4_PROPID_EVENT_EXPOSURE_END_TIMESTAMP   "EventExposureEndTimestamp"

Timestamp of the Exposure End event.
#define IC4_PROPID_EVENT_FOCUS_MOVE_COMPLETED   "EventFocusMoveCompleted"

Unique identifier of the Focus Move Completed event.
#define IC4_PROPID_EVENT_FOCUS_MOVE_COMPLETED_FOCUS   "EventFocusMoveCompletedFocus"

Focus value of the Focus Move Completed event.
#define IC4_PROPID_EVENT_FOCUS_MOVE_COMPLETED_TIMESTAMP   "EventFocusMoveCompletedTimestamp"

Timestamp of the Focus Move Completed event.
#define IC4_PROPID_EVENT_FRAME_TRIGGER_MISSED   "EventFrameTriggerMissed"

Unique identifier of the Frame Trigger Missed event.
#define IC4_PROPID_EVENT_FRAME_TRIGGER_MISSED_TIMESTAMP   "EventFrameTriggerMissedTimestamp"

Timestamp of the Frame Trigger Missed event.
#define IC4_PROPID_EVENT_LINE1_FALLING_EDGE   "EventLine1FallingEdge"

Unique identifier of the Line1 Falling Edge event.

#define IC4_PROPID_EVENT_LINE1_FALLING_EDGE_TIMESTAMP   "EventLine1FallingEdgeTimestamp"

Timestamp of the Line1 Falling Edge event.

#define IC4_PROPID_EVENT_LINE1_RISING_EDGE   "EventLine1RisingEdge"

Unique identifier of the Line1 Rising Edge event.
#define IC4_PROPID_EVENT_LINE1_RISING_EDGE_TIMESTAMP   "EventLine1RisingEdgeTimestamp"

Timestamp of the Line1 Rising Edge event.
#define IC4_PROPID_EVENT_NOTIFICATION   "EventNotification"

Enables event notifications for the currently selected event.
#define IC4_PROPID_EVENT_SELECTOR   "EventSelector"

Sets the event notification to be enabled.
#define IC4_PROPID_EVENT_TEST   "EventTest"

Unique identifier of the Test event.
#define IC4_PROPID_EVENT_TEST_TIMESTAMP   "EventTestTimestamp"

Timestamp of the test event.
#define IC4_PROPID_EVENT_ZOOM_MOVE_COMPLETED   "EventZoomMoveCompleted"

Unique identifier of the Zoom Move Completed event.
#define IC4_PROPID_EVENT_ZOOM_MOVE_COMPLETED_TIMESTAMP   "EventZoomMoveCompletedTimestamp"

Timestamp of the Zoom Move Completed event.
#define IC4_PROPID_EVENT_ZOOM_MOVE_COMPLETED_ZOOM   "EventZoomMoveCompletedZoom"

Zoom value of the Zoom Move Completed event.
#define IC4_PROPID_EXPAND_OUTPUT_RANGE   "ExpandOutputRange"

Use the full brightness range when receiving YUV data via HDMI.
#define IC4_PROPID_EXPOSURE_AUTO   "ExposureAuto"

Sets the automatic exposure mode when ExposureMode is Timed.
#define IC4_PROPID_EXPOSURE_AUTO_HIGHLIGH_REDUCTION   "ExposureAutoHighlighReduction"

Lets the ExposureAuto/GainAuto algorithm try to avoid over-exposures.
#define IC4_PROPID_EXPOSURE_AUTO_HIGHLIGHT_REDUCTION   "ExposureAutoHighlightReduction"

Lets the ExposureAuto/GainAuto algorithm try to avoid over-exposures.
#define IC4_PROPID_EXPOSURE_AUTO_LOWER_LIMIT   "ExposureAutoLowerLimit"

Lower limit of the ExposureAuto function.
#define IC4_PROPID_EXPOSURE_AUTO_REFERENCE   "ExposureAutoReference"

Configures the target image brightness of the ExposureAuto/GainAuto algorithm.
#define IC4_PROPID_EXPOSURE_AUTO_UPPER_LIMIT   "ExposureAutoUpperLimit"

Upper limit of the ExposureAuto function.
#define IC4_PROPID_EXPOSURE_AUTO_UPPER_LIMIT_AUTO   "ExposureAutoUpperLimitAuto"

Automatically sets the upper limit to match the Acquisition Frame Rate.
#define IC4_PROPID_EXPOSURE_TIME   "ExposureTime"

Sets the Exposure time when ExposureMode is Timed and ExposureAuto is Off.
#define IC4_PROPID_FILE_ACCESS_BUFFER   "FileAccessBuffer"

Defines the intermediate access buffer that allows the exchange of data between the device file storage and the application.
#define IC4_PROPID_FILE_ACCESS_LENGTH   "FileAccessLength"

Controls the Length of the mapping between the device file storage and the FileAccessBuffer.
#define IC4_PROPID_FILE_ACCESS_OFFSET   "FileAccessOffset"

Controls the Offset of the mapping between the device file storage and the FileAccessBuffer.
#define IC4_PROPID_FILE_OPEN_MODE   "FileOpenMode"

Selects the access mode in which a file is opened in the device.
#define IC4_PROPID_FILE_OPERATION_EXECUTE   "FileOperationExecute"

Executes the operation selected by FileOperationSelector on the selected file.
#define IC4_PROPID_FILE_OPERATION_RESULT   "FileOperationResult"

Represents the file operation result.
#define IC4_PROPID_FILE_OPERATION_SELECTOR   "FileOperationSelector"

Selects the target operation for the selected file in the device.
#define IC4_PROPID_FILE_OPERATION_STATUS   "FileOperationStatus"

Represents the file operation execution status.
#define IC4_PROPID_FILE_SELECTOR   "FileSelector"

Selects the target file in the device.
#define IC4_PROPID_FILE_SIZE   "FileSize"

Represents the size of the selected file in bytes.
#define IC4_PROPID_FOCUS   "Focus"

Changes the Focus setting of the lens.
#define IC4_PROPID_FOCUS_AUTO   "FocusAuto"

Enables automatic Focus control.
#define IC4_PROPID_GAIN   "Gain"

Controls the gain as an absolute physical value.
#define IC4_PROPID_GAIN_AUTO   "GainAuto"

Sets the automatic gain control mode.
#define IC4_PROPID_GAIN_AUTO_LOWER_LIMIT   "GainAutoLowerLimit"

Lower limit of the GainAuto function.
#define IC4_PROPID_GAIN_AUTO_UPPER_LIMIT   "GainAutoUpperLimit"

Upper limit of the GainAuto function.
#define IC4_PROPID_GAIN_MODE   "GainMode"

Configures the sensor-specific Gain (LCG/HCG) setting.
#define IC4_PROPID_GAMMA   "Gamma"

Controls the gamma correction of pixel intensity.
#define IC4_PROPID_GEV_GVSP_EXTENDED_ID_MODE   "GevGVSPExtendedIDMode"

Enables the extended IDs mode.
#define IC4_PROPID_GEV_SCPS_DO_NOT_FRAGMENT   "GevSCPSDoNotFragment"

The state of this feature is copied into the "do not fragment" bit of IP header of each stream packet.
#define IC4_PROPID_GEV_SCPS_PACKET_SIZE   "GevSCPSPacketSize"

This GigE Vision specific feature corresponds to DeviceStreamChannelPacketSize and should be kept in sync with it.
#define IC4_PROPID_GP_IN   "GPIn"

Status of the digital input pin.
#define IC4_PROPID_GP_OUT   "GPOut"

Status of the digital output pin.
#define IC4_PROPID_HEIGHT   "Height"

Height of the image provided by the device (in pixels).
#define IC4_PROPID_HEIGHT_MAX   "HeightMax"

Maximum height of the image (in pixels).
#define IC4_PROPID_HUE   "Hue"

Color Hue.
#define IC4_PROPID_IMX174_HARDWARE_WDR_ENABLE   "IMX174HardwareWDREnable"

Enable IMX174 WDR mode.

#define IC4_PROPID_IMX174_HARDWARE_WDR_SHUTTER_MODE   "IMX174HardwareWDRShutterMode"

Select the IMX174 WDR shutter mode.

#define IC4_PROPID_IMX174_WDR_SHUTTER2   "IMX174WDRShutter2"

Exposure time that is used for every other frame, if IMX174 WDR mode is enabled.
#define IC4_PROPID_IMX_LOW_LATENCY_TRIGGER_MODE   "IMXLowLatencyTriggerMode"

Enables the low-latency mode for IMX global shutter sensors.
#define IC4_PROPID_INPUT_BITS   "InputBits"

The detected bits per pixel of the HDMI source.

#define IC4_PROPID_INPUT_FP1KS   "InputFp1ks"

The detected frame rate of the HDMI source.
#define IC4_PROPID_INPUT_HEIGHT   "InputHeight"

The detected width of the HDMI input image.
#define IC4_PROPID_INPUT_WIDTH   "InputWidth"

The detected width of the HDMI input image.

#define IC4_PROPID_IR_CUT_FILTER_ENABLE   "IRCutFilterEnable"

Enables the IRCutFilter in from of the sensor.
#define IC4_PROPID_IRIS   "Iris"

Changes the Iris setting of the lens.
#define IC4_PROPID_IRIS_AUTO   "IrisAuto"

Enables automatic Iris control.
#define IC4_PROPID_LUT_ENABLE   "LUTEnable"

Activates the LUT.
#define IC4_PROPID_LUT_INDEX   "LUTIndex"

Control the index (offset) of the coefficient to access in the LUT.
#define IC4_PROPID_LUT_SELECTOR   "LUTSelector"

Selects which LUT to control.
#define IC4_PROPID_LUT_VALUE   "LUTValue"

Returns or sets the Value at entry LUTIndex of the LUT.
#define IC4_PROPID_LUT_VALUE_ALL   "LUTValueAll"

Accesses all the LUT coefficients in a single access without using individual LUTIndex.
#define IC4_PROPID_MULTI_FRAME_SET_OUTPUT_MODE_CUSTOM_GAIN   "MultiFrameSetOutputModeCustomGain"

Enables the sensor to use customizable gain values for the different frames of a frame set.
#define IC4_PROPID_MULTI_FRAME_SET_OUTPUT_MODE_ENABLE   "MultiFrameSetOutputModeEnable"

Enables the sensor to output a sequence of 2 or 4 frames with configurable exposure times and gain values.
#define IC4_PROPID_MULTI_FRAME_SET_OUTPUT_MODE_EXPOSURE_TIME0   "MultiFrameSetOutputModeExposureTime0"

Configures the exposure time for frame 0 of the frame set.
#define IC4_PROPID_MULTI_FRAME_SET_OUTPUT_MODE_EXPOSURE_TIME1   "MultiFrameSetOutputModeExposureTime1"

Configures the exposure time for frame 1 of the frame set.
#define IC4_PROPID_MULTI_FRAME_SET_OUTPUT_MODE_EXPOSURE_TIME2   "MultiFrameSetOutputModeExposureTime2"

Configures the exposure time for frame 2 of the frame set.
#define IC4_PROPID_MULTI_FRAME_SET_OUTPUT_MODE_EXPOSURE_TIME3   "MultiFrameSetOutputModeExposureTime3"

Configures the exposure time for frame 3 of the frame set.
#define IC4_PROPID_MULTI_FRAME_SET_OUTPUT_MODE_FRAME_COUNT   "MultiFrameSetOutputModeFrameCount"

Selects the number of frames in multi frame set output mode.
#define IC4_PROPID_MULTI_FRAME_SET_OUTPUT_MODE_GAIN0   "MultiFrameSetOutputModeGain0"

Configures the gain for frame 0 of the frame set.
#define IC4_PROPID_MULTI_FRAME_SET_OUTPUT_MODE_GAIN1   "MultiFrameSetOutputModeGain1"

Configures the gain for frame 1 of the frame set.
#define IC4_PROPID_MULTI_FRAME_SET_OUTPUT_MODE_GAIN2   "MultiFrameSetOutputModeGain2"

Configures the gain for frame 2 of the frame set.
#define IC4_PROPID_MULTI_FRAME_SET_OUTPUT_MODE_GAIN3   "MultiFrameSetOutputModeGain3"

Configures the gain for frame 3 of the frame set.
#define IC4_PROPID_OFFSET_AUTO_CENTER   "OffsetAutoCenter"

Automatically adjust the values of OffsetX and OffsetY to select the center region of the sensor.
#define IC4_PROPID_OFFSET_X   "OffsetX"

Horizontal offset from the origin to the region of interest (in pixels).
#define IC4_PROPID_OFFSET_Y   "OffsetY"

Vertical offset from the origin to the region of interest (in pixels).
#define IC4_PROPID_PAYLOAD_SIZE   "PayloadSize"

Provides the number of bytes transferred for each image or chunk on the stream channel.
#define IC4_PROPID_PIXEL_FORMAT   "PixelFormat"

Format of the pixels provided by the device.
#define IC4_PROPID_PTP_CLOCK_ACCURACY   "PtpClockAccuracy"

Indicates the expected accuracy of the device PTP clock when it is the grandmaster, or in the event it becomes the grandmaster.
#define IC4_PROPID_PTP_ENABLE   "PtpEnable"

Enables the Precision Time Protocol (PTP).
#define IC4_PROPID_PTP_STATUS   "PtpStatus"

Returns the current state of the PTP clock.
#define IC4_PROPID_REVERSE_X   "ReverseX"

Flip the image horizontally.
#define IC4_PROPID_REVERSE_Y   "ReverseY"

Flip the image vertically.
#define IC4_PROPID_SATURATION   "Saturation"

Color Saturation.
#define IC4_PROPID_SENSOR_HEIGHT   "SensorHeight"

Effective height of the sensor in pixels.
#define IC4_PROPID_SENSOR_PIXEL_HEIGHT   "SensorPixelHeight"

Physical size (pitch) in the y direction of a photo sensitive pixel unit.
#define IC4_PROPID_SENSOR_PIXEL_WIDTH   "SensorPixelWidth"

Physical size (pitch) in the x direction of a photo sensitive pixel unit.
#define IC4_PROPID_SENSOR_WIDTH   "SensorWidth"

Effective width of the sensor in pixels.
#define IC4_PROPID_SHARPNESS   "Sharpness"

Controls the strength of the sharpness algorithm.
#define IC4_PROPID_SIDEBAND_USE   "SidebandUse"

Enables Trigger/Strobe over USB-C Sideband Use Pins.
#define IC4_PROPID_SIGNAL_DETECTED   "SignalDetected"

Indicates whether a signal is detected form the HDMI source.
#define IC4_PROPID_SOFTWARE_TRANSFORM_ENABLE   "SoftwareTransformEnable"

Enables Software Transform properties.
#define IC4_PROPID_SOURCE_CONNECTED   "SourceConnected"

Indicates whether a HDMI source is connected.
#define IC4_PROPID_STROBE_DELAY   "StrobeDelay"

Configures the delay from start of exposure to the generated strobe pulse.
#define IC4_PROPID_STROBE_DURATION   "StrobeDuration"

If StrobeOperation is FixedDuration, specifies the pulse length.
#define IC4_PROPID_STROBE_ENABLE   "StrobeEnable"

Enable generation of exposure-synchronized output pulses.
#define IC4_PROPID_STROBE_OPERATION   "StrobeOperation"

Configures the mode of specifying the length of exposure-synchronized output pulses.
#define IC4_PROPID_STROBE_POLARITY   "StrobePolarity"

Select level of exposure-synchronized output pulses.
#define IC4_PROPID_TEST_EVENT_GENERATE   "TestEventGenerate"

Generates a Test event that can be used for testing event notification.
#define IC4_PROPID_TEST_PENDING_ACK   "TestPendingAck"

Tests the device's pending acknowledge feature.
#define IC4_PROPID_TIMESTAMP_LATCH   "TimestampLatch"

Latches the current timestamp counter into TimestampLatchValue.
#define IC4_PROPID_TIMESTAMP_LATCH_STRING   "TimestampLatchString"

Human-readable interpretation of the latched timestamp.
#define IC4_PROPID_TIMESTAMP_LATCH_VALUE   "TimestampLatchValue"

Returns the latched value of the timestamp counter.

#define IC4_PROPID_TIMESTAMP_RESET   "TimestampReset"

Resets the current value of the device timestamp counter.

#define IC4_PROPID_TL_PARAMS_LOCKED   "TLParamsLocked"

Used by the Transport Layer to prevent critical features from changing during acquisition.
#define IC4_PROPID_TONE_MAPPING_ENABLE   "ToneMappingEnable"

Enables tone mapping.

#define IC4_PROPID_TONE_MAPPING_GLOBAL_BRIGHTNESS   "ToneMappingGlobalBrightness"

Changes the brightness reference used for a individual pixel, which is interpolated between local and global.
#define IC4_PROPID_TONE_MAPPING_INTENSITY   "ToneMappingIntensity"

Adjusts the intensity of the tonemapping algorithm.
#define IC4_PROPID_TRIGGER_ACTIVATION   "TriggerActivation"

Specifies the activation mode of the trigger.

#define IC4_PROPID_TRIGGER_DEBOUNCER   "TriggerDebouncer"

Specifies the time for which trigger input has to be low in order accept the next trigger signal.
#define IC4_PROPID_TRIGGER_DELAY   "TriggerDelay"

Specifies the delay to apply after the trigger reception before activating it.

#define IC4_PROPID_TRIGGER_DENOISE   "TriggerDenoise"

Specifies the time for which trigger input has to be high in order to be accepted as a trigger signal.
#define IC4_PROPID_TRIGGER_MASK   "TriggerMask

Specifies the time for which trigger pulses are ignored after accepting a trigger signal.

#define IC4_PROPID_TRIGGER_MODE   "TriggerMode"

Controls if the selected trigger is active.
#define IC4_PROPID_TRIGGER_OPERATION   "TriggerOperation"

Controls the operation mode of the sensor in trigger mode.
#define IC4_PROPID_TRIGGER_OVERLAP   "TriggerOverlap"

Specifies the type trigger overlap permitted with the previous frame.
#define IC4_PROPID_TRIGGER_SELECTOR   "TriggerSelector"

Selects the type of trigger to configure.
#define IC4_PROPID_TRIGGER_SOFTWARE   "TriggerSoftware"

Generates an internal trigger.
#define IC4_PROPID_TRIGGER_SOURCE   "TriggerSource"

Specifies the internal signal or physical input Line to use as the trigger source.
#define IC4_PROPID_USER_SET_DEFAULT   "UserSetDefault"

Selects the feature User Set to load and make active by default when the device is reset.
#define IC4_PROPID_USER_SET_LOAD   "UserSetLoad"

Loads the User Set specified by UserSetSelector to the device and makes it active.
#define IC4_PROPID_USER_SET_SAVE   "UserSetSave"

Save the User Set specified by UserSetSelector to the non-volatile memory of the device.
#define IC4_PROPID_USER_SET_SELECTOR   "UserSetSelector"

Selects the feature User Set to load, save or configure.
#define IC4_PROPID_WIDTH   "Width"

Width of the image provided by the device (in pixels).
#define IC4_PROPID_WIDTH_MAX   "WidthMax"

Maximum width of the image (in pixels).
#define IC4_PROPID_ZOOM   "Zoom"

Changes the zoom setting of the lens.

Detailed Description

A lot of common property identifiers are described here.

Macro Definition Documentation

◆ IC4_PROPID_ACQUISITION_MODE

#define IC4_PROPID_ACQUISITION_MODE   "AcquisitionMode"

Sets the acquisition mode of the device.

It defines mainly the number of frames to capture during an acquisition and the way the acquisition stops.

◆ IC4_PROPID_ACQUISITION_START

#define IC4_PROPID_ACQUISITION_START   "AcquisitionStart"

Starts the Acquisition of the device.

The number of frames captured is specified by AcquisitionMode.

◆ IC4_PROPID_ACQUISITION_STOP

#define IC4_PROPID_ACQUISITION_STOP   "AcquisitionStop"

Stops the Acquisition of the device at the end of the current Frame.

It is mainly used when AcquisitionMode is Continuous but can be used in any acquisition mode.

◆ IC4_PROPID_ACTION_DEVICE_KEY

#define IC4_PROPID_ACTION_DEVICE_KEY   "ActionDeviceKey"

Provides the device key that allows the device to check the validity of action commands.

The device internal assertion of an action signal is only authorized if the ActionDeviceKey and the action device key value in the protocol message are equal.

◆ IC4_PROPID_ACTION_QUEUE_SIZE

#define IC4_PROPID_ACTION_QUEUE_SIZE   "ActionQueueSize"

Indicates the size of the scheduled action commands queue.

This number represents the maximum number of scheduled action commands that can be pending at a given point in time.

◆ IC4_PROPID_ACTION_SCHEDULER_INTERVAL

#define IC4_PROPID_ACTION_SCHEDULER_INTERVAL   "ActionSchedulerInterval"

Action repetition interval.

A value of 0 schedules the action to be executed only once.

◆ IC4_PROPID_BALANCE_RATIO

#define IC4_PROPID_BALANCE_RATIO   "BalanceRatio"

Controls ratio of the selected color component to a reference color component.

It is used for white balancing.

◆ IC4_PROPID_BALANCE_RATIO_SELECTOR

#define IC4_PROPID_BALANCE_RATIO_SELECTOR   "BalanceRatioSelector"

This enumeration selects a balance ratio control to configuration.

Once a balance ratio control has been selected, all changes to the balance ratio settings will be applied to the selected control.

◆ IC4_PROPID_BALANCE_WHITE_AUTO

#define IC4_PROPID_BALANCE_WHITE_AUTO   "BalanceWhiteAuto"

Controls the mode for automatic white balancing between the color channels.

The white balancing ratios are automatically adjusted.

◆ IC4_PROPID_BINNING_HORIZONTAL

#define IC4_PROPID_BINNING_HORIZONTAL   "BinningHorizontal"

Number of horizontal photo-sensitive cells to combine together.

This increases the intensity (or signal to noise ratio) of the pixels and reduces the horizontal resolution (width) of the image. A value of 1 indicates that no horizontal binning is performed by the camera.

◆ IC4_PROPID_BINNING_VERTICAL

#define IC4_PROPID_BINNING_VERTICAL   "BinningVertical"

Number of vertical photo-sensitive cells to combine together.

This increases the intensity (or signal to noise ratio) of the pixels and reduces the vertical resolution (height) of the image. A value of 1 indicates that no vertical binning is performed by the camera.

◆ IC4_PROPID_BLACK_LEVEL

#define IC4_PROPID_BLACK_LEVEL   "BlackLevel"

Controls the analog black level as an absolute physical value.

This represents a DC offset applied to the video signal

◆ IC4_PROPID_DECIMATION_HORIZONTAL

#define IC4_PROPID_DECIMATION_HORIZONTAL   "DecimationHorizontal"

Horizontal sub-sampling of the image.

This reduces the horizontal resolution (width) of the image by the specified horizontal decimation factor.

◆ IC4_PROPID_DECIMATION_VERTICAL

#define IC4_PROPID_DECIMATION_VERTICAL   "DecimationVertical"

Vertical sub-sampling of the image.

This reduces the vertical resolution (height) of the image by the specified vertical decimation factor.

◆ IC4_PROPID_DEVICE_FACTORY_RESET

#define IC4_PROPID_DEVICE_FACTORY_RESET   "DeviceFactoryReset"

Resets all user-programmable non-volatile memory to default.

After reset, the device must be rediscovered.

◆ IC4_PROPID_DEVICE_RESET

#define IC4_PROPID_DEVICE_RESET   "DeviceReset"

Resets the device to its power up state.

After reset, the device must be rediscovered.

◆ IC4_PROPID_DEVICE_SERIAL_NUMBER

#define IC4_PROPID_DEVICE_SERIAL_NUMBER   "DeviceSerialNumber"

Device's serial number.

This string is a unique identifier of the device.

◆ IC4_PROPID_DEVICE_TEMPERATURE

#define IC4_PROPID_DEVICE_TEMPERATURE   "DeviceTemperature"

Device temperature in degrees Celsius (°C).

It is measured at the location selected by DeviceTemperatureSelector.

◆ IC4_PROPID_EVENT_EXPOSURE_END

#define IC4_PROPID_EVENT_EXPOSURE_END   "EventExposureEnd"

Unique identifier of the Exposure End event.

Use this parameter to get notified when the event occurs.

◆ IC4_PROPID_EVENT_FOCUS_MOVE_COMPLETED

#define IC4_PROPID_EVENT_FOCUS_MOVE_COMPLETED   "EventFocusMoveCompleted"

Unique identifier of the Focus Move Completed event.

Use this parameter to get notified when the event occurs.

◆ IC4_PROPID_EVENT_FRAME_TRIGGER_MISSED

#define IC4_PROPID_EVENT_FRAME_TRIGGER_MISSED   "EventFrameTriggerMissed"

Unique identifier of the Frame Trigger Missed event.

Use this parameter to get notified when the event occurs.

◆ IC4_PROPID_EVENT_LINE1_FALLING_EDGE

#define IC4_PROPID_EVENT_LINE1_FALLING_EDGE   "EventLine1FallingEdge"

Unique identifier of the Line1 Falling Edge event.

Use this parameter to get notified when the event occurs.

◆ IC4_PROPID_EVENT_LINE1_RISING_EDGE

#define IC4_PROPID_EVENT_LINE1_RISING_EDGE   "EventLine1RisingEdge"

Unique identifier of the Line1 Rising Edge event.

Use this parameter to get notified when the event occurs.

◆ IC4_PROPID_EVENT_NOTIFICATION

#define IC4_PROPID_EVENT_NOTIFICATION   "EventNotification"

Enables event notifications for the currently selected event.

The event can selected using the Event Selector parameter.

◆ IC4_PROPID_EVENT_SELECTOR

#define IC4_PROPID_EVENT_SELECTOR   "EventSelector"

Sets the event notification to be enabled.

The notification can be enabled using the Event Notification parameter.

◆ IC4_PROPID_EVENT_TEST

#define IC4_PROPID_EVENT_TEST   "EventTest"

Unique identifier of the Test event.

Use this parameter to get notified when the event occurs.

◆ IC4_PROPID_EVENT_ZOOM_MOVE_COMPLETED

#define IC4_PROPID_EVENT_ZOOM_MOVE_COMPLETED   "EventZoomMoveCompleted"

Unique identifier of the Zoom Move Completed event.

Use this parameter to get notified when the event occurs.

◆ IC4_PROPID_EXPOSURE_TIME

#define IC4_PROPID_EXPOSURE_TIME   "ExposureTime"

Sets the Exposure time when ExposureMode is Timed and ExposureAuto is Off.

This controls the duration where the photosensitive cells are exposed to light.

◆ IC4_PROPID_FILE_OPERATION_RESULT

#define IC4_PROPID_FILE_OPERATION_RESULT   "FileOperationResult"

Represents the file operation result.

For Read or Write operations, the number of successfully read/written bytes is returned.

◆ IC4_PROPID_FILE_OPERATION_SELECTOR

#define IC4_PROPID_FILE_OPERATION_SELECTOR   "FileOperationSelector"

Selects the target operation for the selected file in the device.

This Operation is executed when the FileOperationExecute feature is called.

◆ IC4_PROPID_GAIN

#define IC4_PROPID_GAIN   "Gain"

Controls the gain as an absolute physical value.

This is an amplification factor applied to he video signal.

◆ IC4_PROPID_GAMMA

#define IC4_PROPID_GAMMA   "Gamma"

Controls the gamma correction of pixel intensity.

This is typically used to compensate for nonlinearity of the display system (such as CRT).

◆ IC4_PROPID_GEV_SCPS_DO_NOT_FRAGMENT

#define IC4_PROPID_GEV_SCPS_DO_NOT_FRAGMENT   "GevSCPSDoNotFragment"

The state of this feature is copied into the "do not fragment" bit of IP header of each stream packet.

It can be used by the application to prevent IP fragmentation of packets on the stream channel.

◆ IC4_PROPID_GEV_SCPS_PACKET_SIZE

#define IC4_PROPID_GEV_SCPS_PACKET_SIZE   "GevSCPSPacketSize"

This GigE Vision specific feature corresponds to DeviceStreamChannelPacketSize and should be kept in sync with it.

It specifies the stream packet size, in bytes, to send on the selected channel for a GVSP transmitter or specifies the maximum packet size supported by a GVSP receiver.

◆ IC4_PROPID_HEIGHT_MAX

#define IC4_PROPID_HEIGHT_MAX   "HeightMax"

Maximum height of the image (in pixels).

This dimension is calculated after vertical binning, decimation or any other function changing the vertical dimension of the image.

◆ IC4_PROPID_IMX174_HARDWARE_WDR_ENABLE

#define IC4_PROPID_IMX174_HARDWARE_WDR_ENABLE   "IMX174HardwareWDREnable"

Enable IMX174 WDR mode.

This mode enables setting a second, longer exposure time (IMX174 WDR Shutter 2), which is used for every other frame.

◆ IC4_PROPID_IMX174_HARDWARE_WDR_SHUTTER_MODE

#define IC4_PROPID_IMX174_HARDWARE_WDR_SHUTTER_MODE   "IMX174HardwareWDRShutterMode"

Select the IMX174 WDR shutter mode.

This mode decides whether the second shutter time can be choosen freely, or is fixed at a multiple of the configured ExposureTime.

◆ IC4_PROPID_IMX_LOW_LATENCY_TRIGGER_MODE

#define IC4_PROPID_IMX_LOW_LATENCY_TRIGGER_MODE   "IMXLowLatencyTriggerMode"

Enables the low-latency mode for IMX global shutter sensors.

This mode reduces the jitter between trigger input and exposure start, but disallows trigger overlap.

◆ IC4_PROPID_PAYLOAD_SIZE

#define IC4_PROPID_PAYLOAD_SIZE   "PayloadSize"

Provides the number of bytes transferred for each image or chunk on the stream channel.

This includes any end-of-line, end-of-frame statistics or other stamp data. This is the total size of data payload for a data block.

◆ IC4_PROPID_SOFTWARE_TRANSFORM_ENABLE

#define IC4_PROPID_SOFTWARE_TRANSFORM_ENABLE   "SoftwareTransformEnable"

Enables Software Transform properties.

If enabled, properties like Sharpness, Tone Mapping etc. can be enabled and lead to a software transformation in the driver.

◆ IC4_PROPID_TIMESTAMP_LATCH_VALUE

#define IC4_PROPID_TIMESTAMP_LATCH_VALUE   "TimestampLatchValue"

Returns the latched value of the timestamp counter.

The timestamp must first be latched by using the Timestamp Control Latch command.

◆ IC4_PROPID_TIMESTAMP_RESET

#define IC4_PROPID_TIMESTAMP_RESET   "TimestampReset"

Resets the current value of the device timestamp counter.

After executing this command, the timestamp counter restarts automatically.

◆ IC4_PROPID_TRIGGER_OVERLAP

#define IC4_PROPID_TRIGGER_OVERLAP   "TriggerOverlap"

Specifies the type trigger overlap permitted with the previous frame.

This defines when a valid trigger will be accepted for a new frame.

◆ IC4_PROPID_TRIGGER_SOFTWARE

#define IC4_PROPID_TRIGGER_SOFTWARE   "TriggerSoftware"

Generates an internal trigger.

TriggerSource must be set to Software or Any.

◆ IC4_PROPID_WIDTH_MAX

#define IC4_PROPID_WIDTH_MAX   "WidthMax"

Maximum width of the image (in pixels).

The dimension is calculated after horizontal binning, decimation or any other function changing the horizontal dimension of the image.