Class PropId

Contains declarations of identifiers for known properties.

Inheritance
object
PropId
Inherited Members
Namespace: ic4
Assembly: ic4dotnet.dll
Syntax
public static class PropId
Remarks

Using PropId-derived property identifiers allows typed access to property objects, e.g. Find(PropIdInteger)

Fields

AcquisitionBurstFrameCount

Number of frames to acquire for each trigger.

Declaration
public static readonly PropIdInteger AcquisitionBurstFrameCount
Field Value
Type Description
PropIdInteger

AcquisitionBurstInterval

Minimum interval between frames in an acquisition burst.

Declaration
public static readonly PropIdInteger AcquisitionBurstInterval
Field Value
Type Description
PropIdInteger

AcquisitionFrameRate

Controls the acquisition rate at which the frames are captured.

Declaration
public static readonly PropIdFloat AcquisitionFrameRate
Field Value
Type Description
PropIdFloat

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.

Declaration
public static readonly PropIdEnumeration AcquisitionMode
Field Value
Type Description
PropIdEnumeration

AcquisitionStart

Starts the Acquisition of the device. The number of frames captured is specified by AcquisitionMode.

Declaration
public static readonly PropIdCommand AcquisitionStart
Field Value
Type Description
PropIdCommand

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.

Declaration
public static readonly PropIdCommand AcquisitionStop
Field Value
Type Description
PropIdCommand

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.

Declaration
public static readonly PropIdInteger ActionDeviceKey
Field Value
Type Description
PropIdInteger

ActionGroupKey

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

Declaration
public static readonly PropIdInteger ActionGroupKey
Field Value
Type Description
PropIdInteger

ActionGroupMask

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

Declaration
public static readonly PropIdInteger ActionGroupMask
Field Value
Type Description
PropIdInteger

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.

Declaration
public static readonly PropIdInteger ActionQueueSize
Field Value
Type Description
PropIdInteger

ActionSchedulerCancel

Cancels all scheduled actions.

Declaration
public static readonly PropIdCommand ActionSchedulerCancel
Field Value
Type Description
PropIdCommand

ActionSchedulerCommit

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

Declaration
public static readonly PropIdCommand ActionSchedulerCommit
Field Value
Type Description
PropIdCommand

ActionSchedulerInterval

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

Declaration
public static readonly PropIdInteger ActionSchedulerInterval
Field Value
Type Description
PropIdInteger

ActionSchedulerStatus

Indicates whether there are actions scheduled.

Declaration
public static readonly PropIdEnumeration ActionSchedulerStatus
Field Value
Type Description
PropIdEnumeration

ActionSchedulerTime

Camera time for when the action is to be scheduled.

Declaration
public static readonly PropIdInteger ActionSchedulerTime
Field Value
Type Description
PropIdInteger

ActionSelector

Selects to which Action Signal further Action settings apply.

Declaration
public static readonly PropIdInteger ActionSelector
Field Value
Type Description
PropIdInteger

AutoFocusROIEnable

Enable the region of interest for auto focus.

Declaration
public static readonly PropIdBoolean AutoFocusROIEnable
Field Value
Type Description
PropIdBoolean

AutoFocusROIHeight

Vertical size of the auto focus region of interest.

Declaration
public static readonly PropIdInteger AutoFocusROIHeight
Field Value
Type Description
PropIdInteger

AutoFocusROILeft

Horizontal offset of the auto focus region of interest.

Declaration
public static readonly PropIdInteger AutoFocusROILeft
Field Value
Type Description
PropIdInteger

AutoFocusROITop

Vertical offset of the auto focus region of interest.

Declaration
public static readonly PropIdInteger AutoFocusROITop
Field Value
Type Description
PropIdInteger

AutoFocusROIWidth

Horizontal size of the auto focus region of interest.

Declaration
public static readonly PropIdInteger AutoFocusROIWidth
Field Value
Type Description
PropIdInteger

AutoFunctionsROIEnable

Enable the region of interest for auto functions.

Declaration
public static readonly PropIdBoolean AutoFunctionsROIEnable
Field Value
Type Description
PropIdBoolean

AutoFunctionsROIHeight

Vertical size of the auto functions region of interest.

Declaration
public static readonly PropIdInteger AutoFunctionsROIHeight
Field Value
Type Description
PropIdInteger

AutoFunctionsROILeft

Horizontal offset of the auto functions region of interest.

Declaration
public static readonly PropIdInteger AutoFunctionsROILeft
Field Value
Type Description
PropIdInteger

AutoFunctionsROIPreset

Select a predefined region of interest for auto functions.

Declaration
public static readonly PropIdEnumeration AutoFunctionsROIPreset
Field Value
Type Description
PropIdEnumeration

AutoFunctionsROITop

Vertical offset of the auto functions region of interest.

Declaration
public static readonly PropIdInteger AutoFunctionsROITop
Field Value
Type Description
PropIdInteger

AutoFunctionsROIWidth

Horizontal size of the auto functions region of interest.

Declaration
public static readonly PropIdInteger AutoFunctionsROIWidth
Field Value
Type Description
PropIdInteger

BalanceRatio

Controls ratio of the selected color component to a reference color component. It is used for white balancing.

Declaration
public static readonly PropIdFloat BalanceRatio
Field Value
Type Description
PropIdFloat

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.

Declaration
public static readonly PropIdEnumeration BalanceRatioSelector
Field Value
Type Description
PropIdEnumeration

BalanceWhiteAuto

Controls the mode for automatic white balancing between the color channels. The white balancing ratios are automatically adjusted.

Declaration
public static readonly PropIdEnumeration BalanceWhiteAuto
Field Value
Type Description
PropIdEnumeration

BalanceWhiteAutoPreset

Selects a specific preset for automatic white balance.

Declaration
public static readonly PropIdEnumeration BalanceWhiteAutoPreset
Field Value
Type Description
PropIdEnumeration

BalanceWhiteMode

Configures the way auto white balance works.

Declaration
public static readonly PropIdEnumeration BalanceWhiteMode
Field Value
Type Description
PropIdEnumeration

BalanceWhiteTemperature

Adjusts the white balance controls to match the ambient light temperature

Declaration
public static readonly PropIdInteger BalanceWhiteTemperature
Field Value
Type Description
PropIdInteger

BalanceWhiteTemperaturePreset

Selects a specific white balance preset.

Declaration
public static readonly PropIdEnumeration BalanceWhiteTemperaturePreset
Field Value
Type Description
PropIdEnumeration

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.

Declaration
public static readonly PropIdInteger BinningHorizontal
Field Value
Type Description
PropIdInteger

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.

Declaration
public static readonly PropIdInteger BinningVertical
Field Value
Type Description
PropIdInteger

BlackLevel

Controls the analog black level as an absolute physical value. This represents a DC offset applied to the video signal

Declaration
public static readonly PropIdFloat BlackLevel
Field Value
Type Description
PropIdFloat

ChunkBlockId

Returns the block ID (frame number) of the image

Declaration
public static readonly PropIdRegister ChunkBlockId
Field Value
Type Description
PropIdRegister

ChunkEnable

Enables the inclusion of the selected Chunk data in the payload of the image.

Declaration
public static readonly PropIdBoolean ChunkEnable
Field Value
Type Description
PropIdBoolean

ChunkExposureTime

Returns the exposure time used to capture the image.

Declaration
public static readonly PropIdFloat ChunkExposureTime
Field Value
Type Description
PropIdFloat

ChunkGain

Returns the gain used to capture the image.

Declaration
public static readonly PropIdFloat ChunkGain
Field Value
Type Description
PropIdFloat

ChunkIMX174FrameId

IMX174 double exposure frame id.

Declaration
public static readonly PropIdInteger ChunkIMX174FrameId
Field Value
Type Description
PropIdInteger

ChunkIMX174FrameSet

IMX174 double exposure frame set identifier.

Declaration
public static readonly PropIdInteger ChunkIMX174FrameSet
Field Value
Type Description
PropIdInteger

ChunkImage

Returns the entire image data included in the payload.

Declaration
public static readonly PropIdRegister ChunkImage
Field Value
Type Description
PropIdRegister

ChunkModeActive

Activates the inclusion of Chunk data in the payload of the image.

Declaration
public static readonly PropIdBoolean ChunkModeActive
Field Value
Type Description
PropIdBoolean

ChunkMultiFrameSetFrameId

Returns the frame id in the frame set in Multi Frame Set Output Mode.

Declaration
public static readonly PropIdInteger ChunkMultiFrameSetFrameId
Field Value
Type Description
PropIdInteger

ChunkMultiFrameSetId

Returns the id of the frame set in Multi Frame Set Output Mode.

Declaration
public static readonly PropIdInteger ChunkMultiFrameSetId
Field Value
Type Description
PropIdInteger

ChunkSelector

Selects which Chunk to enable or control

Declaration
public static readonly PropIdEnumeration ChunkSelector
Field Value
Type Description
PropIdEnumeration

ColorTransformationEnable

Activates the selected Color Transformation module.

Declaration
public static readonly PropIdBoolean ColorTransformationEnable
Field Value
Type Description
PropIdBoolean

ColorTransformationSelector

Selects which Color Transformation module is controlled by the various Color Transformation features.

Declaration
public static readonly PropIdEnumeration ColorTransformationSelector
Field Value
Type Description
PropIdEnumeration

ColorTransformationValue

Represents the value of the selected Gain factor or Offset inside the Transformation matrix.

Declaration
public static readonly PropIdFloat ColorTransformationValue
Field Value
Type Description
PropIdFloat

ColorTransformationValueSelector

Selects the Gain factor or Offset of the Transformation matrix to access in the selected Color Transformation module.

Declaration
public static readonly PropIdEnumeration ColorTransformationValueSelector
Field Value
Type Description
PropIdEnumeration

Contrast

Controls Contrast.

Declaration
public static readonly PropIdInteger Contrast
Field Value
Type Description
PropIdInteger

DecimationHorizontal

Horizontal sub-sampling of the image. This reduces the horizontal resolution (width) of the image by the specified horizontal decimation factor.

Declaration
public static readonly PropIdInteger DecimationHorizontal
Field Value
Type Description
PropIdInteger

DecimationVertical

Vertical sub-sampling of the image. This reduces the vertical resolution (height) of the image by the specified vertical decimation factor.

Declaration
public static readonly PropIdInteger DecimationVertical
Field Value
Type Description
PropIdInteger

Denoise

Controls the strength of the denoise algorithm.

Declaration
public static readonly PropIdInteger Denoise
Field Value
Type Description
PropIdInteger

DeviceEventChannelCount

Indicates the number of event channels supported by the device.

Declaration
public static readonly PropIdInteger DeviceEventChannelCount
Field Value
Type Description
PropIdInteger

DeviceFactoryReset

Resets all user-programmable non-volatile memory to default. After reset, the device must be rediscovered.

Declaration
public static readonly PropIdCommand DeviceFactoryReset
Field Value
Type Description
PropIdCommand

DeviceFirmwareVersion

Version of the device.

Declaration
public static readonly PropIdString DeviceFirmwareVersion
Field Value
Type Description
PropIdString

DeviceLinkHeartbeatTimeout

Controls the current heartbeat timeout of the specific Link.

Declaration
public static readonly PropIdFloat DeviceLinkHeartbeatTimeout
Field Value
Type Description
PropIdFloat

DeviceLinkSelector

Selects which Link of the device to control.

Declaration
public static readonly PropIdInteger DeviceLinkSelector
Field Value
Type Description
PropIdInteger

DeviceModelName

Model of the device.

Declaration
public static readonly PropIdString DeviceModelName
Field Value
Type Description
PropIdString

DeviceReset

Resets the device to its power up state. After reset, the device must be rediscovered.

Declaration
public static readonly PropIdCommand DeviceReset
Field Value
Type Description
PropIdCommand

DeviceSFNCVersionMajor

Major version of the Standard Features Naming Convention that was used to create the device's GenICam XML

Declaration
public static readonly PropIdInteger DeviceSFNCVersionMajor
Field Value
Type Description
PropIdInteger

DeviceSFNCVersionMinor

Minor version of the Standard Features Naming Convention that was used to create the device's GenICam XML

Declaration
public static readonly PropIdInteger DeviceSFNCVersionMinor
Field Value
Type Description
PropIdInteger

DeviceSFNCVersionSubMinor

Sub minor version of the Standard Features Naming Convention that was used to create the device's GenICam XML

Declaration
public static readonly PropIdInteger DeviceSFNCVersionSubMinor
Field Value
Type Description
PropIdInteger

DeviceScanType

Returns the scan type of the sensor of the device.

Declaration
public static readonly PropIdEnumeration DeviceScanType
Field Value
Type Description
PropIdEnumeration

DeviceSerialNumber

Device's serial number. This string is a unique identifier of the device.

Declaration
public static readonly PropIdString DeviceSerialNumber
Field Value
Type Description
PropIdString

DeviceStreamChannelCount

Indicates the number of streaming channels supported by the device.

Declaration
public static readonly PropIdInteger DeviceStreamChannelCount
Field Value
Type Description
PropIdInteger

DeviceStreamChannelEndianness

Endianess of multi-byte pixel data for this stream.

Declaration
public static readonly PropIdEnumeration DeviceStreamChannelEndianness
Field Value
Type Description
PropIdEnumeration

Index of device`s Link to use for streaming the specifed stream channel.

Declaration
public static readonly PropIdInteger DeviceStreamChannelLink
Field Value
Type Description
PropIdInteger

DeviceStreamChannelPacketSize

Specifies the stream packet size, in bytes, to send on the selected channel.

Declaration
public static readonly PropIdInteger DeviceStreamChannelPacketSize
Field Value
Type Description
PropIdInteger

DeviceStreamChannelSelector

Selects the stream channel to control.

Declaration
public static readonly PropIdInteger DeviceStreamChannelSelector
Field Value
Type Description
PropIdInteger

DeviceStreamChannelType

Reports the type of the stream channel.

Declaration
public static readonly PropIdEnumeration DeviceStreamChannelType
Field Value
Type Description
PropIdEnumeration

DeviceTLType

Transport Layer type of the device.

Declaration
public static readonly PropIdEnumeration DeviceTLType
Field Value
Type Description
PropIdEnumeration

DeviceTLVersionMajor

Major version of the Transport Layer of the device.

Declaration
public static readonly PropIdInteger DeviceTLVersionMajor
Field Value
Type Description
PropIdInteger

DeviceTLVersionMinor

Minor version of the Transport Layer of the device.

Declaration
public static readonly PropIdInteger DeviceTLVersionMinor
Field Value
Type Description
PropIdInteger

DeviceTLVersionSubMinor

Sub minor version of the Transport Layer of the device.

Declaration
public static readonly PropIdInteger DeviceTLVersionSubMinor
Field Value
Type Description
PropIdInteger

DeviceTemperature

Device temperature in degrees Celsius (°C). It is measured at the location selected by DeviceTemperatureSelector.

Declaration
public static readonly PropIdFloat DeviceTemperature
Field Value
Type Description
PropIdFloat

DeviceTemperatureSelector

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

Declaration
public static readonly PropIdEnumeration DeviceTemperatureSelector
Field Value
Type Description
PropIdEnumeration

DeviceType

Returns the device type.

Declaration
public static readonly PropIdEnumeration DeviceType
Field Value
Type Description
PropIdEnumeration

DeviceUserID

User-programmable device identifier.

Declaration
public static readonly PropIdString DeviceUserID
Field Value
Type Description
PropIdString

DeviceVendorName

Name of the manufacturer of the device.

Declaration
public static readonly PropIdString DeviceVendorName
Field Value
Type Description
PropIdString

DeviceVersion

Version of the device.

Declaration
public static readonly PropIdString DeviceVersion
Field Value
Type Description
PropIdString

DisableInfoOverlay

Disables the HDMI format info overlay.

Declaration
public static readonly PropIdBoolean DisableInfoOverlay
Field Value
Type Description
PropIdBoolean

EventExposureEnd

Unique identifier of the Exposure End event. Use this parameter to get notified when the event occurs.

Declaration
public static readonly PropIdInteger EventExposureEnd
Field Value
Type Description
PropIdInteger

EventExposureEndFrameID

Frame ID of the Exposure End event.

Declaration
public static readonly PropIdInteger EventExposureEndFrameID
Field Value
Type Description
PropIdInteger

EventExposureEndTimestamp

Timestamp of the Exposure End event.

Declaration
public static readonly PropIdInteger EventExposureEndTimestamp
Field Value
Type Description
PropIdInteger

EventFocusMoveCompleted

Unique identifier of the Focus Move Completed event. Use this parameter to get notified when the event occurs.

Declaration
public static readonly PropIdInteger EventFocusMoveCompleted
Field Value
Type Description
PropIdInteger

EventFocusMoveCompletedFocus

Focus value of the Focus Move Completed event.

Declaration
public static readonly PropIdInteger EventFocusMoveCompletedFocus
Field Value
Type Description
PropIdInteger

EventFocusMoveCompletedTimestamp

Timestamp of the Focus Move Completed event.

Declaration
public static readonly PropIdInteger EventFocusMoveCompletedTimestamp
Field Value
Type Description
PropIdInteger

EventFrameTriggerMissed

Unique identifier of the Frame Trigger Missed event. Use this parameter to get notified when the event occurs.

Declaration
public static readonly PropIdInteger EventFrameTriggerMissed
Field Value
Type Description
PropIdInteger

EventFrameTriggerMissedTimestamp

Timestamp of the Frame Trigger Missed event.

Declaration
public static readonly PropIdInteger EventFrameTriggerMissedTimestamp
Field Value
Type Description
PropIdInteger

EventLine1FallingEdge

Unique identifier of the Line1 Falling Edge event. Use this parameter to get notified when the event occurs.

Declaration
public static readonly PropIdInteger EventLine1FallingEdge
Field Value
Type Description
PropIdInteger

EventLine1FallingEdgeTimestamp

Timestamp of the Line1 Falling Edge event.

Declaration
public static readonly PropIdInteger EventLine1FallingEdgeTimestamp
Field Value
Type Description
PropIdInteger

EventLine1RisingEdge

Unique identifier of the Line1 Rising Edge event. Use this parameter to get notified when the event occurs.

Declaration
public static readonly PropIdInteger EventLine1RisingEdge
Field Value
Type Description
PropIdInteger

EventLine1RisingEdgeTimestamp

Timestamp of the Line1 Rising Edge event.

Declaration
public static readonly PropIdInteger EventLine1RisingEdgeTimestamp
Field Value
Type Description
PropIdInteger

EventNotification

Enables event notifications for the currently selected event. The event can selected using the Event Selector parameter.

Declaration
public static readonly PropIdEnumeration EventNotification
Field Value
Type Description
PropIdEnumeration

EventSelector

Sets the event notification to be enabled. The notification can be enabled using the Event Notification parameter.

Declaration
public static readonly PropIdEnumeration EventSelector
Field Value
Type Description
PropIdEnumeration

EventTest

Unique identifier of the Test event. Use this parameter to get notified when the event occurs.

Declaration
public static readonly PropIdInteger EventTest
Field Value
Type Description
PropIdInteger

EventTestTimestamp

Timestamp of the test event.

Declaration
public static readonly PropIdInteger EventTestTimestamp
Field Value
Type Description
PropIdInteger

EventZoomMoveCompleted

Unique identifier of the Zoom Move Completed event. Use this parameter to get notified when the event occurs.

Declaration
public static readonly PropIdInteger EventZoomMoveCompleted
Field Value
Type Description
PropIdInteger

EventZoomMoveCompletedTimestamp

Timestamp of the Zoom Move Completed event.

Declaration
public static readonly PropIdInteger EventZoomMoveCompletedTimestamp
Field Value
Type Description
PropIdInteger

EventZoomMoveCompletedZoom

Zoom value of the Zoom Move Completed event.

Declaration
public static readonly PropIdInteger EventZoomMoveCompletedZoom
Field Value
Type Description
PropIdInteger

ExpandOutputRange

Use the full brightness range when receiving YUV data via HDMI.

Declaration
public static readonly PropIdBoolean ExpandOutputRange
Field Value
Type Description
PropIdBoolean

ExposureAuto

Sets the automatic exposure mode when ExposureMode is Timed.

Declaration
public static readonly PropIdEnumeration ExposureAuto
Field Value
Type Description
PropIdEnumeration

ExposureAutoHighlighReduction

Lets the ExposureAuto/GainAuto algorithm try to avoid over-exposures.

Declaration
public static readonly PropIdBoolean ExposureAutoHighlighReduction
Field Value
Type Description
PropIdBoolean

ExposureAutoHighlightReduction

Lets the ExposureAuto/GainAuto algorithm try to avoid over-exposures.

Declaration
public static readonly PropIdBoolean ExposureAutoHighlightReduction
Field Value
Type Description
PropIdBoolean

ExposureAutoLowerLimit

Lower limit of the ExposureAuto function.

Declaration
public static readonly PropIdFloat ExposureAutoLowerLimit
Field Value
Type Description
PropIdFloat

ExposureAutoReference

Configures the target image brightness of the ExposureAuto/GainAuto algorithm.

Declaration
public static readonly PropIdInteger ExposureAutoReference
Field Value
Type Description
PropIdInteger

ExposureAutoUpperLimit

Upper limit of the ExposureAuto function.

Declaration
public static readonly PropIdFloat ExposureAutoUpperLimit
Field Value
Type Description
PropIdFloat

ExposureAutoUpperLimitAuto

Automatically sets the upper limit to match the Acquisition Frame Rate.

Declaration
public static readonly PropIdBoolean ExposureAutoUpperLimitAuto
Field Value
Type Description
PropIdBoolean

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.

Declaration
public static readonly PropIdFloat ExposureTime
Field Value
Type Description
PropIdFloat

FileAccessBuffer

Defines the intermediate access buffer that allows the exchange of data between the device file storage and the application.

Declaration
public static readonly PropIdRegister FileAccessBuffer
Field Value
Type Description
PropIdRegister

FileAccessLength

Controls the Length of the mapping between the device file storage and the FileAccessBuffer.

Declaration
public static readonly PropIdInteger FileAccessLength
Field Value
Type Description
PropIdInteger

FileAccessOffset

Controls the Offset of the mapping between the device file storage and the FileAccessBuffer.

Declaration
public static readonly PropIdInteger FileAccessOffset
Field Value
Type Description
PropIdInteger

FileOpenMode

Selects the access mode in which a file is opened in the device.

Declaration
public static readonly PropIdEnumeration FileOpenMode
Field Value
Type Description
PropIdEnumeration

FileOperationExecute

Executes the operation selected by FileOperationSelector on the selected file.

Declaration
public static readonly PropIdCommand FileOperationExecute
Field Value
Type Description
PropIdCommand

FileOperationResult

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

Declaration
public static readonly PropIdInteger FileOperationResult
Field Value
Type Description
PropIdInteger

FileOperationSelector

Selects the target operation for the selected file in the device. This Operation is executed when the FileOperationExecute feature is called.

Declaration
public static readonly PropIdEnumeration FileOperationSelector
Field Value
Type Description
PropIdEnumeration

FileOperationStatus

Represents the file operation execution status.

Declaration
public static readonly PropIdEnumeration FileOperationStatus
Field Value
Type Description
PropIdEnumeration

FileSelector

Selects the target file in the device.

Declaration
public static readonly PropIdEnumeration FileSelector
Field Value
Type Description
PropIdEnumeration

FileSize

Represents the size of the selected file in bytes.

Declaration
public static readonly PropIdInteger FileSize
Field Value
Type Description
PropIdInteger

Focus

Changes the Focus setting of the lens.

Declaration
public static readonly PropIdInteger Focus
Field Value
Type Description
PropIdInteger

FocusAuto

Enables automatic Focus control.

Declaration
public static readonly PropIdCommand FocusAuto
Field Value
Type Description
PropIdCommand

GPIn

Status of the digital input pin.

Declaration
public static readonly PropIdInteger GPIn
Field Value
Type Description
PropIdInteger

GPOut

Status of the digital output pin.

Declaration
public static readonly PropIdInteger GPOut
Field Value
Type Description
PropIdInteger

Gain

Controls the gain as an absolute physical value. This is an amplification factor applied to he video signal.

Declaration
public static readonly PropIdFloat Gain
Field Value
Type Description
PropIdFloat

GainAuto

Sets the automatic gain control mode.

Declaration
public static readonly PropIdEnumeration GainAuto
Field Value
Type Description
PropIdEnumeration

GainAutoLowerLimit

Lower limit of the GainAuto function.

Declaration
public static readonly PropIdFloat GainAutoLowerLimit
Field Value
Type Description
PropIdFloat

GainAutoUpperLimit

Upper limit of the GainAuto function.

Declaration
public static readonly PropIdFloat GainAutoUpperLimit
Field Value
Type Description
PropIdFloat

GainMode

Configures the sensor-specific Gain (LCG/HCG) setting

Declaration
public static readonly PropIdEnumeration GainMode
Field Value
Type Description
PropIdEnumeration

Gamma

Controls the gamma correction of pixel intensity. This is typically used to compensate for nonlinearity of the display system (such as CRT).

Declaration
public static readonly PropIdFloat Gamma
Field Value
Type Description
PropIdFloat

GevGVSPExtendedIDMode

Enables the extended IDs mode

Declaration
public static readonly PropIdEnumeration GevGVSPExtendedIDMode
Field Value
Type Description
PropIdEnumeration

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.

Declaration
public static readonly PropIdBoolean GevSCPSDoNotFragment
Field Value
Type Description
PropIdBoolean

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.

Declaration
public static readonly PropIdInteger GevSCPSPacketSize
Field Value
Type Description
PropIdInteger

Height

Height of the image provided by the device (in pixels).

Declaration
public static readonly PropIdInteger Height
Field Value
Type Description
PropIdInteger

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.

Declaration
public static readonly PropIdInteger HeightMax
Field Value
Type Description
PropIdInteger

Hue

Color Hue

Declaration
public static readonly PropIdFloat Hue
Field Value
Type Description
PropIdFloat

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.

Declaration
public static readonly PropIdBoolean IMX174HardwareWDREnable
Field Value
Type Description
PropIdBoolean

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.

Declaration
public static readonly PropIdEnumeration IMX174HardwareWDRShutterMode
Field Value
Type Description
PropIdEnumeration

IMX174WDRShutter2

Exposure time that is used for every other frame, if IMX174 WDR mode is enabled.

Declaration
public static readonly PropIdFloat IMX174WDRShutter2
Field Value
Type Description
PropIdFloat

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.

Declaration
public static readonly PropIdBoolean IMXLowLatencyTriggerMode
Field Value
Type Description
PropIdBoolean

IRCutFilterEnable

Enables the IRCutFilter in from of the sensor.

Declaration
public static readonly PropIdBoolean IRCutFilterEnable
Field Value
Type Description
PropIdBoolean

InputBits

The detected bits per pixel of the HDMI source.

Declaration
public static readonly PropIdInteger InputBits
Field Value
Type Description
PropIdInteger

InputFp1ks

The detected frame rate of the HDMI source.

Declaration
public static readonly PropIdInteger InputFp1ks
Field Value
Type Description
PropIdInteger

InputHeight

The detected width of the HDMI input image.

Declaration
public static readonly PropIdInteger InputHeight
Field Value
Type Description
PropIdInteger

InputWidth

The detected width of the HDMI input image.

Declaration
public static readonly PropIdInteger InputWidth
Field Value
Type Description
PropIdInteger

Iris

Changes the Iris setting of the lens.

Declaration
public static readonly PropIdInteger Iris
Field Value
Type Description
PropIdInteger

IrisAuto

Enables automatic Iris control.

Declaration
public static readonly PropIdBoolean IrisAuto
Field Value
Type Description
PropIdBoolean

LUTEnable

Activates the LUT.

Declaration
public static readonly PropIdBoolean LUTEnable
Field Value
Type Description
PropIdBoolean

LUTIndex

Control the index (offset) of the coefficient to access in the LUT.

Declaration
public static readonly PropIdInteger LUTIndex
Field Value
Type Description
PropIdInteger

LUTSelector

Selects which LUT to control.

Declaration
public static readonly PropIdEnumeration LUTSelector
Field Value
Type Description
PropIdEnumeration

LUTValue

Returns or sets the Value at entry LUTIndex of the LUT.

Declaration
public static readonly PropIdInteger LUTValue
Field Value
Type Description
PropIdInteger

LUTValueAll

Accesses all the LUT coefficients in a single access without using individual LUTIndex.

Declaration
public static readonly PropIdRegister LUTValueAll
Field Value
Type Description
PropIdRegister

MultiFrameSetOutputModeCustomGain

Enables the sensor to use customizable gain values for the different frames of a frame set.

Declaration
public static readonly PropIdBoolean MultiFrameSetOutputModeCustomGain
Field Value
Type Description
PropIdBoolean

MultiFrameSetOutputModeEnable

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

Declaration
public static readonly PropIdBoolean MultiFrameSetOutputModeEnable
Field Value
Type Description
PropIdBoolean

MultiFrameSetOutputModeExposureTime0

Configures the exposure time for frame 0 of the frame set.

Declaration
public static readonly PropIdFloat MultiFrameSetOutputModeExposureTime0
Field Value
Type Description
PropIdFloat

MultiFrameSetOutputModeExposureTime1

Configures the exposure time for frame 1 of the frame set.

Declaration
public static readonly PropIdFloat MultiFrameSetOutputModeExposureTime1
Field Value
Type Description
PropIdFloat

MultiFrameSetOutputModeExposureTime2

Configures the exposure time for frame 2 of the frame set.

Declaration
public static readonly PropIdFloat MultiFrameSetOutputModeExposureTime2
Field Value
Type Description
PropIdFloat

MultiFrameSetOutputModeExposureTime3

Configures the exposure time for frame 3 of the frame set.

Declaration
public static readonly PropIdFloat MultiFrameSetOutputModeExposureTime3
Field Value
Type Description
PropIdFloat

MultiFrameSetOutputModeFrameCount

Selects the number of frames in multi frame set output mode.

Declaration
public static readonly PropIdEnumeration MultiFrameSetOutputModeFrameCount
Field Value
Type Description
PropIdEnumeration

MultiFrameSetOutputModeGain0

Configures the gain for frame 0 of the frame set.

Declaration
public static readonly PropIdFloat MultiFrameSetOutputModeGain0
Field Value
Type Description
PropIdFloat

MultiFrameSetOutputModeGain1

Configures the gain for frame 1 of the frame set.

Declaration
public static readonly PropIdFloat MultiFrameSetOutputModeGain1
Field Value
Type Description
PropIdFloat

MultiFrameSetOutputModeGain2

Configures the gain for frame 2 of the frame set.

Declaration
public static readonly PropIdFloat MultiFrameSetOutputModeGain2
Field Value
Type Description
PropIdFloat

MultiFrameSetOutputModeGain3

Configures the gain for frame 3 of the frame set.

Declaration
public static readonly PropIdFloat MultiFrameSetOutputModeGain3
Field Value
Type Description
PropIdFloat

OffsetAutoCenter

Automatically adjust the values of OffsetX and OffsetY to select the center region of the sensor.

Declaration
public static readonly PropIdEnumeration OffsetAutoCenter
Field Value
Type Description
PropIdEnumeration

OffsetX

Horizontal offset from the origin to the region of interest (in pixels).

Declaration
public static readonly PropIdInteger OffsetX
Field Value
Type Description
PropIdInteger

OffsetY

Vertical offset from the origin to the region of interest (in pixels).

Declaration
public static readonly PropIdInteger OffsetY
Field Value
Type Description
PropIdInteger

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.

Declaration
public static readonly PropIdInteger PayloadSize
Field Value
Type Description
PropIdInteger

PixelFormat

Format of the pixels provided by the device

Declaration
public static readonly PropIdEnumeration PixelFormat
Field Value
Type Description
PropIdEnumeration

PtpClockAccuracy

Indicates the expected accuracy of the device PTP clock when it is the grandmaster, or in the event it becomes the grandmaster.

Declaration
public static readonly PropIdEnumeration PtpClockAccuracy
Field Value
Type Description
PropIdEnumeration

PtpEnable

Enables the Precision Time Protocol (PTP).

Declaration
public static readonly PropIdBoolean PtpEnable
Field Value
Type Description
PropIdBoolean

PtpStatus

Returns the current state of the PTP clock.

Declaration
public static readonly PropIdEnumeration PtpStatus
Field Value
Type Description
PropIdEnumeration

ReverseX

Flip the image horizontally.

Declaration
public static readonly PropIdBoolean ReverseX
Field Value
Type Description
PropIdBoolean

ReverseY

Flip the image vertically.

Declaration
public static readonly PropIdBoolean ReverseY
Field Value
Type Description
PropIdBoolean

Saturation

Color Saturation

Declaration
public static readonly PropIdFloat Saturation
Field Value
Type Description
PropIdFloat

SensorHeight

Effective height of the sensor in pixels.

Declaration
public static readonly PropIdInteger SensorHeight
Field Value
Type Description
PropIdInteger

SensorPixelHeight

Physical size (pitch) in the y direction of a photo sensitive pixel unit.

Declaration
public static readonly PropIdFloat SensorPixelHeight
Field Value
Type Description
PropIdFloat

SensorPixelWidth

Physical size (pitch) in the x direction of a photo sensitive pixel unit.

Declaration
public static readonly PropIdFloat SensorPixelWidth
Field Value
Type Description
PropIdFloat

SensorWidth

Effective width of the sensor in pixels.

Declaration
public static readonly PropIdInteger SensorWidth
Field Value
Type Description
PropIdInteger

Sharpness

Controls the strength of the sharpness algorithm.

Declaration
public static readonly PropIdInteger Sharpness
Field Value
Type Description
PropIdInteger

SidebandUse

Enables Trigger/Strobe over USB-C Sideband Use Pins

Declaration
public static readonly PropIdBoolean SidebandUse
Field Value
Type Description
PropIdBoolean

SignalDetected

Indicates whether a signal is detected form the HDMI source.

Declaration
public static readonly PropIdBoolean SignalDetected
Field Value
Type Description
PropIdBoolean

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.

Declaration
public static readonly PropIdBoolean SoftwareTransformEnable
Field Value
Type Description
PropIdBoolean

SourceConnected

Indicates whether a HDMI source is connected.

Declaration
public static readonly PropIdBoolean SourceConnected
Field Value
Type Description
PropIdBoolean

StrobeDelay

Configures the delay from start of exposure to the generated strobe pulse.

Declaration
public static readonly PropIdInteger StrobeDelay
Field Value
Type Description
PropIdInteger

StrobeDuration

If StrobeOperation is FixedDuration, specifies the pulse length.

Declaration
public static readonly PropIdInteger StrobeDuration
Field Value
Type Description
PropIdInteger

StrobeEnable

Enable generation of exposure-synchronized output pulses

Declaration
public static readonly PropIdEnumeration StrobeEnable
Field Value
Type Description
PropIdEnumeration

StrobeOperation

Configures the mode of specifying the length of exposure-synchronized output pulses

Declaration
public static readonly PropIdEnumeration StrobeOperation
Field Value
Type Description
PropIdEnumeration

StrobePolarity

Select level of exposure-synchronized output pulses

Declaration
public static readonly PropIdEnumeration StrobePolarity
Field Value
Type Description
PropIdEnumeration

TLParamsLocked

Used by the Transport Layer to prevent critical features from changing during acquisition.

Declaration
public static readonly PropIdInteger TLParamsLocked
Field Value
Type Description
PropIdInteger

TestEventGenerate

Generates a Test event that can be used for testing event notification.

Declaration
public static readonly PropIdCommand TestEventGenerate
Field Value
Type Description
PropIdCommand

TestPendingAck

Tests the device's pending acknowledge feature.

Declaration
public static readonly PropIdInteger TestPendingAck
Field Value
Type Description
PropIdInteger

TimestampLatch

Latches the current timestamp counter into TimestampLatchValue.

Declaration
public static readonly PropIdCommand TimestampLatch
Field Value
Type Description
PropIdCommand

TimestampLatchString

Human-readable interpretation of the latched timestamp.

Declaration
public static readonly PropIdString TimestampLatchString
Field Value
Type Description
PropIdString

TimestampLatchValue

Returns the latched value of the timestamp counter. The timestamp must first be latched by using the Timestamp Control Latch command.

Declaration
public static readonly PropIdInteger TimestampLatchValue
Field Value
Type Description
PropIdInteger

TimestampReset

Resets the current value of the device timestamp counter. After executing this command, the timestamp counter restarts automatically.

Declaration
public static readonly PropIdCommand TimestampReset
Field Value
Type Description
PropIdCommand

ToneMappingEnable

Enables tone mapping.

Declaration
public static readonly PropIdBoolean ToneMappingEnable
Field Value
Type Description
PropIdBoolean

ToneMappingGlobalBrightness

Changes the brightness reference used for a individual pixel, which is interpolated between local and global.

Declaration
public static readonly PropIdFloat ToneMappingGlobalBrightness
Field Value
Type Description
PropIdFloat

ToneMappingIntensity

Adjusts the intensity of the tonemapping algorithm.

Declaration
public static readonly PropIdFloat ToneMappingIntensity
Field Value
Type Description
PropIdFloat

TriggerActivation

Specifies the activation mode of the trigger

Declaration
public static readonly PropIdEnumeration TriggerActivation
Field Value
Type Description
PropIdEnumeration

TriggerDebouncer

Specifies the time for which trigger input has to be low in order accept the next trigger signal.

Declaration
public static readonly PropIdFloat TriggerDebouncer
Field Value
Type Description
PropIdFloat

TriggerDelay

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

Declaration
public static readonly PropIdFloat TriggerDelay
Field Value
Type Description
PropIdFloat

TriggerDenoise

Specifies the time for which trigger input has to be high in order to be accepted as a trigger signal.

Declaration
public static readonly PropIdFloat TriggerDenoise
Field Value
Type Description
PropIdFloat

TriggerMask

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

Declaration
public static readonly PropIdFloat TriggerMask
Field Value
Type Description
PropIdFloat

TriggerMode

Controls if the selected trigger is active.

Declaration
public static readonly PropIdEnumeration TriggerMode
Field Value
Type Description
PropIdEnumeration

TriggerOperation

Controls the operation mode of the sensor in trigger mode.

Declaration
public static readonly PropIdEnumeration TriggerOperation
Field Value
Type Description
PropIdEnumeration

TriggerOverlap

Specifies the type trigger overlap permitted with the previous frame. This defines when a valid trigger will be accepted for a new frame.

Declaration
public static readonly PropIdEnumeration TriggerOverlap
Field Value
Type Description
PropIdEnumeration

TriggerSelector

Selects the type of trigger to configure.

Declaration
public static readonly PropIdEnumeration TriggerSelector
Field Value
Type Description
PropIdEnumeration

TriggerSoftware

Generates an internal trigger. TriggerSource must be set to Software or Any.

Declaration
public static readonly PropIdCommand TriggerSoftware
Field Value
Type Description
PropIdCommand

TriggerSource

Specifies the internal signal or physical input Line to use as the trigger source.

Declaration
public static readonly PropIdEnumeration TriggerSource
Field Value
Type Description
PropIdEnumeration

UserSetDefault

Selects the feature User Set to load and make active by default when the device is reset.

Declaration
public static readonly PropIdEnumeration UserSetDefault
Field Value
Type Description
PropIdEnumeration

UserSetLoad

Loads the User Set specified by UserSetSelector to the device and makes it active.

Declaration
public static readonly PropIdCommand UserSetLoad
Field Value
Type Description
PropIdCommand

UserSetSave

Save the User Set specified by UserSetSelector to the non-volatile memory of the device.

Declaration
public static readonly PropIdCommand UserSetSave
Field Value
Type Description
PropIdCommand

UserSetSelector

Selects the feature User Set to load, save or configure.

Declaration
public static readonly PropIdEnumeration UserSetSelector
Field Value
Type Description
PropIdEnumeration

Width

Width of the image provided by the device (in pixels).

Declaration
public static readonly PropIdInteger Width
Field Value
Type Description
PropIdInteger

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.

Declaration
public static readonly PropIdInteger WidthMax
Field Value
Type Description
PropIdInteger

Zoom

Changes the zoom setting of the lens.

Declaration
public static readonly PropIdInteger Zoom
Field Value
Type Description
PropIdInteger