ic4::PropId Namespace Reference

Contains definitions for common device property identifiers. More...

Classes

struct   PropIdBoolean

Typed property identifier for boolean properties. More...
struct   PropIdCommand

Typed property identifier for command properties. More...
struct   PropIdEnumeration

Typed property identifier for enumeration properties. More...
struct   PropIdFloat

Typed property identifier for float properties. More...
struct   PropIdInteger

Typed property identifier for integer properties. More...
struct   PropIdRegister

Typed property identifier for register properties. More...
struct   PropIdString

Typed property identifier for string properties. More...

Variables

constexpr PropIdInteger  AcquisitionBurstFrameCount = { "AcquisitionBurstFrameCount" }

Number of frames to acquire for each trigger.

constexpr PropIdInteger  AcquisitionBurstInterval = { "AcquisitionBurstInterval" }

Minimum interval between frames in an acquisition burst.
constexpr PropIdFloat AcquisitionFrameRate = { "AcquisitionFrameRate" }

Controls the acquisition rate at which the frames are captured.
constexpr PropIdEnumeration AcquisitionMode = { "AcquisitionMode" }

Sets the acquisition mode of the device.
constexpr PropIdCommand  AcquisitionStart = { "AcquisitionStart" }

Starts the Acquisition of the device.
constexpr PropIdCommand  AcquisitionStop = { "AcquisitionStop" }

Stops the Acquisition of the device at the end of the current Frame.
constexpr PropIdInteger  ActionDeviceKey = { "ActionDeviceKey" }

Provides the device key that allows the device to check the validity of action commands.
constexpr PropIdInteger  ActionGroupKey = { "ActionGroupKey" }

Provides the key that the device will use to validate the action on reception of the action protocol message.
constexpr PropIdInteger  ActionGroupMask = { "ActionGroupMask" }

Provides the mask that the device will use to validate the action on reception of the action protocol message.
constexpr PropIdInteger  ActionQueueSize = { "ActionQueueSize" }

Indicates the size of the scheduled action commands queue.
constexpr PropIdCommand  ActionSchedulerCancel = { "ActionSchedulerCancel" }

Cancels all scheduled actions.
constexpr PropIdCommand  ActionSchedulerCommit = { "ActionSchedulerCommit" }

Schedules the action to be executed time specified by ActionSchedulerTime, with optional repetition in intervals of ActionSchedulerInterval.
constexpr PropIdInteger  ActionSchedulerInterval = { "ActionSchedulerInterval" }

Action repetition interval.
constexpr PropIdEnumeration  ActionSchedulerStatus = { "ActionSchedulerStatus" }

Indicates whether there are actions scheduled.
constexpr PropIdInteger  ActionSchedulerTime = { "ActionSchedulerTime" }

Camera time for when the action is to be scheduled.
constexpr PropIdInteger  ActionSelector = { "ActionSelector" }

Selects to which Action Signal further Action settings apply.
constexpr PropIdBoolean  AutoFocusROIEnable = { "AutoFocusROIEnable" }

Enable the region of interest for auto focus.
constexpr PropIdInteger  AutoFocusROIHeight = { "AutoFocusROIHeight" }

Vertical size of the auto focus region of interest.
constexpr PropIdInteger AutoFocusROILeft = { "AutoFocusROILeft" }

Horizontal offset of the auto focus region of interest.
constexpr PropIdInteger AutoFocusROITop = { "AutoFocusROITop" }

Vertical offset of the auto focus region of interest.
constexpr PropIdInteger AutoFocusROIWidth = { "AutoFocusROIWidth" }

Horizontal size of the auto focus region of interest.
constexpr PropIdBoolean  AutoFunctionsROIEnable = { "AutoFunctionsROIEnable" }

Enable the region of interest for auto functions.
constexpr PropIdInteger  AutoFunctionsROIHeight = { "AutoFunctionsROIHeight" }

Vertical size of the auto functions region of interest.
constexpr PropIdInteger  AutoFunctionsROILeft = { "AutoFunctionsROILeft" }

Horizontal offset of the auto functions region of interest.
constexpr PropIdEnumeration AutoFunctionsROIPreset = { "AutoFunctionsROIPreset" }

Select a predefined region of interest for auto functions.
constexpr PropIdInteger AutoFunctionsROITop = { "AutoFunctionsROITop" }

Vertical offset of the auto functions region of interest.
constexpr PropIdInteger AutoFunctionsROIWidth = { "AutoFunctionsROIWidth" }

Horizontal size of the auto functions region of interest.
constexpr PropIdFloat  BalanceRatio = { "BalanceRatio" }

Controls ratio of the selected color component to a reference color component.
constexpr PropIdEnumeration  BalanceRatioSelector = { "BalanceRatioSelector" }

This enumeration selects a balance ratio control to configuration.
constexpr PropIdEnumeration  BalanceWhiteAuto = { "BalanceWhiteAuto" }

Controls the mode for automatic white balancing between the color channels.
constexpr PropIdEnumeration  BalanceWhiteAutoPreset = { "BalanceWhiteAutoPreset" }

Selects a specific preset for automatic white balance.
constexpr PropIdEnumeration  BalanceWhiteMode = { "BalanceWhiteMode" }

Configures the way auto white balance works.
constexpr PropIdInteger  BalanceWhiteTemperature = { "BalanceWhiteTemperature" }

Adjusts the white balance controls to match the ambient light temperature.
constexpr PropIdEnumeration  BalanceWhiteTemperaturePreset = { "BalanceWhiteTemperaturePreset" }

Selects a specific white balance preset.
constexpr PropIdInteger BinningHorizontal = { "BinningHorizontal" }

Number of horizontal photo-sensitive cells to combine together.
constexpr PropIdInteger BinningVertical = { "BinningVertical" }

Number of vertical photo-sensitive cells to combine together.
constexpr PropIdFloat BlackLevel = { "BlackLevel" }

Controls the analog black level as an absolute physical value.
constexpr PropIdRegister ChunkBlockId = { "ChunkBlockId" }

Returns the block ID (frame number) of the image.
constexpr PropIdBoolean ChunkEnable = { "ChunkEnable" }

Enables the inclusion of the selected Chunk data in the payload of the image.
constexpr PropIdFloat ChunkExposureTime = { "ChunkExposureTime" }

Returns the exposure time used to capture the image.
constexpr PropIdFloat ChunkGain = { "ChunkGain" }

Returns the gain used to capture the image.
constexpr PropIdRegister  ChunkImage = { "ChunkImage" }

Returns the entire image data included in the payload.
constexpr PropIdInteger  ChunkIMX174FrameId = { "ChunkIMX174FrameId" }

IMX174 double exposure frame id.
constexpr PropIdInteger  ChunkIMX174FrameSet = { "ChunkIMX174FrameSet" }

IMX174 double exposure frame set identifier.
constexpr PropIdBoolean  ChunkModeActive = { "ChunkModeActive" }

Activates the inclusion of Chunk data in the payload of the image.
constexpr PropIdInteger  ChunkMultiFrameSetFrameId = { "ChunkMultiFrameSetFrameId" }

Returns the frame id in the frame set in Multi Frame Set Output Mode.
constexpr PropIdInteger  ChunkMultiFrameSetId = { "ChunkMultiFrameSetId" }

Returns the id of the frame set in Multi Frame Set Output Mode.
constexpr PropIdEnumeration  ChunkSelector = { "ChunkSelector" }

Selects which Chunk to enable or control.
constexpr PropIdBoolean  ColorTransformationEnable = { "ColorTransformationEnable" }

Activates the selected Color Transformation module.
constexpr PropIdEnumeration  ColorTransformationSelector = { "ColorTransformationSelector" }

Selects which Color Transformation module is controlled by the various Color Transformation features.
constexpr PropIdFloat  ColorTransformationValue = { "ColorTransformationValue" }

Represents the value of the selected Gain factor or Offset inside the Transformation matrix.
constexpr PropIdEnumeration  ColorTransformationValueSelector = { "ColorTransformationValueSelector" }

Selects the Gain factor or Offset of the Transformation matrix to access in the selected Color Transformation module.
constexpr PropIdInteger  Contrast = { "Contrast" }

Controls Contrast.
constexpr PropIdInteger  DecimationHorizontal = { "DecimationHorizontal" }

Horizontal sub-sampling of the image.
constexpr PropIdInteger  DecimationVertical = { "DecimationVertical" }

Vertical sub-sampling of the image.
constexpr PropIdInteger  Denoise = { "Denoise" }

Controls the strength of the denoise algorithm.
constexpr PropIdInteger  DeviceEventChannelCount = { "DeviceEventChannelCount" }

Indicates the number of event channels supported by the device.
constexpr PropIdCommand  DeviceFactoryReset = { "DeviceFactoryReset" }

Resets all user-programmable non-volatile memory to default.
constexpr PropIdString  DeviceFirmwareVersion = { "DeviceFirmwareVersion" }

Version of the device.
constexpr PropIdFloat  DeviceLinkHeartbeatTimeout = { "DeviceLinkHeartbeatTimeout" }

Controls the current heartbeat timeout of the specific Link.
constexpr PropIdInteger  DeviceLinkSelector = { "DeviceLinkSelector" }

Selects which Link of the device to control.
constexpr PropIdString  DeviceModelName = { "DeviceModelName" }

Model of the device.
constexpr PropIdCommand  DeviceReset = { "DeviceReset" }

Resets the device to its power up state.
constexpr PropIdEnumeration  DeviceScanType = { "DeviceScanType" }

Returns the scan type of the sensor of the device.
constexpr PropIdString  DeviceSerialNumber = { "DeviceSerialNumber" }

Device's serial number.
constexpr PropIdInteger  DeviceSFNCVersionMajor = { "DeviceSFNCVersionMajor" }

Major version of the Standard Features Naming Convention that was used to create the device's GenICam XML.
constexpr PropIdInteger  DeviceSFNCVersionMinor = { "DeviceSFNCVersionMinor" }

Minor version of the Standard Features Naming Convention that was used to create the device's GenICam XML.
constexpr PropIdInteger  DeviceSFNCVersionSubMinor = { "DeviceSFNCVersionSubMinor" }

Sub minor version of the Standard Features Naming Convention that was used to create the device's GenICam XML.
constexpr PropIdInteger  DeviceStreamChannelCount = { "DeviceStreamChannelCount" }

Indicates the number of streaming channels supported by the device.
constexpr PropIdEnumeration  DeviceStreamChannelEndianness = { "DeviceStreamChannelEndianness" }

Endianess of multi-byte pixel data for this stream.
constexpr PropIdInteger DeviceStreamChannelLink = { "DeviceStreamChannelLink" }

Index of device`s Link to use for streaming the specifed stream channel.
constexpr PropIdInteger DeviceStreamChannelPacketSize = { "DeviceStreamChannelPacketSize" }

Specifies the stream packet size, in bytes, to send on the selected channel.
constexpr PropIdInteger  DeviceStreamChannelSelector = { "DeviceStreamChannelSelector" }

Selects the stream channel to control.
constexpr PropIdEnumeration DeviceStreamChannelType = { "DeviceStreamChannelType" }

Reports the type of the stream channel.
constexpr PropIdFloat  DeviceTemperature = { "DeviceTemperature" }

Device temperature in degrees Celsius (°C).
constexpr PropIdEnumeration  DeviceTemperatureSelector = { "DeviceTemperatureSelector" }

Selects the location within the device, where the temperature will be measured.
constexpr PropIdEnumeration  DeviceTLType = { "DeviceTLType" }

Transport Layer type of the device.
constexpr PropIdInteger  DeviceTLVersionMajor = { "DeviceTLVersionMajor" }

Major version of the Transport Layer of the device.
constexpr PropIdInteger  DeviceTLVersionMinor = { "DeviceTLVersionMinor" }

Minor version of the Transport Layer of the device.
constexpr PropIdInteger  DeviceTLVersionSubMinor = { "DeviceTLVersionSubMinor" }

Sub minor version of the Transport Layer of the device.
constexpr PropIdEnumeration DeviceType = { "DeviceType" }

Returns the device type.
constexpr PropIdString  DeviceUserID = { "DeviceUserID" }

User-programmable device identifier.
constexpr PropIdString  DeviceVendorName = { "DeviceVendorName" }

Name of the manufacturer of the device.
constexpr PropIdString  DeviceVersion = { "DeviceVersion" }

Version of the device.
constexpr PropIdBoolean  DisableInfoOverlay = { "DisableInfoOverlay" }

Disables the HDMI format info overlay.
constexpr PropIdInteger  EventExposureEnd = { "EventExposureEnd" }

Unique identifier of the Exposure End event.
constexpr PropIdInteger  EventExposureEndFrameID = { "EventExposureEndFrameID" }

Frame ID of the Exposure End event.
constexpr PropIdInteger  EventExposureEndTimestamp = { "EventExposureEndTimestamp" }

Timestamp of the Exposure End event.
constexpr PropIdInteger  EventFocusMoveCompleted = { "EventFocusMoveCompleted" }

Unique identifier of the Focus Move Completed event.
constexpr PropIdInteger  EventFocusMoveCompletedFocus = { "EventFocusMoveCompletedFocus" }

Focus value of the Focus Move Completed event.
constexpr PropIdInteger  EventFocusMoveCompletedTimestamp = { "EventFocusMoveCompletedTimestamp" }

Timestamp of the Focus Move Completed event.
constexpr PropIdInteger  EventFrameTriggerMissed = { "EventFrameTriggerMissed" }

Unique identifier of the Frame Trigger Missed event.
constexpr PropIdInteger  EventFrameTriggerMissedTimestamp = { "EventFrameTriggerMissedTimestamp" }

Timestamp of the Frame Trigger Missed event.
constexpr PropIdInteger  EventLine1FallingEdge = { "EventLine1FallingEdge" }

Unique identifier of the Line1 Falling Edge event.
constexpr PropIdInteger  EventLine1FallingEdgeTimestamp = { "EventLine1FallingEdgeTimestamp" }

Timestamp of the Line1 Falling Edge event.
constexpr PropIdInteger  EventLine1RisingEdge = { "EventLine1RisingEdge" }

Unique identifier of the Line1 Rising Edge event.
constexpr PropIdInteger  EventLine1RisingEdgeTimestamp = { "EventLine1RisingEdgeTimestamp" }

Timestamp of the Line1 Rising Edge event.
constexpr PropIdEnumeration  EventNotification = { "EventNotification" }

Enables event notifications for the currently selected event.
constexpr PropIdEnumeration  EventSelector = { "EventSelector" }

Sets the event notification to be enabled.
constexpr PropIdInteger  EventTest = { "EventTest" }

Unique identifier of the Test event.
constexpr PropIdInteger  EventTestTimestamp = { "EventTestTimestamp" }

Timestamp of the test event.
constexpr PropIdInteger  EventZoomMoveCompleted = { "EventZoomMoveCompleted" }

Unique identifier of the Zoom Move Completed event.
constexpr PropIdInteger  EventZoomMoveCompletedTimestamp = { "EventZoomMoveCompletedTimestamp" }

Timestamp of the Zoom Move Completed event.
constexpr PropIdInteger EventZoomMoveCompletedZoom = { "EventZoomMoveCompletedZoom" }

Zoom value of the Zoom Move Completed event.
constexpr PropIdBoolean  ExpandOutputRange = { "ExpandOutputRange" }

Use the full brightness range when receiving YUV data via HDMI.
constexpr PropIdEnumeration  ExposureAuto = { "ExposureAuto" }

Sets the automatic exposure mode when ExposureMode is Timed.
constexpr PropIdBoolean  ExposureAutoHighlighReduction = { "ExposureAutoHighlighReduction" }

Lets the ExposureAuto/GainAuto algorithm try to avoid over-exposures.
constexpr PropIdBoolean  ExposureAutoHighlightReduction = { "ExposureAutoHighlightReduction" }

Lets the ExposureAuto/GainAuto algorithm try to avoid over-exposures.
constexpr PropIdFloat  ExposureAutoLowerLimit = { "ExposureAutoLowerLimit" }

Lower limit of the ExposureAuto function.
constexpr PropIdInteger  ExposureAutoReference = { "ExposureAutoReference" }

Configures the target image brightness of the ExposureAuto/GainAuto algorithm.
constexpr PropIdFloat ExposureAutoUpperLimit = { "ExposureAutoUpperLimit" }

Upper limit of the ExposureAuto function.
constexpr PropIdBoolean  ExposureAutoUpperLimitAuto = { "ExposureAutoUpperLimitAuto" }

Automatically sets the upper limit to match the Acquisition Frame Rate.
constexpr PropIdFloat  ExposureTime = { "ExposureTime" }

Sets the Exposure time when ExposureMode is Timed and ExposureAuto is Off.
constexpr PropIdRegister  FileAccessBuffer = { "FileAccessBuffer" }

Defines the intermediate access buffer that allows the exchange of data between the device file storage and the application.
constexpr PropIdInteger  FileAccessLength = { "FileAccessLength" }

Controls the Length of the mapping between the device file storage and the FileAccessBuffer.
constexpr PropIdInteger  FileAccessOffset = { "FileAccessOffset" }

Controls the Offset of the mapping between the device file storage and the FileAccessBuffer.
constexpr PropIdEnumeration  FileOpenMode = { "FileOpenMode" }

Selects the access mode in which a file is opened in the device.
constexpr PropIdCommand  FileOperationExecute = { "FileOperationExecute" }

Executes the operation selected by FileOperationSelector on the selected file.
constexpr PropIdInteger  FileOperationResult = { "FileOperationResult" }

Represents the file operation result.
constexpr PropIdEnumeration  FileOperationSelector = { "FileOperationSelector" }

Selects the target operation for the selected file in the device.
constexpr PropIdEnumeration  FileOperationStatus = { "FileOperationStatus" }

Represents the file operation execution status.
constexpr PropIdEnumeration  FileSelector = { "FileSelector" }

Selects the target file in the device.
constexpr PropIdInteger  FileSize = { "FileSize" }

Represents the size of the selected file in bytes.
constexpr PropIdInteger  Focus = { "Focus" }

Changes the Focus setting of the lens.
constexpr PropIdCommand  FocusAuto = { "FocusAuto" }

Enables automatic Focus control.
constexpr PropIdFloat  Gain = { "Gain" }

Controls the gain as an absolute physical value.
constexpr PropIdEnumeration  GainAuto = { "GainAuto" }

Sets the automatic gain control mode.
constexpr PropIdFloat  GainAutoLowerLimit = { "GainAutoLowerLimit" }

Lower limit of the GainAuto function.
constexpr PropIdFloat  GainAutoUpperLimit = { "GainAutoUpperLimit" }

Upper limit of the GainAuto function.
constexpr PropIdEnumeration  GainMode = { "GainMode" }

Configures the sensor-specific Gain (LCG/HCG) setting.
constexpr PropIdFloat  Gamma = { "Gamma" }

Controls the gamma correction of pixel intensity.
constexpr PropIdEnumeration  GevGVSPExtendedIDMode = { "GevGVSPExtendedIDMode" }

Enables the extended IDs mode.
constexpr PropIdBoolean  GevSCPSDoNotFragment = { "GevSCPSDoNotFragment" }

The state of this feature is copied into the "do not fragment" bit of IP header of each stream packet.
constexpr PropIdInteger  GevSCPSPacketSize = { "GevSCPSPacketSize" }

This GigE Vision specific feature corresponds to DeviceStreamChannelPacketSize and should be kept in sync with it.
constexpr PropIdInteger  GPIn = { "GPIn" }

Status of the digital input pin.
constexpr PropIdInteger  GPOut = { "GPOut" }

Status of the digital output pin.
constexpr PropIdInteger  Height = { "Height" }

Height of the image provided by the device (in pixels).
constexpr PropIdInteger  HeightMax = { "HeightMax" }

Maximum height of the image (in pixels).
constexpr PropIdFloat  Hue = { "Hue" }

Color Hue.
constexpr PropIdBoolean IMX174HardwareWDREnable = { "IMX174HardwareWDREnable" }

Enable IMX174 WDR mode.
constexpr PropIdEnumeration IMX174HardwareWDRShutterMode = { "IMX174HardwareWDRShutterMode" }

Select the IMX174 WDR shutter mode.
constexpr PropIdFloat  IMX174WDRShutter2 = { "IMX174WDRShutter2" }

Exposure time that is used for every other frame, if IMX174 WDR mode is enabled.
constexpr PropIdBoolean  IMXLowLatencyTriggerMode = { "IMXLowLatencyTriggerMode" }

Enables the low-latency mode for IMX global shutter sensors.
constexpr PropIdInteger  InputBits = { "InputBits" }

The detected bits per pixel of the HDMI source.
constexpr PropIdInteger InputFp1ks = { "InputFp1ks" }

The detected frame rate of the HDMI source.
constexpr PropIdInteger InputHeight = { "InputHeight" }

The detected width of the HDMI input image.
constexpr PropIdInteger InputWidth = { "InputWidth" }

The detected width of the HDMI input image.
constexpr PropIdBoolean IRCutFilterEnable = { "IRCutFilterEnable" }

Enables the IRCutFilter in from of the sensor.
constexpr PropIdInteger Iris = { "Iris" }

Changes the Iris setting of the lens.
constexpr PropIdBoolean IrisAuto = { "IrisAuto" }

Enables automatic Iris control.
constexpr PropIdBoolean LUTEnable = { "LUTEnable" }

Activates the LUT.
constexpr PropIdInteger LUTIndex = { "LUTIndex" }

Control the index (offset) of the coefficient to access in the LUT.
constexpr PropIdEnumeration LUTSelector = { "LUTSelector" }

Selects which LUT to control.
constexpr PropIdInteger  LUTValue = { "LUTValue" }

Returns or sets the Value at entry LUTIndex of the LUT.
constexpr PropIdRegister  LUTValueAll = { "LUTValueAll" }

Accesses all the LUT coefficients in a single access without using individual LUTIndex.
constexpr PropIdBoolean  MultiFrameSetOutputModeCustomGain = { "MultiFrameSetOutputModeCustomGain" }

Enables the sensor to use customizable gain values for the different frames of a frame set.
constexpr PropIdBoolean  MultiFrameSetOutputModeEnable = { "MultiFrameSetOutputModeEnable" }

Enables the sensor to output a sequence of 2 or 4 frames with configurable exposure times and gain values.
constexpr PropIdFloat  MultiFrameSetOutputModeExposureTime0 = { "MultiFrameSetOutputModeExposureTime0" }

Configures the exposure time for frame 0 of the frame set.
constexpr PropIdFloat  MultiFrameSetOutputModeExposureTime1 = { "MultiFrameSetOutputModeExposureTime1" }

Configures the exposure time for frame 1 of the frame set.
constexpr PropIdFloat  MultiFrameSetOutputModeExposureTime2 = { "MultiFrameSetOutputModeExposureTime2" }

Configures the exposure time for frame 2 of the frame set.
constexpr PropIdFloat  MultiFrameSetOutputModeExposureTime3 = { "MultiFrameSetOutputModeExposureTime3" }

Configures the exposure time for frame 3 of the frame set.
constexpr PropIdEnumeration  MultiFrameSetOutputModeFrameCount = { "MultiFrameSetOutputModeFrameCount" }

Selects the number of frames in multi frame set output mode.
constexpr PropIdFloat  MultiFrameSetOutputModeGain0 = { "MultiFrameSetOutputModeGain0" }

Configures the gain for frame 0 of the frame set.
constexpr PropIdFloat  MultiFrameSetOutputModeGain1 = { "MultiFrameSetOutputModeGain1" }

Configures the gain for frame 1 of the frame set.
constexpr PropIdFloat  MultiFrameSetOutputModeGain2 = { "MultiFrameSetOutputModeGain2" }

Configures the gain for frame 2 of the frame set.
constexpr constexpr PropIdFloat  MultiFrameSetOutputModeGain3 = { "MultiFrameSetOutputModeGain3" }

Configures the gain for frame 3 of the frame set.
constexpr constexpr PropIdEnumeration  OffsetAutoCenter = { "OffsetAutoCenter" }

Automatically adjust the values of OffsetX and OffsetY to select the center region of the sensor.
constexpr constexpr PropIdInteger  OffsetX = { "OffsetX" }

Horizontal offset from the origin to the region of interest (in pixels).
constexpr constexpr PropIdInteger  OffsetY = { "OffsetY" }

Vertical offset from the origin to the region of interest (in pixels).
constexpr constexpr PropIdInteger  PayloadSize = { "PayloadSize" }

Provides the number of bytes transferred for each image or chunk on the stream channel.
constexpr constexpr PropIdEnumeration  PixelFormat = { "PixelFormat" }

Format of the pixels provided by the device.
constexpr constexpr PropIdEnumeration  PtpClockAccuracy = { "PtpClockAccuracy" }

Indicates the expected accuracy of the device PTP clock when it is the grandmaster, or in the event it becomes the grandmaster.
constexpr constexpr PropIdBoolean  PtpEnable = { "PtpEnable" }

Enables the Precision Time Protocol (PTP).
constexpr constexpr PropIdEnumeration  PtpStatus = { "PtpStatus" }

Returns the current state of the PTP clock.
constexpr constexpr PropIdBoolean  ReverseX = { "ReverseX" }

Flip the image horizontally.
constexpr constexpr PropIdBoolean  ReverseY = { "ReverseY" }

Flip the image vertically.
constexpr constexpr PropIdFloat  Saturation = { "Saturation" }

Color Saturation.
constexpr constexpr PropIdInteger  SensorHeight = { "SensorHeight" }

Effective height of the sensor in pixels.
constexprPropIdFloat  SensorPixelHeight = { "SensorPixelHeight" }

Physical size (pitch) in the y direction of a photo sensitive pixel unit.
constexpr PropIdFloat  SensorPixelWidth = { "SensorPixelWidth" }

Physical size (pitch) in the x direction of a photo sensitive pixel unit.
constexpr PropIdInteger  SensorWidth = { "SensorWidth" }

Effective width of the sensor in pixels.
constexpr PropIdInteger  Sharpness = { "Sharpness" }

Controls the strength of the sharpness algorithm.
constexpr PropIdBoolean  SidebandUse = { "SidebandUse" }

Enables Trigger/Strobe over USB-C Sideband Use Pins.
constexpr PropIdBoolean  SignalDetected = { "SignalDetected" }

Indicates whether a signal is detected form the HDMI source.
constexpr PropIdBoolean  SoftwareTransformEnable = { "SoftwareTransformEnable" }

Enables Software Transform properties.
constexpr PropIdBoolean  SourceConnected = { "SourceConnected" }

Indicates whether a HDMI source is connected.
constexpr PropIdInteger  StrobeDelay = { "StrobeDelay" }

Configures the delay from start of exposure to the generated strobe pulse.
constexpr PropIdInteger  StrobeDuration = { "StrobeDuration" }

If StrobeOperation is FixedDuration, specifies the pulse length.
constexpr PropIdEnumeration  StrobeEnable = { "StrobeEnable" }

Enable generation of exposure-synchronized output pulses.
constexpr PropIdEnumeration  StrobeOperation = { "StrobeOperation" }

Configures the mode of specifying the length of exposure-synchronized output pulses.
constexpr PropIdEnumeration  StrobePolarity = { "StrobePolarity" }

Select level of exposure-synchronized output pulses.
constexpr PropIdCommand  TestEventGenerate = { "TestEventGenerate" }

Generates a Test event that can be used for testing event notification.
constexpr PropIdInteger  TestPendingAck = { "TestPendingAck" }

Tests the device's pending acknowledge feature.
constexpr PropIdCommand  TimestampLatch = { "TimestampLatch" }

Latches the current timestamp counter into TimestampLatchValue.
constexpr PropIdString  TimestampLatchString = { "TimestampLatchString" }

Human-readable interpretation of the latched timestamp.
constexpr PropIdInteger  TimestampLatchValue = { "TimestampLatchValue" }

Returns the latched value of the timestamp counter.
constexpr PropIdCommand TimestampReset = { "TimestampReset" }

Resets the current value of the device timestamp counter.
constexpr PropIdInteger TLParamsLocked = { "TLParamsLocked" }

Used by the Transport Layer to prevent critical features from changing during acquisition.
constexpr PropIdBoolean ToneMappingEnable = { "ToneMappingEnable" }

Enables tone mapping.
constexpr PropIdFloat ToneMappingGlobalBrightness = { "ToneMappingGlobalBrightness" }

Changes the brightness reference used for a individual pixel, which is interpolated between local and global.
constexpr PropIdFloat ToneMappingIntensity = { "ToneMappingIntensity" }

Adjusts the intensity of the tonemapping algorithm.
constexpr PropIdEnumeration TriggerActivation = { "TriggerActivation" }

Specifies the activation mode of the trigger.
constexpr PropIdFloat TriggerDebouncer = { "TriggerDebouncer" }

Specifies the time for which trigger input has to be low in order accept the next trigger signal.
constexpr PropIdFloat TriggerDelay = { "TriggerDelay" }

Specifies the delay to apply after the trigger reception before activating it.
constexpr PropIdFloat TriggerDenoise = { "TriggerDenoise" }

Specifies the time for which trigger input has to be high in order to be accepted as a trigger signal.
constexpr PropIdFloat TriggerMask = { "TriggerMask" }

Specifies the time for which trigger pulses are ignored after accepting a trigger signal.
constexpr PropIdEnumeration TriggerMode = { "TriggerMode" }

Controls if the selected trigger is active.
constexpr PropIdEnumeration TriggerOperation = { "TriggerOperation" }

Controls the operation mode of the sensor in trigger mode.
constexpr PropIdEnumeration  TriggerOverlap = { "TriggerOverlap" }

Specifies the type trigger overlap permitted with the previous frame.
constexpr PropIdEnumeration  TriggerSelector = { "TriggerSelector" }

Selects the type of trigger to configure.
constexpr PropIdCommand  TriggerSoftware = { "TriggerSoftware" }

Generates an internal trigger.
constexpr PropIdEnumeration  TriggerSource = { "TriggerSource" }

Specifies the internal signal or physical input Line to use as the trigger source.
constexpr PropIdEnumeration  UserSetDefault = { "UserSetDefault" }

Selects the feature User Set to load and make active by default when the device is reset.
constexpr PropIdCommand  UserSetLoad = { "UserSetLoad" }

Loads the User Set specified by UserSetSelector to the device and makes it active.
constexpr PropIdCommand  UserSetSave = { "UserSetSave" }

Save the User Set specified by UserSetSelector to the non-volatile memory of the device.
constexpr PropIdEnumeration  UserSetSelector = { "UserSetSelector" }

Selects the feature User Set to load, save or configure.
constexpr PropIdInteger  Width = { "Width" }

Width of the image provided by the device (in pixels).
constexpr PropIdInteger  WidthMax = { "WidthMax" }

Maximum width of the image (in pixels).
constexpr PropIdInteger  Zoom = { "Zoom" }

Changes the zoom setting of the lens.

Detailed Description

Contains definitions for common device property identifiers.

Variable Documentation

◆ AcquisitionMode

constexpr PropIdEnumeration AcquisitionMode = { "AcquisitionMode" }
constexpr

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.

◆ AcquisitionStart

constexpr PropIdCommand AcquisitionStart = { "AcquisitionStart" }
constexpr

Starts the Acquisition of the device.

The number of frames captured is specified by AcquisitionMode.

◆ AcquisitionStop

constexpr PropIdCommand AcquisitionStop = { "AcquisitionStop" }
constexpr

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.

◆ ActionDeviceKey

constexpr PropIdInteger ActionDeviceKey = { "ActionDeviceKey" }
constexpr

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.

◆ ActionQueueSize

constexpr PropIdInteger ActionQueueSize = { "ActionQueueSize" }
constexpr

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.

◆ ActionSchedulerInterval

constexpr PropIdInteger ActionSchedulerInterval = { "ActionSchedulerInterval" }
constexpr

Action repetition interval.

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

◆ BalanceRatio

constexpr PropIdFloat BalanceRatio = { "BalanceRatio" }
constexpr

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

It is used for white balancing.

◆ BalanceRatioSelector

constexpr PropIdEnumeration BalanceRatioSelector = { "BalanceRatioSelector" }
constexpr

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.

◆ BalanceWhiteAuto

constexpr PropIdEnumeration BalanceWhiteAuto = { "BalanceWhiteAuto" }
constexpr

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

The white balancing ratios are automatically adjusted.

◆ BinningHorizontal

constexpr PropIdInteger BinningHorizontal = { "BinningHorizontal" }
constexpr

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.

◆ BinningVertical

constexpr PropIdInteger BinningVertical = { "BinningVertical" }
constexpr

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.

◆ BlackLevel

constexpr PropIdFloat BlackLevel = { "BlackLevel" }
constexpr

Controls the analog black level as an absolute physical value.

This represents a DC offset applied to the video signal

◆ DecimationHorizontal

constexpr PropIdInteger DecimationHorizontal = { "DecimationHorizontal" }
constexpr

Horizontal sub-sampling of the image.

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

◆ DecimationVertical

constexpr PropIdInteger DecimationVertical = { "DecimationVertical" }
constexpr

Vertical sub-sampling of the image.

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

◆ DeviceFactoryReset

constexpr PropIdCommand DeviceFactoryReset = { "DeviceFactoryReset" }
constexpr

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

After reset, the device must be rediscovered.

◆ DeviceReset

constexpr PropIdCommand DeviceReset = { "DeviceReset" }
constexpr

Resets the device to its power up state.

After reset, the device must be rediscovered.

◆ DeviceSerialNumber

constexpr PropIdString DeviceSerialNumber = { "DeviceSerialNumber" }
constexpr

Device's serial number.

This string is a unique identifier of the device.

◆ DeviceTemperature

constexpr PropIdFloat DeviceTemperature = { "DeviceTemperature" }
constexpr

Device temperature in degrees Celsius (°C).

It is measured at the location selected by DeviceTemperatureSelector.

◆ EventExposureEnd

constexpr PropIdInteger EventExposureEnd = { "EventExposureEnd" }
constexpr

Unique identifier of the Exposure End event.

Use this parameter to get notified when the event occurs.

◆ EventFocusMoveCompleted

constexpr PropIdInteger EventFocusMoveCompleted = { "EventFocusMoveCompleted" }
constexpr

Unique identifier of the Focus Move Completed event.

Use this parameter to get notified when the event occurs.

◆ EventFrameTriggerMissed

constexpr PropIdInteger EventFrameTriggerMissed = { "EventFrameTriggerMissed" }
constexpr

Unique identifier of the Frame Trigger Missed event.

Use this parameter to get notified when the event occurs.

◆ EventLine1FallingEdge

constexpr PropIdInteger EventLine1FallingEdge = { "EventLine1FallingEdge" }
constexpr

Unique identifier of the Line1 Falling Edge event.

Use this parameter to get notified when the event occurs.

◆ EventLine1RisingEdge

constexpr PropIdInteger EventLine1RisingEdge = { "EventLine1RisingEdge" }
constexpr

Unique identifier of the Line1 Rising Edge event.

Use this parameter to get notified when the event occurs.

◆ EventNotification

constexpr PropIdEnumeration EventNotification = { "EventNotification" }
constexpr

Enables event notifications for the currently selected event.

The event can selected using the Event Selector parameter.

◆ EventSelector

constexpr PropIdEnumeration EventSelector = { "EventSelector" }
constexpr

Sets the event notification to be enabled.

The notification can be enabled using the Event Notification parameter.

◆ EventTest

constexpr PropIdInteger EventTest = { "EventTest" }
constexpr

Unique identifier of the Test event.

Use this parameter to get notified when the event occurs.

◆ EventZoomMoveCompleted

constexpr PropIdInteger EventZoomMoveCompleted = { "EventZoomMoveCompleted" }
constexpr

Unique identifier of the Zoom Move Completed event.

Use this parameter to get notified when the event occurs.

◆ ExposureTime

constexpr PropIdFloat ExposureTime = { "ExposureTime" }
constexpr

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

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

◆ FileOperationResult

constexpr PropIdInteger FileOperationResult = { "FileOperationResult" }
constexpr

Represents the file operation result.

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

◆ FileOperationSelector

constexpr PropIdEnumeration FileOperationSelector = { "FileOperationSelector" }
constexpr

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

This Operation is executed when the FileOperationExecute feature is called.

◆ Gain

constexpr PropIdFloat Gain = { "Gain" }
constexpr

Controls the gain as an absolute physical value.

This is an amplification factor applied to he video signal.

◆ Gamma

constexpr PropIdFloat Gamma = { "Gamma" }
constexpr

Controls the gamma correction of pixel intensity.

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

◆ GevSCPSDoNotFragment

constexpr PropIdBoolean GevSCPSDoNotFragment = { "GevSCPSDoNotFragment" }
constexpr

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.

◆ GevSCPSPacketSize

constexpr PropIdInteger GevSCPSPacketSize = { "GevSCPSPacketSize" }
constexpr

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.

◆ HeightMax

constexpr PropIdInteger HeightMax = { "HeightMax" }
constexpr

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.

◆ IMX174HardwareWDREnable

constexpr PropIdBoolean IMX174HardwareWDREnable = { "IMX174HardwareWDREnable" }
constexpr

Enable IMX174 WDR mode.

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

◆ IMX174HardwareWDRShutterMode

constexpr PropIdEnumeration IMX174HardwareWDRShutterMode = { "IMX174HardwareWDRShutterMode" }
constexpr

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.

◆ IMXLowLatencyTriggerMode

constexpr PropIdBoolean IMXLowLatencyTriggerMode = { "IMXLowLatencyTriggerMode" }
constexpr

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.

◆ PayloadSize

constexpr PropIdInteger PayloadSize = { "PayloadSize" }
constexpr

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.

◆ SoftwareTransformEnable

constexpr PropIdBoolean SoftwareTransformEnable = { "SoftwareTransformEnable" }
constexpr

Enables Software Transform properties.

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

◆ TimestampLatchValue

constexpr PropIdInteger TimestampLatchValue = { "TimestampLatchValue" }
constexpr

Returns the latched value of the timestamp counter.

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

◆ TimestampReset

constexpr PropIdCommand TimestampReset = { "TimestampReset" }
constexpr

Resets the current value of the device timestamp counter.

After executing this command, the timestamp counter restarts automatically.

◆ TriggerOverlap

constexpr PropIdEnumeration TriggerOverlap = { "TriggerOverlap" }
constexpr

Specifies the type trigger overlap permitted with the previous frame.

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

◆ TriggerSoftware

constexpr PropIdCommand TriggerSoftware = { "TriggerSoftware" }
constexpr

Generates an internal trigger.

TriggerSource must be set to Software or Any.

◆ WidthMax

constexpr PropIdInteger WidthMax = { "WidthMax" }
constexpr

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.