Spinnaker C++
2.6.0.0
Public Member Functions | Public Attributes | Protected Member Functions | List of all members
Camera Class Reference

The camera object class. More...

Inheritance diagram for Camera:
CameraBase ICameraBase

Public Member Functions

 ~Camera ()
 
void Init ()
 
- Public Member Functions inherited from CameraBase
virtual ~CameraBase (void)
 Virtual Destructor. More...
 
void Init ()
 Init Connects to camera with read and write access, retrieves remote device and GUI XML and generates node map references. More...
 
void DeInit ()
 DeInit Disconnects camera port, resets camera back to read access and frees GenICam node map and GUI XML. More...
 
bool IsInitialized ()
 IsInitialized Checks if camera is initialized. More...
 
bool IsValid ()
 IsValid Checks a flag to determine if camera is still valid for use. More...
 
GenApi::INodeMapGetNodeMap () const
 GetNodeMap Gets a reference to the node map that is generated from a GenICam XML file. More...
 
GenApi::INodeMapGetTLDeviceNodeMap () const
 GetTLDeviceNodeMap Gets a reference to the node map that is generated from a GenICam XML file for the GenTL Device module. More...
 
GenApi::INodeMapGetTLStreamNodeMap () const
 GetTLStreamNodeMap Gets a reference to the node map that is generated from a GenICam XML file for the GenTL Stream module. More...
 
GenApi::EAccessMode GetAccessMode () const
 GetAccessMode Returns the access mode that the software has on the Camera. More...
 
void ReadPort (uint64_t iAddress, void *pBuffer, size_t iSize)
 
void WritePort (uint64_t iAddress, const void *pBuffer, size_t iSize)
 
void BeginAcquisition ()
 BeginAcquisition Starts the image acquisition engine. More...
 
void EndAcquisition ()
 EndAcquisition Stops the image acquisition engine. More...
 
BufferOwnership GetBufferOwnership () const
 GetBufferOwnership Gets data buffer ownership. More...
 
void SetBufferOwnership (const BufferOwnership mode)
 SetBufferOwnership Sets data buffer ownership. More...
 
uint64_t GetUserBufferCount () const
 GetUserBufferCount Gets the number of user memory buffers. More...
 
uint64_t GetUserBufferSize () const
 GetUserBufferSize Gets the size of one user memory buffer (in bytes). More...
 
uint64_t GetUserBufferTotalSize () const
 GetUserBufferTotalSize Gets the total size of all the user memory buffers (in bytes). More...
 
void SetUserBuffers (void *const pMemBuffers, uint64_t totalSize)
 SetUserBuffers Specify contiguous user allocated memory to use as data buffers. More...
 
void SetUserBuffers (void **const ppMemBuffers, const uint64_t bufferCount, const uint64_t bufferSize)
 SetUserBuffers Specify non-contiguous user allocated memory to use as data buffers. More...
 
ImagePtr GetNextImage (uint64_t grabTimeout=EVENT_TIMEOUT_INFINITE, uint64_t streamID=0)
 GetNextImage Gets the next image that was received by the transport layer. More...
 
GenICam::gcstring GetUniqueID ()
 GetUniqueID This returns a unique id string that identifies the camera. More...
 
bool IsStreaming () const
 IsStreaming Returns true if the camera is currently streaming or false if it is not. More...
 
GenICam::gcstring GetGuiXml () const
 Returns the GUI XML that can be passed into the Spinnaker GUI framework. More...
 
void RegisterEventHandler (EventHandler &evtHandlerToRegister)
 RegisterEventHandler(EventHandler &) Registers a specific event handler for the camera. More...
 
void RegisterEventHandler (EventHandler &evtHandlerToRegister, const GenICam::gcstring &eventName)
 RegisterEventHandler(EventHandler &, const GenICam::gcstring&) Registers a specific event handler for the camera. More...
 
void UnregisterEventHandler (EventHandler &evtHandlerToUnregister)
 UnregisterEventHandler Unregisters an event handler for the camera Event handlers should be unregistered first before calling camera DeInit(). More...
 
unsigned int GetNumImagesInUse ()
 GetNumImagesInUse Returns the number of images that are currently in use. More...
 
unsigned int GetNumDataStreams ()
 GetNumDataStreams Returns the number of streams that a device supports. More...
 
unsigned int DiscoverMaxPacketSize ()
 DiscoverMaxPacketSize Returns the largest packet size that can be safely used on the interface that device is connected to. More...
 
void ForceIP ()
 ForceIP Forces the camera to be on the same subnet as its corresponding interface. More...
 
- Public Member Functions inherited from ICameraBase
virtual ~ICameraBase (void)
 

Public Attributes

GenApi::IIntegerLUTIndex
 
 Description: 

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

 
GenApi::IBooleanLUTEnable
 
 Description: 

Activates the selected LUT. More...

 
GenApi::IIntegerLUTValue
 
 Description: 

Returns the Value at entry LUTIndex of the LUT selected by LUTSelector. More...

 
GenApi::IEnumerationT
< LUTSelectorEnums > & 
LUTSelector
 
 Description: 

Selects which LUT to control. More...

 
GenApi::IFloatExposureTime
 
 Description: 

Exposure time in microseconds when Exposure Mode is Timed. More...

 
GenApi::ICommandAcquisitionStop
 Description: This command stops the acquisition of images. More...
 
GenApi::IFloatAcquisitionResultingFrameRate
 Description: Resulting frame rate in Hertz. More...
 
GenApi::IFloatAcquisitionLineRate
 Description: Controls the rate (in Hertz) at which the Lines in a Frame are captured. More...
 
GenApi::ICommandAcquisitionStart
 Description: This command starts the acquisition of images. More...
 
GenApi::ICommandTriggerSoftware
 
 Description: 

Generates an internal trigger if Trigger Source is set to Software. More...

 
GenApi::IEnumerationT
< ExposureModeEnums > & 
ExposureMode
 
 Description: 

Sets the operation mode of the Exposure. More...

 
GenApi::IEnumerationT
< AcquisitionModeEnums > & 
AcquisitionMode
 Description: Sets the acquisition mode of the device. More...
 
GenApi::IIntegerAcquisitionFrameCount
 
 Description: 

Number of images to acquire during a multi frame acquisition. More...

 
GenApi::IEnumerationT
< TriggerSourceEnums > & 
TriggerSource
 
 Description: 

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

 
GenApi::IEnumerationT
< TriggerActivationEnums > & 
TriggerActivation
 Description: Specifies the activation mode of the trigger. More...
 
GenApi::IEnumerationT
< SensorShutterModeEnums > & 
SensorShutterMode
 Description: Sets the shutter mode of the device. More...
 
GenApi::IFloatTriggerDelay
 
 Description: 

Specifies the delay in microseconds (us) to apply after the trigger reception before activating it. More...

 
GenApi::IEnumerationT
< TriggerModeEnums > & 
TriggerMode
 
 Description: 

Controls whether or not trigger is active. More...

 
GenApi::IFloatAcquisitionFrameRate
 Description: User controlled acquisition frame rate in Hertz Visibility: More...
 
GenApi::IEnumerationT
< TriggerOverlapEnums > & 
TriggerOverlap
 Description: Specifies the overlap mode of the trigger. More...
 
GenApi::IEnumerationT
< TriggerSelectorEnums > & 
TriggerSelector
 Description: Selects the type of trigger to configure. More...
 
GenApi::IBooleanAcquisitionFrameRateEnable
 Description: If enabled, AcquisitionFrameRate can be used to manually control the frame rate. More...
 
GenApi::IEnumerationT
< ExposureAutoEnums > & 
ExposureAuto
 Description: Sets the automatic exposure mode Visibility: More...
 
GenApi::IIntegerAcquisitionBurstFrameCount
 
 Description: 

This feature is used only if the FrameBurstStart trigger is enabled and the FrameBurstEnd trigger is disabled. More...

 
GenApi::IIntegerEventTest
 Description: Returns the unique identifier of the Test type of Event. More...
 
GenApi::IIntegerEventTestTimestamp
 Description: Returns the Timestamp of the Test Event. More...
 
GenApi::IIntegerEventExposureEndFrameID
 Description: Returns the unique Identifier of the Frame (or image) that generated the Exposure End Event. More...
 
GenApi::IIntegerEventExposureEnd
 Description: Returns the unique identifier of the Exposure End type of Event. More...
 
GenApi::IIntegerEventExposureEndTimestamp
 Description: Returns the Timestamp of the Exposure End Event. More...
 
GenApi::IIntegerEventError
 Description: Returns the unique identifier of the Error type of Event. More...
 
GenApi::IIntegerEventErrorTimestamp
 Description: Returns the Timestamp of the Error Event. More...
 
GenApi::IIntegerEventErrorCode
 Description: Returns the error code for the error that happened Visibility: More...
 
GenApi::IIntegerEventErrorFrameID
 Description: Returns the unique Identifier of the Frame (or image) that generated the Error Event. More...
 
GenApi::IEnumerationT
< EventSelectorEnums > & 
EventSelector
 Description: Selects which Event to enable or disable. More...
 
GenApi::IBooleanEventSerialReceiveOverflow
 Description: Returns the status of the event serial receive overflow. More...
 
GenApi::IIntegerEventSerialPortReceive
 Description: Returns the unique identifier of the Serial Port Receive type of Event. More...
 
GenApi::IIntegerEventSerialPortReceiveTimestamp
 Description: Returns the Timestamp of the Serial Port Receive Event. More...
 
GenApi::IStringEventSerialData
 Description: Returns the serial data that was received. More...
 
GenApi::IIntegerEventSerialDataLength
 Description: Returns the length of the received serial data that was included in the event payload. More...
 
GenApi::IEnumerationT
< EventNotificationEnums > & 
EventNotification
 Description: Enables/Disables the selected event. More...
 
GenApi::IIntegerLogicBlockLUTRowIndex
 Description: Controls the row of the truth table to access in the selected LUT. More...
 
GenApi::IEnumerationT
< LogicBlockSelectorEnums > & 
LogicBlockSelector
 Description: Selects which LogicBlock to configure Visibility: More...
 
GenApi::IEnumerationT
< LogicBlockLUTInputActivationEnums > & 
LogicBlockLUTInputActivation
 Description: Selects the activation mode of the Logic Input Source signal. More...
 
GenApi::IEnumerationT
< LogicBlockLUTInputSelectorEnums > & 
LogicBlockLUTInputSelector
 Description: Controls which LogicBlockLUT Input Source & Activation to access. More...
 
GenApi::IEnumerationT
< LogicBlockLUTInputSourceEnums > & 
LogicBlockLUTInputSource
 Description: Selects the source for the input into the Logic LUT. More...
 
GenApi::IBooleanLogicBlockLUTOutputValue
 Description: Controls the output column of the truth table for the selected LogicBlockLUTRowIndex. More...
 
GenApi::IIntegerLogicBlockLUTOutputValueAll
 Description: Sets the value of all the output bits in the selected LUT. More...
 
GenApi::IEnumerationT
< LogicBlockLUTSelectorEnums > & 
LogicBlockLUTSelector
 Description: Selects which LogicBlock LUT to configure Visibility: More...
 
GenApi::IFloatColorTransformationValue
 
 Description: 

Represents the value of the selected Gain factor or Offset inside the Transformation matrix in floating point precision. More...

 
GenApi::IBooleanColorTransformationEnable
 
 Description: 

Enables/disables the color transform selected with ColorTransformationSelector. More...

 
GenApi::IEnumerationT
< ColorTransformationSelectorEnums > & 
ColorTransformationSelector
 Description: Selects which Color Transformation module is controlled by the various Color Transformation features. More...
 
GenApi::IEnumerationT
< RgbTransformLightSourceEnums > & 
RgbTransformLightSource
 
 Description: 

Used to select from a set of RGBtoRGB transform matricies calibrated for different light sources. More...

 
GenApi::IFloatSaturation
 Description: Controls the color saturation. More...
 
GenApi::IBooleanSaturationEnable
 Description: Enables/disables Saturation adjustment. More...
 
GenApi::IEnumerationT
< ColorTransformationValueSelectorEnums > & 
ColorTransformationValueSelector
 
 Description: 

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

 
GenApi::IIntegerTimestampLatchValue
 Description: Returns the latched value of the timestamp counter. More...
 
GenApi::ICommandTimestampReset
 Description: Resets the current value of the device timestamp counter. More...
 
GenApi::IStringDeviceUserID
 Description: User-programmable device identifier. More...
 
GenApi::IFloatDeviceTemperature
 Description: Device temperature in degrees Celsius (C). More...
 
GenApi::IIntegerMaxDeviceResetTime
 Description: Time to wait until device reset complete (ms). More...
 
GenApi::IIntegerDeviceTLVersionMinor
 
 Description: 

Minor version of the Transport Layer of the device. More...

 
GenApi::IStringDeviceSerialNumber
 
 Description: 

Device's serial number. More...

 
GenApi::IStringDeviceVendorName
 Description: Name of the manufacturer of the device. More...
 
GenApi::IEnumerationT
< DeviceRegistersEndiannessEnums > & 
DeviceRegistersEndianness
 Description: Endianness of the registers of the device. More...
 
GenApi::IStringDeviceManufacturerInfo
 Description: Manufacturer information about the device. More...
 
GenApi::IIntegerDeviceLinkSpeed
 
 Description: 

Indicates the speed of transmission negotiated on the specified Link. More...

 
GenApi::IIntegerLinkUptime
 Description: Time since the last phy negotiation (enumeration). More...
 
GenApi::IIntegerDeviceEventChannelCount
 
 Description: 

Indicates the number of event channels supported by the device. More...

 
GenApi::ICommandTimestampLatch
 Description: Latches the current timestamp counter into TimestampLatchValue. More...
 
GenApi::IEnumerationT
< DeviceScanTypeEnums > & 
DeviceScanType
 Description: Scan type of the sensor of the device. More...
 
GenApi::ICommandDeviceReset
 Description: This is a command that immediately resets and reboots the device. More...
 
GenApi::IEnumerationT
< DeviceCharacterSetEnums > & 
DeviceCharacterSet
 
 Description: 

Character set used by the strings of the device`s bootstrap registers. More...

 
GenApi::IIntegerDeviceLinkThroughputLimit
 
 Description: 

Limits the maximum bandwidth of the data that will be streamed out by the device on the selected Link. More...

 
GenApi::IStringDeviceFirmwareVersion
 Description: Version of the firmware on the device. More...
 
GenApi::IIntegerDeviceStreamChannelCount
 
 Description: 

Indicates the number of streaming channels supported by the device. More...

 
GenApi::IEnumerationT
< DeviceTLTypeEnums > & 
DeviceTLType
 Description: Transport Layer type of the device. More...
 
GenApi::IStringDeviceVersion
 Description: Version of the device. More...
 
GenApi::IEnumerationT
< DevicePowerSupplySelectorEnums > & 
DevicePowerSupplySelector
 
 Description: 

Selects the power supply source to control or read. More...

 
GenApi::IStringSensorDescription
 Description: Returns Sensor Description Visibility: More...
 
GenApi::IStringDeviceModelName
 Description: Model of the device. More...
 
GenApi::IIntegerDeviceTLVersionMajor
 
 Description: 

Major version of the Transport Layer of the device. More...

 
GenApi::IEnumerationT
< DeviceTemperatureSelectorEnums > & 
DeviceTemperatureSelector
 
 Description: 

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

 
GenApi::IIntegerEnumerationCount
 Description: Number of enumerations since uptime. More...
 
GenApi::IFloatPowerSupplyCurrent
 
 Description: 

Indicates the output current of the selected power supply (A). More...

 
GenApi::IStringDeviceID
 Description: Device identifier (serial number). More...
 
GenApi::IIntegerDeviceUptime
 Description: Total time since the device was powered up in seconds. More...
 
GenApi::IIntegerDeviceLinkCurrentThroughput
 Description: Current bandwidth of streamed data. More...
 
GenApi::IIntegerDeviceMaxThroughput
 
 Description: 

Maximum bandwidth of the data that can be streamed out of the device. More...

 
GenApi::ICommandFactoryReset
 Description: Returns all user tables to factory default Visibility: More...
 
GenApi::IFloatPowerSupplyVoltage
 
 Description: 

Indicates the current voltage of the selected power supply (V). More...

 
GenApi::IEnumerationT
< DeviceIndicatorModeEnums > & 
DeviceIndicatorMode
 Description: Controls the LED behaviour: Inactive (off), Active (current status), or Error Status (off unless an error occurs). More...
 
GenApi::IFloatDeviceLinkBandwidthReserve
 
 Description: 

Percentage of streamed data bandwidth reserved for packet resend. More...

 
GenApi::IIntegerAasRoiOffsetY
 
 Description: 

Controls the y-offset of the ROI used by the auto algorithm that is currently selected by the AutoAlgorithmSelector feature. More...

 
GenApi::IIntegerAasRoiOffsetX
 
 Description: 

Controls the x-offset of the ROI used by the auto algorithm that is currently selected by the AutoAlgorithmSelector feature. More...

 
GenApi::IEnumerationT
< AutoExposureControlPriorityEnums > & 
AutoExposureControlPriority
 
 Description: 

Selects whether to adjust gain or exposure first. More...

 
GenApi::IFloatBalanceWhiteAutoLowerLimit
 
 Description: 

Controls the minimum value Auto White Balance can set for the Red/Blue BalanceRatio. More...

 
GenApi::IFloatBalanceWhiteAutoDamping
 
 Description: 

Controls how quickly 'BalanceWhiteAuto' adjusts the values for Red and Blue BalanceRatio in response to changing conditions. More...

 
GenApi::IIntegerAasRoiHeight
 
 Description: 

Controls the width of the ROI used by the auto algorithm that is currently selected by the AutoAlgorithmSelector feature. More...

 
GenApi::IFloatAutoExposureGreyValueUpperLimit
 
 Description: 

The highest value in percentage that the target mean may reach. More...

 
GenApi::IFloatAutoExposureTargetGreyValue
 
 Description: 

This is the user-specified target grey level (image mean) to apply to the current image. More...

 
GenApi::IFloatAutoExposureGainLowerLimit
 
 Description: 

The smallest gain that auto exposure can set. More...

 
GenApi::IFloatAutoExposureGreyValueLowerLimit
 
 Description: 

The lowest value in percentage that the target mean may reach. More...

 
GenApi::IEnumerationT
< AutoExposureMeteringModeEnums > & 
AutoExposureMeteringMode
 
 Description: 

Selects a metering mode: average, spot, or partial metering. More...

 
GenApi::IFloatAutoExposureExposureTimeUpperLimit
 
 Description: 

The largest exposure time that auto exposure can set. More...

 
GenApi::IFloatAutoExposureGainUpperLimit
 
 Description: 

The largest gain that auto exposure can set. More...

 
GenApi::IFloatAutoExposureControlLoopDamping
 
 Description: 

It controls how fast the exposure and gain get settled. More...

 
GenApi::IFloatAutoExposureEVCompensation
 
 Description: 

The EV compensation value used in the exposure compensation. More...

 
GenApi::IFloatAutoExposureExposureTimeLowerLimit
 
 Description: 

The smallest exposure time that auto exposure can set. More...

 
GenApi::IEnumerationT
< BalanceWhiteAutoProfileEnums > & 
BalanceWhiteAutoProfile
 Description: Selects the profile used by BalanceWhiteAuto. More...
 
GenApi::IEnumerationT
< AutoAlgorithmSelectorEnums > & 
AutoAlgorithmSelector
 
 Description: 

Selects which Auto Algorithm is controlled by the RoiEnable, OffsetX, OffsetY, Width, Height features. More...

 
GenApi::IEnumerationT
< AutoExposureTargetGreyValueAutoEnums > & 
AutoExposureTargetGreyValueAuto
 
 Description: 

This indicates whether the target image grey level is automatically set by the camera or manually set by the user. More...

 
GenApi::IBooleanAasRoiEnable
 
 Description: 

Controls whether a user-specified ROI is used for auto algorithm that is currently selected by the AutoAlgorithmSelector feature. More...

 
GenApi::IEnumerationT
< AutoExposureLightingModeEnums > & 
AutoExposureLightingMode
 
 Description: 

Selects a lighting mode: Backlight, Frontlight or Normal (default). More...

 
GenApi::IIntegerAasRoiWidth
 
 Description: 

Controls the width of the ROI used by the auto algorithm that is currently selected by the AutoAlgorithmSelector feature. More...

 
GenApi::IFloatBalanceWhiteAutoUpperLimit
 
 Description: 

Controls the maximum value Auto White Balance can set the Red/Blue BalanceRatio. More...

 
GenApi::IIntegerLinkErrorCount
 Description: Counts the number of error on the link. More...
 
GenApi::IBooleanGevCurrentIPConfigurationDHCP
 Description: Controls whether the DHCP IP configuration scheme is activated on the given logical link. More...
 
GenApi::IIntegerGevInterfaceSelector
 Description: Selects which logical link to control. More...
 
GenApi::IIntegerGevSCPD
 Description: Controls the delay (in GEV timestamp counter unit) to insert between each packet for this stream channel. More...
 
GenApi::IIntegerGevTimestampTickFrequency
 Description: Indicates the number of timestamp ticks in 1 second (frequency in Hz). More...
 
GenApi::IIntegerGevSCPSPacketSize
 Description: Specifies the stream packet size (in bytes) to send on this channel. More...
 
GenApi::IIntegerGevCurrentDefaultGateway
 Description: Reports the default gateway IP address to be used on the given logical link. More...
 
GenApi::IBooleanGevSCCFGUnconditionalStreaming
 Description: Enables the camera to continue to stream, for this stream channel, if its control channel is closed or regardless of the reception of any ICMP messages (such as destination unreachable messages). More...
 
GenApi::IIntegerGevMCTT
 Description: Indicates the transmission timeout of the message channel. More...
 
GenApi::IBooleanGevSCPSDoNotFragment
 Description: The state of this feature is copied into the "do not fragment" bit of the IP header of each stream packet. More...
 
GenApi::IIntegerGevCurrentSubnetMask
 Description: Reports the subnet mask of the given logical link. More...
 
GenApi::IIntegerGevStreamChannelSelector
 Description: Selects the stream channel to control. More...
 
GenApi::IIntegerGevCurrentIPAddress
 Description: Reports the IP address for the given logical link. More...
 
GenApi::IIntegerGevMCSP
 Description: Indicates the source port of the message channel. More...
 
GenApi::IIntegerGevGVCPPendingTimeout
 Description: Indicates the longest GVCP command execution time before the device returns a PENDING_ACK in milliseconds. More...
 
GenApi::IEnumerationT
< GevIEEE1588StatusEnums > & 
GevIEEE1588Status
 Description: Provides the status of the IEEE 1588 clock. More...
 
GenApi::IStringGevFirstURL
 Description: The first choice of URL for the XML device description file. More...
 
GenApi::IIntegerGevMACAddress
 Description: MAC address of the logical link. More...
 
GenApi::IIntegerGevPersistentSubnetMask
 Description: Controls the Persistent subnet mask associated with the Persistent IP address on this logical link. More...
 
GenApi::IIntegerGevMCPHostPort
 Description: The port to which the device must send messages Visibility: More...
 
GenApi::IIntegerGevSCPHostPort
 Description: Controls the port of the selected channel to which a GVSP transmitter must send data stream or the port from which a GVSP receiver may receive data stream. More...
 
GenApi::IBooleanGevGVCPPendingAck
 Description: Enables the generation of PENDING_ACK. More...
 
GenApi::IIntegerGevSCPInterfaceIndex
 Description: Index of the logical link to use. More...
 
GenApi::IBooleanGevSupportedOption
 Description: Returns if the selected GEV option is supported. More...
 
GenApi::IEnumerationT
< GevIEEE1588ModeEnums > & 
GevIEEE1588Mode
 Description: Provides the mode of the IEEE 1588 clock. More...
 
GenApi::IBooleanGevCurrentIPConfigurationLLA
 Description: Controls whether the Link Local Address IP configuration scheme is activated on the given logical link. More...
 
GenApi::IIntegerGevSCSP
 Description: Indicates the source port of the stream channel. More...
 
GenApi::IBooleanGevIEEE1588
 Description: Enables the IEEE 1588 Precision Time Protocol to control the timestamp register. More...
 
GenApi::IBooleanGevSCCFGExtendedChunkData
 Description: Enables cameras to use the extended chunk data payload type for this stream channel. More...
 
GenApi::IIntegerGevPersistentIPAddress
 Description: Controls the Persistent IP address for this logical link. More...
 
GenApi::IBooleanGevCurrentIPConfigurationPersistentIP
 Description: Controls whether the PersistentIP configuration scheme is activated on the given logical link. More...
 
GenApi::IEnumerationT
< GevIEEE1588ClockAccuracyEnums > & 
GevIEEE1588ClockAccuracy
 Description: Indicates the expected accuracy of the device clock when it is the grandmaster, or in the event it becomes the grandmaster. More...
 
GenApi::IIntegerGevHeartbeatTimeout
 Description: Indicates the current heartbeat timeout in milliseconds. More...
 
GenApi::IIntegerGevPersistentDefaultGateway
 Description: Controls the persistent default gateway for this logical link. More...
 
GenApi::IEnumerationT
< GevCCPEnums > & 
GevCCP
 Description: Controls the device access privilege of an application. More...
 
GenApi::IIntegerGevMCDA
 Description: Controls the destination IP address of the message channel Visibility: More...
 
GenApi::IIntegerGevSCDA
 Description: Controls the destination IP address of the selected stream channel to which a GVSP transmitter must send data stream or the destination IP address from which a GVSP receiver may receive data stream. More...
 
GenApi::IIntegerGevSCPDirection
 Description: Transmit or Receive of the channel Visibility: More...
 
GenApi::IBooleanGevSCPSFireTestPacket
 Description: Sends a test packet. More...
 
GenApi::IStringGevSecondURL
 Description: The second choice of URL to the XML device description file. More...
 
GenApi::IEnumerationT
< GevSupportedOptionSelectorEnums > & 
GevSupportedOptionSelector
 Description: Selects the GEV option to interrogate for existing support. More...
 
GenApi::IBooleanGevGVCPHeartbeatDisable
 Description: Disables the GVCP heartbeat. More...
 
GenApi::IIntegerGevMCRC
 Description: Indicates the number of retries of the message channel. More...
 
GenApi::IBooleanGevSCPSBigEndian
 Description: Endianness of multi-byte pixel data for this stream. More...
 
GenApi::IIntegerGevNumberOfInterfaces
 Description: Indicates the number of physical network interfaces supported by this device. More...
 
GenApi::IIntegerTLParamsLocked
 Description: Visibility: More...
 
GenApi::IIntegerPayloadSize
 Description: Provides the number of bytes transferred for each image or chunk on the stream channel. More...
 
GenApi::IIntegerPacketResendRequestCount
 Description: Counts the number of resend requests received from the host. More...
 
GenApi::IBooleanSharpeningEnable
 
 Description: 

Enables/disables the sharpening feature. More...

 
GenApi::IEnumerationT
< BlackLevelSelectorEnums > & 
BlackLevelSelector
 
 Description: 

Selects which black level to control. More...

 
GenApi::IBooleanGammaEnable
 Description: Enables/disables gamma correction. More...
 
GenApi::IBooleanSharpeningAuto
 
 Description: 

Enables/disables the auto sharpening feature. More...

 
GenApi::IBooleanBlackLevelClampingEnable
 
 Description: 

Enable the black level auto clamping feature which performing dark current compensation. More...

 
GenApi::IFloatBalanceRatio
 
 Description: 

Controls the balance ratio of the selected color relative to green. More...

 
GenApi::IEnumerationT
< BalanceWhiteAutoEnums > & 
BalanceWhiteAuto
 
 Description: 

White Balance compensates for color shifts caused by different lighting conditions. More...

 
GenApi::IFloatSharpeningThreshold
 
 Description: 

Controls the minimum intensity gradient change to invoke sharpening. More...

 
GenApi::IEnumerationT
< GainAutoEnums > & 
GainAuto
 
 Description: 

Sets the automatic gain mode. More...

 
GenApi::IFloatSharpening
 
 Description: 

Controls the amount to sharpen a signal. More...

 
GenApi::IFloatGain
 
 Description: 

Controls the amplification of the video signal in dB. More...

 
GenApi::IEnumerationT
< BalanceRatioSelectorEnums > & 
BalanceRatioSelector
 
 Description: 

Selects a balance ratio to configure once a balance ratio control has been selected. More...

 
GenApi::IEnumerationT
< GainSelectorEnums > & 
GainSelector
 Description: Selects which gain to control. More...
 
GenApi::IFloatBlackLevel
 
 Description: 

Controls the offset of the video signal in percent. More...

 
GenApi::IIntegerBlackLevelRaw
 
 Description: 

Controls the offset of the video signal in camera specific units. More...

 
GenApi::IFloatGamma
 Description: Controls the gamma correction of pixel intensity. More...
 
GenApi::IIntegerDefectTableIndex
 
 Description: 

Controls the offset of the element to access in the defective pixel location table. More...

 
GenApi::ICommandDefectTableFactoryRestore
 Description: Restores the Defective Pixel Table to its factory default state, which was calibrated during manufacturing. More...
 
GenApi::IIntegerDefectTableCoordinateY
 
 Description: 

Returns the Y coordinate of the defective pixel at DefectTableIndex within the defective pixel table. More...

 
GenApi::ICommandDefectTableSave
 Description: Saves the current defective pixel table non-volatile memory, so that it is preserved when the camera boots up. More...
 
GenApi::IEnumerationT
< DefectCorrectionModeEnums > & 
DefectCorrectionMode
 Description: Controls the method used for replacing defective pixels. More...
 
GenApi::IIntegerDefectTableCoordinateX
 
 Description: 

Returns the X coordinate of the defective pixel at DefectTableIndex within the defective pixel table. More...

 
GenApi::IIntegerDefectTablePixelCount
 
 Description: 

The number of defective pixel locations in the current table. More...

 
GenApi::IBooleanDefectCorrectStaticEnable
 Description: Enables/Disables table-based defective pixel correction. More...
 
GenApi::ICommandDefectTableApply
 Description: Applies the current defect table, so that any changes made affect images captured by the camera. More...
 
GenApi::IBooleanUserSetFeatureEnable
 Description: Whether or not the selected feature is saved to user sets. More...
 
GenApi::ICommandUserSetSave
 
 Description: 

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

 
GenApi::IEnumerationT
< UserSetSelectorEnums > & 
UserSetSelector
 
 Description: 

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

 
GenApi::ICommandUserSetLoad
 
 Description: 

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

 
GenApi::IEnumerationT
< UserSetDefaultEnums > & 
UserSetDefault
 
 Description: 

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

 
GenApi::IEnumerationT
< SerialPortBaudRateEnums > & 
SerialPortBaudRate
 Description: This feature controls the baud rate used by the selected serial port. More...
 
GenApi::IIntegerSerialPortDataBits
 Description: This feature controls the number of data bits used by the selected serial port. More...
 
GenApi::IEnumerationT
< SerialPortParityEnums > & 
SerialPortParity
 Description: This feature controls the parity used by the selected serial port. More...
 
GenApi::IIntegerSerialTransmitQueueMaxCharacterCount
 Description: >Returns the maximum number of characters in the serial port transmit queue. More...
 
GenApi::IIntegerSerialReceiveQueueCurrentCharacterCount
 Description: Returns the number of characters currently in the serial port receive queue. More...
 
GenApi::IEnumerationT
< SerialPortSelectorEnums > & 
SerialPortSelector
 Description: Selects which serial port of the device to control. More...
 
GenApi::IEnumerationT
< SerialPortStopBitsEnums > & 
SerialPortStopBits
 Description: This feature controls the number of stop bits used by the selected serial port. More...
 
GenApi::ICommandSerialReceiveQueueClear
 Description: This is a command that clears the device serial port receive queue. More...
 
GenApi::IIntegerSerialReceiveFramingErrorCount
 Description: Returns the number of framing errors that have occurred on the serial port. More...
 
GenApi::IIntegerSerialTransmitQueueCurrentCharacterCount
 Description: Returns the number of characters currently in the serial port transmit queue. More...
 
GenApi::IIntegerSerialReceiveParityErrorCount
 Description: Returns the number of parity errors that have occurred on the serial port. More...
 
GenApi::IEnumerationT
< SerialPortSourceEnums > & 
SerialPortSource
 Description: Specifies the physical input Line on which to receive serial data. More...
 
GenApi::IIntegerSerialReceiveQueueMaxCharacterCount
 Description: >Returns the maximum number of characters in the serial port receive queue. More...
 
GenApi::IIntegerSequencerSetStart
 Description: Sets the first sequencer set to be used. More...
 
GenApi::IEnumerationT
< SequencerModeEnums > & 
SequencerMode
 Description: Controls whether or not a sequencer is active. More...
 
GenApi::IEnumerationT
< SequencerConfigurationValidEnums > & 
SequencerConfigurationValid
 
 Description: 

Display whether the current sequencer configuration is valid to run. More...

 
GenApi::IEnumerationT
< SequencerSetValidEnums > & 
SequencerSetValid
 
 Description: 

Displays whether the currently selected sequencer set's register contents are valid to use. More...

 
GenApi::IIntegerSequencerSetSelector
 
 Description: 

Selects the sequencer set to which subsequent settings apply. More...

 
GenApi::IEnumerationT
< SequencerTriggerActivationEnums > & 
SequencerTriggerActivation
 
 Description: 

Specifies the activation mode of the sequencer trigger. More...

 
GenApi::IEnumerationT
< SequencerConfigurationModeEnums > & 
SequencerConfigurationMode
 
 Description: 

Controls whether or not a sequencer is in configuration mode. More...

 
GenApi::ICommandSequencerSetSave
 
 Description: 

Saves the current device configuration to the currently selected sequencer set. More...

 
GenApi::IEnumerationT
< SequencerTriggerSourceEnums > & 
SequencerTriggerSource
 
 Description: 

Specifies the internal signal or physical input line to use as the sequencer trigger source. More...

 
GenApi::IIntegerSequencerSetActive
 Description: Displays the currently active sequencer set. More...
 
GenApi::IIntegerSequencerSetNext
 Description: Specifies the next sequencer set. More...
 
GenApi::ICommandSequencerSetLoad
 
 Description: 

Loads currently selected sequencer to the current device configuration. More...

 
GenApi::IIntegerSequencerPathSelector
 
 Description: 

Selects branching path to be used for subsequent settings. More...

 
GenApi::IBooleanSequencerFeatureEnable
 
 Description: 

Enables the selected feature and makes it active in all sequencer sets. More...

 
GenApi::IIntegerTransferBlockCount
 Description: Specifies the number of data blocks (images) that the device should stream before stopping. More...
 
GenApi::ICommandTransferStart
 Description: Starts the streaming of data blocks (images) out of the device. More...
 
GenApi::IIntegerTransferQueueMaxBlockCount
 Description: Returns the maximum number of data blocks (images) in the transfer queue Visibility: More...
 
GenApi::IIntegerTransferQueueCurrentBlockCount
 Description: Returns number of data blocks (images) currently in the transfer queue. More...
 
GenApi::IEnumerationT
< TransferQueueModeEnums > & 
TransferQueueMode
 Description: Specifies the operation mode of the transfer queue. More...
 
GenApi::IEnumerationT
< TransferOperationModeEnums > & 
TransferOperationMode
 Description: Selects the operation mode of the transfer. More...
 
GenApi::ICommandTransferStop
 Description: Stops the streaming of data block (images). More...
 
GenApi::IIntegerTransferQueueOverflowCount
 Description: Returns number of images that have been lost before being transmitted because the transmit queue hasn't been cleared fast enough. More...
 
GenApi::IEnumerationT
< TransferControlModeEnums > & 
TransferControlMode
 Description: Selects the control method for the transfers. More...
 
GenApi::IFloatChunkBlackLevel
 Description: Returns the black level used to capture the image. More...
 
GenApi::IIntegerChunkFrameID
 Description: Returns the image frame ID. More...
 
GenApi::IStringChunkSerialData
 Description: Returns the serial data that was received. More...
 
GenApi::IFloatChunkExposureTime
 Description: Returns the exposure time used to capture the image. More...
 
GenApi::IIntegerChunkCompressionMode
 Description: Returns the compression mode of the last image payload. More...
 
GenApi::IFloatChunkCompressionRatio
 Description: Returns the compression ratio of the last image payload. More...
 
GenApi::IBooleanChunkSerialReceiveOverflow
 Description: Returns the status of the chunk serial receive overflow. More...
 
GenApi::IIntegerChunkTimestamp
 Description: Returns the Timestamp of the image. More...
 
GenApi::IBooleanChunkModeActive
 Description: Activates the inclusion of Chunk data in the payload of the image. More...
 
GenApi::IIntegerChunkExposureEndLineStatusAll
 Description: Returns the status of all the I/O lines at the end of exposure event. More...
 
GenApi::IEnumerationT
< ChunkGainSelectorEnums > & 
ChunkGainSelector
 Description: Selects which gain to retrieve Visibility: More...
 
GenApi::IEnumerationT
< ChunkSelectorEnums > & 
ChunkSelector
 Description: Selects which chunk data to enable or disable. More...
 
GenApi::IEnumerationT
< ChunkBlackLevelSelectorEnums > & 
ChunkBlackLevelSelector
 Description: Selects which black level to retrieve Visibility: More...
 
GenApi::IIntegerChunkWidth
 Description: Returns the width of the image included in the payload. More...
 
GenApi::IIntegerChunkImage
 Description: Returns the image payload. More...
 
GenApi::IIntegerChunkHeight
 Description: Returns the height of the image included in the payload. More...
 
GenApi::IEnumerationT
< ChunkPixelFormatEnums > & 
ChunkPixelFormat
 Description: Format of the pixel provided by the camera Visibility: More...
 
GenApi::IFloatChunkGain
 Description: Returns the gain used to capture the image. More...
 
GenApi::IIntegerChunkSequencerSetActive
 Description: Returns the index of the active set of the running sequencer included in the payload. More...
 
GenApi::IIntegerChunkCRC
 Description: Returns the CRC of the image payload. More...
 
GenApi::IIntegerChunkOffsetX
 Description: Returns the Offset X of the image included in the payload. More...
 
GenApi::IIntegerChunkOffsetY
 Description: Returns the Offset Y of the image included in the payload. More...
 
GenApi::IBooleanChunkEnable
 Description: Enables the inclusion of the selected Chunk data in the payload of the image. More...
 
GenApi::IIntegerChunkSerialDataLength
 Description: Returns the length of the received serial data that was included in the payload. More...
 
GenApi::IIntegerFileAccessOffset
 Description: Controls the Offset of the mapping between the device file storage and the FileAccessBuffer. More...
 
GenApi::IIntegerFileAccessLength
 Description: Controls the Length of the mapping between the device file storage and the FileAccessBuffer. More...
 
GenApi::IEnumerationT
< FileOperationStatusEnums > & 
FileOperationStatus
 Description: Represents the file operation execution status. More...
 
GenApi::ICommandFileOperationExecute
 
 Description: 

This is a command that executes the selected file operation on the selected file. More...

 
GenApi::IEnumerationT
< FileOpenModeEnums > & 
FileOpenMode
 
 Description: 

The mode of the file when it is opened. More...

 
GenApi::IIntegerFileOperationResult
 Description: Represents the file operation result. More...
 
GenApi::IEnumerationT
< FileOperationSelectorEnums > & 
FileOperationSelector
 
 Description: 

Sets operation to execute on the selected file when the execute command is given. More...

 
GenApi::IEnumerationT
< FileSelectorEnums > & 
FileSelector
 
 Description: 

Selects which file is being operated on. More...

 
GenApi::IIntegerFileSize
 Description: Represents the size of the selected file in bytes. More...
 
GenApi::IEnumerationT
< BinningSelectorEnums > & 
BinningSelector
 
 Description: 

Selects which binning engine is controlled by the BinningHorizontal and BinningVertical features. More...

 
GenApi::IIntegerPixelDynamicRangeMin
 Description: Minimum value that can be returned during the digitization process. More...
 
GenApi::IIntegerPixelDynamicRangeMax
 Description: Maximum value that can be returned during the digitization process. More...
 
GenApi::IIntegerOffsetY
 
 Description: 

Vertical offset from the origin to the ROI (in pixels). More...

 
GenApi::IIntegerBinningHorizontal
 
 Description: 

Number of horizontal photo-sensitive cells to combine together. More...

 
GenApi::IIntegerWidth
 
 Description: 

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

 
GenApi::IEnumerationT
< TestPatternGeneratorSelectorEnums > & 
TestPatternGeneratorSelector
 
 Description: 

Selects which test pattern generator is controlled by the TestPattern feature. More...

 
GenApi::IFloatCompressionRatio
 Description: Reports the ratio between the uncompressed image size and compressed image size. More...
 
GenApi::IEnumerationT
< CompressionSaturationPriorityEnums > & 
CompressionSaturationPriority
 Description: When FrameRate is enabled, camera drops frames if datarate is saturated. More...
 
GenApi::IBooleanReverseX
 Description: Horizontally flips the image sent by the device. More...
 
GenApi::IBooleanReverseY
 Description: Vertically flips the image sent by the device. More...
 
GenApi::IEnumerationT
< TestPatternEnums > & 
TestPattern
 
 Description: 

Selects the type of test pattern that is generated by the device as image source. More...

 
GenApi::IEnumerationT
< PixelColorFilterEnums > & 
PixelColorFilter
 Description: Type of color filter that is applied to the image. More...
 
GenApi::IIntegerWidthMax
 
 Description: 

Maximum width of the image (in pixels). More...

 
GenApi::IEnumerationT
< AdcBitDepthEnums > & 
AdcBitDepth
 
 Description: 

Selects which ADC bit depth to use. More...

 
GenApi::IIntegerBinningVertical
 
 Description: 

Number of vertical photo-sensitive cells to combine together. More...

 
GenApi::IEnumerationT
< DecimationHorizontalModeEnums > & 
DecimationHorizontalMode
 
 Description: 

The mode used to reduce the horizontal resolution when DecimationHorizontal is used. More...

 
GenApi::IEnumerationT
< BinningVerticalModeEnums > & 
BinningVerticalMode
 Description: Visibility: More...
 
GenApi::IIntegerOffsetX
 
 Description: 

Horizontal offset from the origin to the ROI (in pixels). More...

 
GenApi::IIntegerHeightMax
 Description: Maximum height of the image (in pixels). More...
 
GenApi::IIntegerDecimationHorizontal
 
 Description: 

Horizontal decimation of the image. More...

 
GenApi::IEnumerationT
< PixelSizeEnums > & 
PixelSize
 Description: Total size in bits of a pixel of the image. More...
 
GenApi::IIntegerSensorHeight
 Description: Effective height of the sensor in pixels. More...
 
GenApi::IEnumerationT
< DecimationSelectorEnums > & 
DecimationSelector
 Description: Selects which decimation layer is controlled by the DecimationHorizontal and DecimationVertical features. More...
 
GenApi::IBooleanIspEnable
 
 Description: 

Controls whether the image processing core is used for optional pixel format mode (i.e. More...

 
GenApi::IBooleanAdaptiveCompressionEnable
 Description: Controls whether lossless compression adapts to the image content. More...
 
GenApi::IEnumerationT
< ImageCompressionModeEnums > & 
ImageCompressionMode
 Description: Visibility: More...
 
GenApi::IIntegerDecimationVertical
 
 Description: 

Vertical decimation of the image. More...

 
GenApi::IIntegerHeight
 
 Description: 

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

 
GenApi::IEnumerationT
< BinningHorizontalModeEnums > & 
BinningHorizontalMode
 Description: Visibility: More...
 
GenApi::IEnumerationT
< PixelFormatEnums > & 
PixelFormat
 Description: Format of the pixel provided by the camera. More...
 
GenApi::IIntegerSensorWidth
 Description: Effective width of the sensor in pixels. More...
 
GenApi::IEnumerationT
< DecimationVerticalModeEnums > & 
DecimationVerticalMode
 
 Description: 

The mode used to reduce the vertical resolution when DecimationVertical is used. More...

 
GenApi::ICommandTestEventGenerate
 Description: This command generates a test event and sends it to the host. More...
 
GenApi::ICommandTriggerEventTest
 Description: This command generates a test event and sends it to the host. More...
 
GenApi::IIntegerGuiXmlManifestAddress
 Description: Location of the GUI XML manifest table. More...
 
GenApi::IIntegerTest0001
 Description: For testing only. More...
 
GenApi::IBooleanV3_3Enable
 Description: Internally generated 3.3V rail. More...
 
GenApi::IEnumerationT
< LineModeEnums > & 
LineMode
 Description: Controls if the physical Line is used to Input or Output a signal. More...
 
GenApi::IEnumerationT
< LineSourceEnums > & 
LineSource
 Description: Selects which internal acquisition or I/O source signal to output on the selected line. More...
 
GenApi::IEnumerationT
< LineInputFilterSelectorEnums > & 
LineInputFilterSelector
 Description: Selects the kind of input filter to configure: Deglitch or Debounce. More...
 
GenApi::IBooleanUserOutputValue
 Description: Value of the selected user output, either logic high (enabled) or logic low (disabled). More...
 
GenApi::IIntegerUserOutputValueAll
 Description: Returns the current status of all the user output status bits in a hexadecimal representation (UserOutput 0 status corresponds to bit 0, UserOutput 1 status with bit 1, etc). More...
 
GenApi::IEnumerationT
< UserOutputSelectorEnums > & 
UserOutputSelector
 Description: Selects which bit of the User Output register is set by UserOutputValue. More...
 
GenApi::IBooleanLineStatus
 Description: Returns the current status of the selected input or output Line Visibility: More...
 
GenApi::IEnumerationT
< LineFormatEnums > & 
LineFormat
 Description: Displays the current electrical format of the selected physical input or output Line. More...
 
GenApi::IIntegerLineStatusAll
 Description: Returns the current status of all the line status bits in a hexadecimal representation (Line 0 status corresponds to bit 0, Line 1 status with bit 1, etc). More...
 
GenApi::IEnumerationT
< LineSelectorEnums > & 
LineSelector
 Description: Selects the physical line (or pin) of the external device connector to configure Visibility: More...
 
GenApi::IEnumerationT
< ExposureActiveModeEnums > & 
ExposureActiveMode
 Description: Control sensor active exposure mode. More...
 
GenApi::IBooleanLineInverter
 Description: Controls the inversion of the signal of the selected input or output line. More...
 
GenApi::IFloatLineFilterWidth
 Description: Filter width in microseconds for the selected line and filter combination Visibility: More...
 
GenApi::IEnumerationT
< CounterTriggerActivationEnums > & 
CounterTriggerActivation
 Description: Selects the activation mode of the trigger to start the counter. More...
 
GenApi::IIntegerCounterValue
 Description: Current counter value Visibility: More...
 
GenApi::IEnumerationT
< CounterSelectorEnums > & 
CounterSelector
 Description: Selects which counter to configure Visibility: More...
 
GenApi::IIntegerCounterValueAtReset
 Description: Value of the selected Counter when it was reset by a trigger. More...
 
GenApi::IEnumerationT
< CounterStatusEnums > & 
CounterStatus
 Description: Returns the current status of the counter. More...
 
GenApi::IEnumerationT
< CounterTriggerSourceEnums > & 
CounterTriggerSource
 Description: Selects the source of the trigger to start the counter Visibility: More...
 
GenApi::IIntegerCounterDelay
 Description: Sets the delay (or number of events) before the CounterStart event is generated. More...
 
GenApi::IEnumerationT
< CounterResetSourceEnums > & 
CounterResetSource
 Description: Selects the signal that will be the source to reset the counter. More...
 
GenApi::IEnumerationT
< CounterEventSourceEnums > & 
CounterEventSource
 Description: Selects the event that will increment the counter Visibility: More...
 
GenApi::IEnumerationT
< CounterEventActivationEnums > & 
CounterEventActivation
 Description: Selects the activation mode of the event to increment the Counter. More...
 
GenApi::IIntegerCounterDuration
 Description: Sets the duration (or number of events) before the CounterEnd event is generated. More...
 
GenApi::IEnumerationT
< CounterResetActivationEnums > & 
CounterResetActivation
 Description: Selects the Activation mode of the Counter Reset Source signal. More...
 
GenApi::IEnumerationT
< DeviceTypeEnums > & 
DeviceType
 Description: Returns the device type. More...
 
GenApi::IStringDeviceFamilyName
 Description: Identifier of the product family of the device. More...
 
GenApi::IIntegerDeviceSFNCVersionMajor
 Description: Major version of the Standard Features Naming Convention that was used to create the device's GenICam XML. More...
 
GenApi::IIntegerDeviceSFNCVersionMinor
 Description: Minor version of the Standard Features Naming Convention that was used to create the device's GenICam XML. More...
 
GenApi::IIntegerDeviceSFNCVersionSubMinor
 Description: Sub minor version of Standard Features Naming Convention that was used to create the device's GenICam XML. More...
 
GenApi::IIntegerDeviceManifestEntrySelector
 Description: Selects the manifest entry to reference. More...
 
GenApi::IIntegerDeviceManifestXMLMajorVersion
 Description: Indicates the major version number of the GenICam XML file of the selected manifest entry. More...
 
GenApi::IIntegerDeviceManifestXMLMinorVersion
 Description: Indicates the minor version number of the GenICam XML file of the selected manifest entry. More...
 
GenApi::IIntegerDeviceManifestXMLSubMinorVersion
 Description: Indicates the subminor version number of the GenICam XML file of the selected manifest entry. More...
 
GenApi::IIntegerDeviceManifestSchemaMajorVersion
 Description: Indicates the major version number of the schema file of the selected manifest entry. More...
 
GenApi::IIntegerDeviceManifestSchemaMinorVersion
 Description: Indicates the minor version number of the schema file of the selected manifest entry. More...
 
GenApi::IStringDeviceManifestPrimaryURL
 Description: Indicates the first URL to the GenICam XML device description file of the selected manifest entry. More...
 
GenApi::IStringDeviceManifestSecondaryURL
 Description: Indicates the second URL to the GenICam XML device description file of the selected manifest entry. More...
 
GenApi::IIntegerDeviceTLVersionSubMinor
 Description: Sub minor version of the Transport Layer of the device. More...
 
GenApi::IIntegerDeviceGenCPVersionMajor
 Description: Major version of the GenCP protocol supported by the device. More...
 
GenApi::IIntegerDeviceGenCPVersionMinor
 Description: Minor version of the GenCP protocol supported by the device. More...
 
GenApi::IIntegerDeviceConnectionSelector
 Description: Selects which Connection of the device to control. More...
 
GenApi::IIntegerDeviceConnectionSpeed
 Description: Indicates the speed of transmission of the specified Connection Visibility: Expert. More...
 
GenApi::IEnumerationT
< DeviceConnectionStatusEnums > & 
DeviceConnectionStatus
 Description: Indicates the status of the specified Connection. More...
 
GenApi::IIntegerDeviceLinkSelector
 Description: Selects which Link of the device to control. More...
 
GenApi::IEnumerationT
< DeviceLinkThroughputLimitModeEnums > & 
DeviceLinkThroughputLimitMode
 Description: Controls if the DeviceLinkThroughputLimit is active. More...
 
GenApi::IIntegerDeviceLinkConnectionCount
 Description: Returns the number of physical connection of the device used by a particular Link. More...
 
GenApi::IEnumerationT
< DeviceLinkHeartbeatModeEnums > & 
DeviceLinkHeartbeatMode
 Description: Activate or deactivate the Link's heartbeat. More...
 
GenApi::IFloatDeviceLinkHeartbeatTimeout
 Description: Controls the current heartbeat timeout of the specific Link. More...
 
GenApi::IFloatDeviceLinkCommandTimeout
 Description: Indicates the command timeout of the specified Link. More...
 
GenApi::IIntegerDeviceStreamChannelSelector
 Description: Selects the stream channel to control. More...
 
GenApi::IEnumerationT
< DeviceStreamChannelTypeEnums > & 
DeviceStreamChannelType
 Description: Reports the type of the stream channel. More...
 
GenApi::IIntegerDeviceStreamChannelLink
 Description: Index of device's Link to use for streaming the specifed stream channel. More...
 
GenApi::IEnumerationT
< DeviceStreamChannelEndiannessEnums > & 
DeviceStreamChannelEndianness
 Description: Endianness of multi-byte pixel data for this stream. More...
 
GenApi::IIntegerDeviceStreamChannelPacketSize
 Description: Specifies the stream packet size, in bytes, to send on the selected channel for a Transmitter or specifies the maximum packet size supported by a receiver. More...
 
GenApi::ICommandDeviceFeaturePersistenceStart
 Description: Indicate to the device and GenICam XML to get ready for persisting of all streamable features. More...
 
GenApi::ICommandDeviceFeaturePersistenceEnd
 Description: Indicate to the device the end of feature persistence. More...
 
GenApi::ICommandDeviceRegistersStreamingStart
 Description: Prepare the device for registers streaming without checking for consistency. More...
 
GenApi::ICommandDeviceRegistersStreamingEnd
 Description: Announce the end of registers streaming. More...
 
GenApi::ICommandDeviceRegistersCheck
 Description: Perform the validation of the current register set for consistency. More...
 
GenApi::IBooleanDeviceRegistersValid
 Description: Returns if the current register set is valid and consistent. More...
 
GenApi::IEnumerationT
< DeviceClockSelectorEnums > & 
DeviceClockSelector
 Description: Selects the clock frequency to access from the device. More...
 
GenApi::IFloatDeviceClockFrequency
 Description: Returns the frequency of the selected Clock. More...
 
GenApi::IEnumerationT
< DeviceSerialPortSelectorEnums > & 
DeviceSerialPortSelector
 Description: Selects which serial port of the device to control. More...
 
GenApi::IEnumerationT
< DeviceSerialPortBaudRateEnums > & 
DeviceSerialPortBaudRate
 Description: This feature controls the baud rate used by the selected serial port. More...
 
GenApi::IIntegerTimestamp
 Description: Reports the current value of the device timestamp counter. More...
 
GenApi::IEnumerationT
< SensorTapsEnums > & 
SensorTaps
 Description: Number of taps of the camera sensor. More...
 
GenApi::IEnumerationT
< SensorDigitizationTapsEnums > & 
SensorDigitizationTaps
 Description: Number of digitized samples outputted simultaneously by the camera A/D conversion stage. More...
 
GenApi::IEnumerationT
< RegionSelectorEnums > & 
RegionSelector
 Description: Selects the Region of interest to control. More...
 
GenApi::IEnumerationT
< RegionModeEnums > & 
RegionMode
 Description: Controls if the selected Region of interest is active and streaming. More...
 
GenApi::IEnumerationT
< RegionDestinationEnums > & 
RegionDestination
 Description: Control the destination of the selected region. More...
 
GenApi::IEnumerationT
< ImageComponentSelectorEnums > & 
ImageComponentSelector
 Description: Selects a component to activate data streaming from. More...
 
GenApi::IBooleanImageComponentEnable
 Description: Controls if the selected component streaming is active. More...
 
GenApi::IIntegerLinePitch
 Description: Total number of bytes between 2 successive lines. More...
 
GenApi::IEnumerationT
< PixelFormatInfoSelectorEnums > & 
PixelFormatInfoSelector
 Description: Select the pixel format for which the information will be returned. More...
 
GenApi::IIntegerPixelFormatInfoID
 Description: Returns the value used by the streaming channels to identify the selected pixel format. More...
 
GenApi::IEnumerationT
< DeinterlacingEnums > & 
Deinterlacing
 Description: Controls how the device performs de-interlacing. More...
 
GenApi::IEnumerationT
< ImageCompressionRateOptionEnums > & 
ImageCompressionRateOption
 Description: Two rate controlling options are offered: fixed bit rate or fixed quality. More...
 
GenApi::IIntegerImageCompressionQuality
 Description: Control the quality of the produced compressed stream. More...
 
GenApi::IFloatImageCompressionBitrate
 Description: Control the rate of the produced compressed stream. More...
 
GenApi::IEnumerationT
< ImageCompressionJPEGFormatOptionEnums > & 
ImageCompressionJPEGFormatOption
 Description: When JPEG is selected as the compression format, a device might optionally offer better control over JPEG-specific options through this feature. More...
 
GenApi::ICommandAcquisitionAbort
 Description: Aborts the Acquisition immediately. More...
 
GenApi::ICommandAcquisitionArm
 Description: Arms the device before an AcquisitionStart command. More...
 
GenApi::IEnumerationT
< AcquisitionStatusSelectorEnums > & 
AcquisitionStatusSelector
 Description: Selects the internal acquisition signal to read using AcquisitionStatus. More...
 
GenApi::IBooleanAcquisitionStatus
 Description: Reads the state of the internal acquisition signal selected using AcquisitionStatusSelector. More...
 
GenApi::IIntegerTriggerDivider
 Description: Specifies a division factor for the incoming trigger pulses. More...
 
GenApi::IIntegerTriggerMultiplier
 Description: Specifies a multiplication factor for the incoming trigger pulses. More...
 
GenApi::IEnumerationT
< ExposureTimeModeEnums > & 
ExposureTimeMode
 Description: Sets the configuration mode of the ExposureTime feature. More...
 
GenApi::IEnumerationT
< ExposureTimeSelectorEnums > & 
ExposureTimeSelector
 Description: Selects which exposure time is controlled by the ExposureTime feature. More...
 
GenApi::IEnumerationT
< GainAutoBalanceEnums > & 
GainAutoBalance
 Description: Sets the mode for automatic gain balancing between the sensor color channels or taps. More...
 
GenApi::IEnumerationT
< BlackLevelAutoEnums > & 
BlackLevelAuto
 Description: Controls the mode for automatic black level adjustment. More...
 
GenApi::IEnumerationT
< BlackLevelAutoBalanceEnums > & 
BlackLevelAutoBalance
 Description: Controls the mode for automatic black level balancing between the sensor color channels or taps. More...
 
GenApi::IEnumerationT
< WhiteClipSelectorEnums > & 
WhiteClipSelector
 Description: Selects which White Clip to control. More...
 
GenApi::IFloatWhiteClip
 Description: Controls the maximal intensity taken by the video signal before being clipped as an absolute physical value. More...
 
GenApi::IRegisterLUTValueAll
 Description: Accesses all the LUT coefficients in a single access without using individual LUTIndex. More...
 
GenApi::IIntegerUserOutputValueAllMask
 Description: Sets the write mask to apply to the value specified by UserOutputValueAll before writing it in the User Output register. More...
 
GenApi::ICommandCounterReset
 Description: Does a software reset of the selected Counter and starts it. More...
 
GenApi::IEnumerationT
< TimerSelectorEnums > & 
TimerSelector
 Description: Selects which Timer to configure. More...
 
GenApi::IFloatTimerDuration
 Description: Sets the duration (in microseconds) of the Timer pulse. More...
 
GenApi::IFloatTimerDelay
 Description: Sets the duration (in microseconds) of the delay to apply at the reception of a trigger before starting the Timer. More...
 
GenApi::ICommandTimerReset
 Description: Does a software reset of the selected timer and starts it. More...
 
GenApi::IFloatTimerValue
 Description: Reads or writes the current value (in microseconds) of the selected Timer. More...
 
GenApi::IEnumerationT
< TimerStatusEnums > & 
TimerStatus
 Description: Returns the current status of the Timer. More...
 
GenApi::IEnumerationT
< TimerTriggerSourceEnums > & 
TimerTriggerSource
 Description: Selects the source of the trigger to start the Timer. More...
 
GenApi::IEnumerationT
< TimerTriggerActivationEnums > & 
TimerTriggerActivation
 Description: Selects the activation mode of the trigger to start the Timer. More...
 
GenApi::IEnumerationT
< EncoderSelectorEnums > & 
EncoderSelector
 Description: Selects which Encoder to configure. More...
 
GenApi::IEnumerationT
< EncoderSourceAEnums > & 
EncoderSourceA
 Description: Selects the signal which will be the source of the A input of the Encoder. More...
 
GenApi::IEnumerationT
< EncoderSourceBEnums > & 
EncoderSourceB
 Description: Selects the signal which will be the source of the B input of the Encoder. More...
 
GenApi::IEnumerationT
< EncoderModeEnums > & 
EncoderMode
 Description: Selects if the count of encoder uses FourPhase mode with jitter filtering or the HighResolution mode without jitter filtering. More...
 
GenApi::IIntegerEncoderDivider
 Description: Sets how many Encoder increment/decrements that are needed generate an Encoder output pulse signal. More...
 
GenApi::IEnumerationT
< EncoderOutputModeEnums > & 
EncoderOutputMode
 Description: Selects the conditions for the Encoder interface to generate a valid Encoder output signal. More...
 
GenApi::IEnumerationT
< EncoderStatusEnums > & 
EncoderStatus
 Description: Returns the motion status of the encoder. More...
 
GenApi::IFloatEncoderTimeout
 Description: Sets the maximum time interval between encoder counter increments before the status turns to static. More...
 
GenApi::IEnumerationT
< EncoderResetSourceEnums > & 
EncoderResetSource
 Description: Selects the signals that will be the source to reset the Encoder. More...
 
GenApi::IEnumerationT
< EncoderResetActivationEnums > & 
EncoderResetActivation
 Description: Selects the Activation mode of the Encoder Reset Source signal. More...
 
GenApi::ICommandEncoderReset
 Description: Does a software reset of the selected Encoder and starts it. More...
 
GenApi::IIntegerEncoderValue
 Description: Reads or writes the current value of the position counter of the selected Encoder. More...
 
GenApi::IIntegerEncoderValueAtReset
 Description: Reads the value of the of the position counter of the selected Encoder when it was reset by a signal or by an explicit EncoderReset command. More...
 
GenApi::IEnumerationT
< SoftwareSignalSelectorEnums > & 
SoftwareSignalSelector
 Description: Selects which Software Signal features to control. More...
 
GenApi::ICommandSoftwareSignalPulse
 Description: Generates a pulse signal that can be used as a software trigger. More...
 
GenApi::IEnumerationT
< ActionUnconditionalModeEnums > & 
ActionUnconditionalMode
 Description: Enables the unconditional action command mode where action commands are processed even when the primary control channel is closed. More...
 
GenApi::IIntegerActionDeviceKey
 Description: Provides the device key that allows the device to check the validity of action commands. More...
 
GenApi::IIntegerActionQueueSize
 Description: Indicates the size of the scheduled action commands queue. More...
 
GenApi::IIntegerActionSelector
 Description: Selects to which Action Signal further Action settings apply. More...
 
GenApi::IIntegerActionGroupMask
 Description: Provides the mask that the device will use to validate the action on reception of the action protocol message. More...
 
GenApi::IIntegerActionGroupKey
 Description: Provides the key that the device will use to validate the action on reception of the action protocol message. More...
 
GenApi::IIntegerEventAcquisitionTrigger
 Description: Returns the unique Identifier of the Acquisition Trigger type of Event. More...
 
GenApi::IIntegerEventAcquisitionTriggerTimestamp
 Description: Returns the Timestamp of the Acquisition Trigger Event. More...
 
GenApi::IIntegerEventAcquisitionTriggerFrameID
 Description: Returns the unique Identifier of the Frame (or image) that generated the Acquisition Trigger Event. More...
 
GenApi::IIntegerEventAcquisitionStart
 Description: Returns the unique Identifier of the Acquisition Start type of Event. More...
 
GenApi::IIntegerEventAcquisitionStartTimestamp
 Description: Returns the Timestamp of the Acquisition Start Event. More...
 
GenApi::IIntegerEventAcquisitionStartFrameID
 Description: Returns the unique Identifier of the Frame (or image) that generated the Acquisition Start Event. More...
 
GenApi::IIntegerEventAcquisitionEnd
 Description: Returns the unique Identifier of the Acquisition End type of Event. More...
 
GenApi::IIntegerEventAcquisitionEndTimestamp
 Description: Returns the Timestamp of the Acquisition End Event. More...
 
GenApi::IIntegerEventAcquisitionEndFrameID
 Description: Returns the unique Identifier of the Frame (or image) that generated the Acquisition End Event. More...
 
GenApi::IIntegerEventAcquisitionTransferStart
 Description: Returns the unique Identifier of the Acquisition Transfer Start type of Event. More...
 
GenApi::IIntegerEventAcquisitionTransferStartTimestamp
 Description: Returns the Timestamp of the Acquisition Transfer Start Event. More...
 
GenApi::IIntegerEventAcquisitionTransferStartFrameID
 Description: Returns the unique Identifier of the Frame (or image) that generated the Acquisition Transfer Start Event. More...
 
GenApi::IIntegerEventAcquisitionTransferEnd
 Description: Returns the unique Identifier of the Acquisition Transfer End type of Event. More...
 
GenApi::IIntegerEventAcquisitionTransferEndTimestamp
 Description: Returns the Timestamp of the Acquisition Transfer End Event. More...
 
GenApi::IIntegerEventAcquisitionTransferEndFrameID
 Description: Returns the unique Identifier of the Frame (or image) that generated the Acquisition Transfer End Event. More...
 
GenApi::IIntegerEventAcquisitionError
 Description: Returns the unique Identifier of the Acquisition Error type of Event. More...
 
GenApi::IIntegerEventAcquisitionErrorTimestamp
 Description: Returns the Timestamp of the Acquisition Error Event. More...
 
GenApi::IIntegerEventAcquisitionErrorFrameID
 Description: Returns the unique Identifier of the Frame (or image) that generated the Acquisition Error Event. More...
 
GenApi::IIntegerEventFrameTrigger
 Description: Returns the unique Identifier of the FrameTrigger type of Event. More...
 
GenApi::IIntegerEventFrameTriggerTimestamp
 Description: Returns the Timestamp of the FrameTrigger Event. More...
 
GenApi::IIntegerEventFrameTriggerFrameID
 Description: Returns the unique Identifier of the Frame (or image) that generated the FrameTrigger Event. More...
 
GenApi::IIntegerEventFrameStart
 Description: Returns the unique Identifier of the Frame Start type of Event. More...
 
GenApi::IIntegerEventFrameStartTimestamp
 Description: Returns the Timestamp of the Frame Start Event. More...
 
GenApi::IIntegerEventFrameStartFrameID
 Description: Returns the unique Identifier of the Frame (or image) that generated the Frame Start Event. More...
 
GenApi::IIntegerEventFrameEnd
 Description: Returns the unique Identifier of the Frame End type of Event. More...
 
GenApi::IIntegerEventFrameEndTimestamp
 Description: Returns the Timestamp of the Frame End Event. More...
 
GenApi::IIntegerEventFrameEndFrameID
 Description: Returns the unique Identifier of the Frame (or image) that generated the Frame End Event. More...
 
GenApi::IIntegerEventFrameBurstStart
 Description: Returns the unique Identifier of the Frame Burst Start type of Event. More...
 
GenApi::IIntegerEventFrameBurstStartTimestamp
 Description: Returns the Timestamp of the Frame Burst Start Event. More...
 
GenApi::IIntegerEventFrameBurstStartFrameID
 Description: Returns the unique Identifier of the Frame (or image) that generated the Frame Burst Start Event. More...
 
GenApi::IIntegerEventFrameBurstEnd
 Description: Returns the unique Identifier of the Frame Burst End type of Event. More...
 
GenApi::IIntegerEventFrameBurstEndTimestamp
 Description: Returns the Timestamp of the Frame Burst End Event. More...
 
GenApi::IIntegerEventFrameBurstEndFrameID
 Description: Returns the unique Identifier of the Frame (or image) that generated the Frame Burst End Event. More...
 
GenApi::IIntegerEventFrameTransferStart
 Description: Returns the unique Identifier of the Frame Transfer Start type of Event. More...
 
GenApi::IIntegerEventFrameTransferStartTimestamp
 Description: Returns the Timestamp of the Frame Transfer Start Event. More...
 
GenApi::IIntegerEventFrameTransferStartFrameID
 Description: Returns the unique Identifier of the Frame (or image) that generated the Frame Transfer Start Event. More...
 
GenApi::IIntegerEventFrameTransferEnd
 Description: Returns the unique Identifier of the Frame Transfer End type of Event. More...
 
GenApi::IIntegerEventFrameTransferEndTimestamp
 Description: Returns the Timestamp of the Frame Transfer End Event. More...
 
GenApi::IIntegerEventFrameTransferEndFrameID
 Description: Returns the unique Identifier of the Frame (or image) that generated the Frame Transfer End Event. More...
 
GenApi::IIntegerEventExposureStart
 Description: Returns the unique Identifier of the Exposure Start type of Event. More...
 
GenApi::IIntegerEventExposureStartTimestamp
 Description: Returns the Timestamp of the Exposure Start Event. More...
 
GenApi::IIntegerEventExposureStartFrameID
 Description: Returns the unique Identifier of the Frame (or image) that generated the Exposure Start Event. More...
 
GenApi::IIntegerEventStream0TransferStart
 Description: Returns the unique Identifier of the Stream 0 Transfer Start type of Event. More...
 
GenApi::IIntegerEventStream0TransferStartTimestamp
 Description: Returns the Timestamp of the Stream 0 Transfer Start Event. More...
 
GenApi::IIntegerEventStream0TransferStartFrameID
 Description: Returns the unique Identifier of the Frame (or image) that generated the Stream 0 Transfer Start Event. More...
 
GenApi::IIntegerEventStream0TransferEnd
 Description: Returns the unique Identifier of the Stream 0 Transfer End type of Event. More...
 
GenApi::IIntegerEventStream0TransferEndTimestamp
 Description: Returns the Timestamp of the Stream 0 Transfer End Event. More...
 
GenApi::IIntegerEventStream0TransferEndFrameID
 Description: Returns the unique Identifier of the Frame (or image) that generated the Stream 0 Transfer End Event. More...
 
GenApi::IIntegerEventStream0TransferPause
 Description: Returns the unique Identifier of the Stream 0 Transfer Pause type of Event. More...
 
GenApi::IIntegerEventStream0TransferPauseTimestamp
 Description: Returns the Timestamp of the Stream 0 Transfer Pause Event. More...
 
GenApi::IIntegerEventStream0TransferPauseFrameID
 Description: Returns the unique Identifier of the Frame (or image) that generated the Stream 0 Transfer Pause Event. More...
 
GenApi::IIntegerEventStream0TransferResume
 Description: Returns the unique Identifier of the Stream 0 Transfer Resume type of Event. More...
 
GenApi::IIntegerEventStream0TransferResumeTimestamp
 Description: Returns the Timestamp of the Stream 0 Transfer Resume Event. More...
 
GenApi::IIntegerEventStream0TransferResumeFrameID
 Description: Returns the unique Identifier of the Frame (or image) that generated the Stream 0 Transfer Resume Event. More...
 
GenApi::IIntegerEventStream0TransferBlockStart
 Description: Returns the unique Identifier of the Stream 0 Transfer Block Start type of Event. More...
 
GenApi::IIntegerEventStream0TransferBlockStartTimestamp
 Description: Returns the Timestamp of the Stream 0 Transfer Block Start Event. More...
 
GenApi::IIntegerEventStream0TransferBlockStartFrameID
 Description: Returns the unique Identifier of the Frame (or image) that generated the Stream 0 Transfer Block Start Event. More...
 
GenApi::IIntegerEventStream0TransferBlockEnd
 Description: Returns the unique Identifier of the Stream 0 Transfer Block End type of Event. More...
 
GenApi::IIntegerEventStream0TransferBlockEndTimestamp
 Description: Returns the Timestamp of the Stream 0 Transfer Block End Event. More...
 
GenApi::IIntegerEventStream0TransferBlockEndFrameID
 Description: Returns the unique Identifier of the Frame (or image) that generated the Stream 0 Transfer Block End Event. More...
 
GenApi::IIntegerEventStream0TransferBlockTrigger
 Description: Returns the unique Identifier of the Stream 0 Transfer Block Trigger type of Event. More...
 
GenApi::IIntegerEventStream0TransferBlockTriggerTimestamp
 Description: Returns the Timestamp of the Stream 0 Transfer Block Trigger Event. More...
 
GenApi::IIntegerEventStream0TransferBlockTriggerFrameID
 Description: Returns the unique Identifier of the Frame (or image) that generated the Stream 0 Transfer Block Trigger Event. More...
 
GenApi::IIntegerEventStream0TransferBurstStart
 Description: Returns the unique Identifier of the Stream 0 Transfer Burst Start type of Event. More...
 
GenApi::IIntegerEventStream0TransferBurstStartTimestamp
 Description: Returns the Timestamp of the Stream 0 Transfer Burst Start Event. More...
 
GenApi::IIntegerEventStream0TransferBurstStartFrameID
 Description: Returns the unique Identifier of the Frame (or image) that generated the Stream 0 Transfer Burst Start Event. More...
 
GenApi::IIntegerEventStream0TransferBurstEnd
 Description: Returns the unique Identifier of the Stream 0 Transfer Burst End type of Event. More...
 
GenApi::IIntegerEventStream0TransferBurstEndTimestamp
 Description: Returns the Timestamp of the Stream 0 Transfer Burst End Event. More...
 
GenApi::IIntegerEventStream0TransferBurstEndFrameID
 Description: Returns the unique Identifier of the Frame (or image) that generated the Stream 0 Transfer Burst End Event. More...
 
GenApi::IIntegerEventStream0TransferOverflow
 Description: Returns the unique Identifier of the Stream 0 Transfer Overflow type of Event. More...
 
GenApi::IIntegerEventStream0TransferOverflowTimestamp
 Description: Returns the Timestamp of the Stream 0 Transfer Overflow Event. More...
 
GenApi::IIntegerEventStream0TransferOverflowFrameID
 Description: Returns the unique Identifier of the Frame (or image) that generated the Stream 0 Transfer Overflow Event. More...
 
GenApi::IIntegerEventSequencerSetChange
 Description: Returns the unique Identifier of the Sequencer Set Change type of Event. More...
 
GenApi::IIntegerEventSequencerSetChangeTimestamp
 Description: Returns the Timestamp of the Sequencer Set Change Event. More...
 
GenApi::IIntegerEventSequencerSetChangeFrameID
 Description: Returns the unique Identifier of the Frame (or image) that generated the Sequencer Set Change Event. More...
 
GenApi::IIntegerEventCounter0Start
 Description: Returns the unique Identifier of the Counter 0 Start type of Event. More...
 
GenApi::IIntegerEventCounter0StartTimestamp
 Description: Returns the Timestamp of the Counter 0 Start Event. More...
 
GenApi::IIntegerEventCounter0StartFrameID
 Description: Returns the unique Identifier of the Frame (or image) that generated the Counter 0 Start Event. More...
 
GenApi::IIntegerEventCounter1Start
 Description: Returns the unique Identifier of the Counter 1 Start type of Event. More...
 
GenApi::IIntegerEventCounter1StartTimestamp
 Description: Returns the Timestamp of the Counter 1 Start Event. More...
 
GenApi::IIntegerEventCounter1StartFrameID
 Description: Returns the unique Identifier of the Frame (or image) that generated the Counter 1 Start Event. More...
 
GenApi::IIntegerEventCounter0End
 Description: Returns the unique Identifier of the Counter 0 End type of Event. More...
 
GenApi::IIntegerEventCounter0EndTimestamp
 Description: Returns the Timestamp of the Counter 0 End Event. More...
 
GenApi::IIntegerEventCounter0EndFrameID
 Description: Returns the unique Identifier of the Frame (or image) that generated the Counter 0 End Event. More...
 
GenApi::IIntegerEventCounter1End
 Description: Returns the unique Identifier of the Counter 1 End type of Event. More...
 
GenApi::IIntegerEventCounter1EndTimestamp
 Description: Returns the Timestamp of the Counter 1 End Event. More...
 
GenApi::IIntegerEventCounter1EndFrameID
 Description: Returns the unique Identifier of the Frame (or image) that generated the Counter 1 End Event. More...
 
GenApi::IIntegerEventTimer0Start
 Description: Returns the unique Identifier of the Timer 0 Start type of Event. More...
 
GenApi::IIntegerEventTimer0StartTimestamp
 Description: Returns the Timestamp of the Timer 0 Start Event. More...
 
GenApi::IIntegerEventTimer0StartFrameID
 Description: Returns the unique Identifier of the Frame (or image) that generated the Timer 0 Start Event. More...
 
GenApi::IIntegerEventTimer1Start
 Description: Returns the unique Identifier of the Timer 1 Start type of Event. More...
 
GenApi::IIntegerEventTimer1StartTimestamp
 Description: Returns the Timestamp of the Timer 1 Start Event. More...
 
GenApi::IIntegerEventTimer1StartFrameID
 Description: Returns the unique Identifier of the Frame (or image) that generated the Timer 1 Start Event. More...
 
GenApi::IIntegerEventTimer0End
 Description: Returns the unique Identifier of the Timer 0 End type of Event. More...
 
GenApi::IIntegerEventTimer0EndTimestamp
 Description: Returns the Timestamp of the Timer 0 End Event. More...
 
GenApi::IIntegerEventTimer0EndFrameID
 Description: Returns the unique Identifier of the Frame (or image) that generated the Timer 0 End Event. More...
 
GenApi::IIntegerEventTimer1End
 Description: Returns the unique Identifier of the Timer 1 End type of Event. More...
 
GenApi::IIntegerEventTimer1EndTimestamp
 Description: Returns the Timestamp of the Timer 1 End Event. More...
 
GenApi::IIntegerEventTimer1EndFrameID
 Description: Returns the unique Identifier of the Frame (or image) that generated the Timer 1 End Event. More...
 
GenApi::IIntegerEventEncoder0Stopped
 Description: Returns the unique Identifier of the Encoder 0 Stopped type of Event. More...
 
GenApi::IIntegerEventEncoder0StoppedTimestamp
 Description: Returns the Timestamp of the Encoder 0 Stopped Event. More...
 
GenApi::IIntegerEventEncoder0StoppedFrameID
 Description: Returns the unique Identifier of the Frame (or image) that generated the Encoder 0 Stopped Event. More...
 
GenApi::IIntegerEventEncoder1Stopped
 Description: Returns the unique Identifier of the Encoder 1 Stopped type of Event. More...
 
GenApi::IIntegerEventEncoder1StoppedTimestamp
 Description: Returns the Timestamp of the Encoder 1 Stopped Event. More...
 
GenApi::IIntegerEventEncoder1StoppedFrameID
 Description: Returns the unique Identifier of the Frame (or image) that generated the Encoder 1 Stopped Event. More...
 
GenApi::IIntegerEventEncoder0Restarted
 Description: Returns the unique Identifier of the Encoder 0 Restarted type of Event. More...
 
GenApi::IIntegerEventEncoder0RestartedTimestamp
 Description: Returns the Timestamp of the Encoder 0 Restarted Event. More...
 
GenApi::IIntegerEventEncoder0RestartedFrameID
 Description: Returns the unique Identifier of the Frame (or image) that generated the Encoder 0 Restarted Event. More...
 
GenApi::IIntegerEventEncoder1Restarted
 Description: Returns the unique Identifier of the Encoder 1 Restarted type of Event. More...
 
GenApi::IIntegerEventEncoder1RestartedTimestamp
 Description: Returns the Timestamp of the Encoder 1 Restarted Event. More...
 
GenApi::IIntegerEventEncoder1RestartedFrameID
 Description: Returns the unique Identifier of the Frame (or image) that generated the Encoder 1 Restarted Event. More...
 
GenApi::IIntegerEventLine0RisingEdge
 Description: Returns the unique Identifier of the Line 0 Rising Edge type of Event. More...
 
GenApi::IIntegerEventLine0RisingEdgeTimestamp
 Description: Returns the Timestamp of the Line 0 Rising Edge Event. More...
 
GenApi::IIntegerEventLine0RisingEdgeFrameID
 Description: Returns the unique Identifier of the Frame (or image) that generated the Line 0 Rising Edge Event. More...
 
GenApi::IIntegerEventLine1RisingEdge
 Description: Returns the unique Identifier of the Line 1 Rising Edge type of Event. More...
 
GenApi::IIntegerEventLine1RisingEdgeTimestamp
 Description: Returns the Timestamp of the Line 1 Rising Edge Event. More...
 
GenApi::IIntegerEventLine1RisingEdgeFrameID
 Description: Returns the unique Identifier of the Frame (or image) that generated the Line 1 Rising Edge Event. More...
 
GenApi::IIntegerEventLine0FallingEdge
 Description: Returns the unique Identifier of the Line 0 Falling Edge type of Event. More...
 
GenApi::IIntegerEventLine0FallingEdgeTimestamp
 Description: Returns the Timestamp of the Line 0 Falling Edge Event. More...
 
GenApi::IIntegerEventLine0FallingEdgeFrameID
 Description: Returns the unique Identifier of the Frame (or image) that generated the Line 0 Falling Edge Event. More...
 
GenApi::IIntegerEventLine1FallingEdge
 Description: Returns the unique Identifier of the Line 1 Falling Edge type of Event. More...
 
GenApi::IIntegerEventLine1FallingEdgeTimestamp
 Description: Returns the Timestamp of the Line 1 Falling Edge Event. More...
 
GenApi::IIntegerEventLine1FallingEdgeFrameID
 Description: Returns the unique Identifier of the Frame (or image) that generated the Line 1 Falling Edge Event. More...
 
GenApi::IIntegerEventLine0AnyEdge
 Description: Returns the unique Identifier of the Line 0 Any Edge type of Event. More...
 
GenApi::IIntegerEventLine0AnyEdgeTimestamp
 Description: Returns the Timestamp of the Line 0 Any Edge Event. More...
 
GenApi::IIntegerEventLine0AnyEdgeFrameID
 Description: Returns the unique Identifier of the Frame (or image) that generated the Line 0 Any Edge Event. More...
 
GenApi::IIntegerEventLine1AnyEdge
 Description: Returns the unique Identifier of the Line 1 Any Edge type of Event. More...
 
GenApi::IIntegerEventLine1AnyEdgeTimestamp
 Description: Returns the Timestamp of the Line 1 Any Edge Event. More...
 
GenApi::IIntegerEventLine1AnyEdgeFrameID
 Description: Returns the unique Identifier of the Frame (or image) that generated the Line 1 Any Edge Event. More...
 
GenApi::IIntegerEventLinkTrigger0
 Description: Returns the unique Identifier of the Link Trigger 0 type of Event. More...
 
GenApi::IIntegerEventLinkTrigger0Timestamp
 Description: Returns the Timestamp of the Link Trigger 0 Event. More...
 
GenApi::IIntegerEventLinkTrigger0FrameID
 Description: Returns the unique Identifier of the Frame (or image) that generated the Link Trigger 0 Event. More...
 
GenApi::IIntegerEventLinkTrigger1
 Description: Returns the unique Identifier of the Link Trigger 1 type of Event. More...
 
GenApi::IIntegerEventLinkTrigger1Timestamp
 Description: Returns the Timestamp of the Link Trigger 1 Event. More...
 
GenApi::IIntegerEventLinkTrigger1FrameID
 Description: Returns the unique Identifier of the Frame (or image) that generated the Link Trigger 1 Event. More...
 
GenApi::IIntegerEventActionLate
 Description: Returns the unique Identifier of the Action Late type of Event. More...
 
GenApi::IIntegerEventActionLateTimestamp
 Description: Returns the Timestamp of the Action Late Event. More...
 
GenApi::IIntegerEventActionLateFrameID
 Description: Returns the unique Identifier of the Frame (or image) that generated the Action Late Event. More...
 
GenApi::IIntegerEventLinkSpeedChange
 Description: Returns the unique Identifier of the Link Speed Change type of Event. More...
 
GenApi::IIntegerEventLinkSpeedChangeTimestamp
 Description: Returns the Timestamp of the Link Speed Change Event. More...
 
GenApi::IIntegerEventLinkSpeedChangeFrameID
 Description: Returns the unique Identifier of the Frame (or image) that generated the Link Speed Change Event. More...
 
GenApi::IRegisterFileAccessBuffer
 Description: Defines the intermediate access buffer that allows the exchange of data between the device file storage and the application. More...
 
GenApi::IIntegerSourceCount
 Description: Controls or returns the number of sources supported by the device. More...
 
GenApi::IEnumerationT
< SourceSelectorEnums > & 
SourceSelector
 Description: Selects the source to control. More...
 
GenApi::IEnumerationT
< TransferSelectorEnums > & 
TransferSelector
 Description: Selects which stream transfers are currently controlled by the selected Transfer features. More...
 
GenApi::IIntegerTransferBurstCount
 Description: Number of Block(s) to transfer for each TransferBurstStart trigger. More...
 
GenApi::ICommandTransferAbort
 Description: Aborts immediately the streaming of data block(s). More...
 
GenApi::ICommandTransferPause
 Description: Pauses the streaming of data Block(s). More...
 
GenApi::ICommandTransferResume
 Description: Resumes a data Blocks streaming that was previously paused by a TransferPause command. More...
 
GenApi::IEnumerationT
< TransferTriggerSelectorEnums > & 
TransferTriggerSelector
 Description: Selects the type of transfer trigger to configure. More...
 
GenApi::IEnumerationT
< TransferTriggerModeEnums > & 
TransferTriggerMode
 Description: Controls if the selected trigger is active. More...
 
GenApi::IEnumerationT
< TransferTriggerSourceEnums > & 
TransferTriggerSource
 Description: Specifies the signal to use as the trigger source for transfers. More...
 
GenApi::IEnumerationT
< TransferTriggerActivationEnums > & 
TransferTriggerActivation
 Description: Specifies the activation mode of the transfer control trigger. More...
 
GenApi::IEnumerationT
< TransferStatusSelectorEnums > & 
TransferStatusSelector
 Description: Selects which status of the transfer module to read. More...
 
GenApi::IBooleanTransferStatus
 Description: Reads the status of the Transfer module signal selected by TransferStatusSelector. More...
 
GenApi::IEnumerationT
< TransferComponentSelectorEnums > & 
TransferComponentSelector
 Description: Selects the color component for the control of the TransferStreamChannel feature. More...
 
GenApi::IIntegerTransferStreamChannel
 Description: Selects the streaming channel that will be used to transfer the selected stream of data. More...
 
GenApi::IEnumerationT
< Scan3dDistanceUnitEnums > & 
Scan3dDistanceUnit
 Description: Specifies the unit used when delivering calibrated distance data. More...
 
GenApi::IEnumerationT
< Scan3dCoordinateSystemEnums > & 
Scan3dCoordinateSystem
 Description: Specifies the Coordinate system to use for the device. More...
 
GenApi::IEnumerationT
< Scan3dOutputModeEnums > & 
Scan3dOutputMode
 Description: Controls the Calibration and data organization of the device, naming the coordinates transmitted. More...
 
GenApi::IEnumerationT
< Scan3dCoordinateSystemReferenceEnums > & 
Scan3dCoordinateSystemReference
 Description: Defines coordinate system reference location. More...
 
GenApi::IEnumerationT
< Scan3dCoordinateSelectorEnums > & 
Scan3dCoordinateSelector
 Description: Selects the individual coordinates in the vectors for 3D information/transformation. More...
 
GenApi::IFloatScan3dCoordinateScale
 Description: Scale factor when transforming a pixel from relative coordinates to world coordinates. More...
 
GenApi::IFloatScan3dCoordinateOffset
 Description: Offset when transforming a pixel from relative coordinates to world coordinates. More...
 
GenApi::IBooleanScan3dInvalidDataFlag
 Description: Enables the definition of a non-valid flag value in the data stream. More...
 
GenApi::IFloatScan3dInvalidDataValue
 Description: Value which identifies a non-valid pixel if Scan3dInvalidDataFlag is enabled. More...
 
GenApi::IFloatScan3dAxisMin
 Description: Minimum valid transmitted coordinate value of the selected Axis. More...
 
GenApi::IFloatScan3dAxisMax
 Description: Maximum valid transmitted coordinate value of the selected Axis. More...
 
GenApi::IEnumerationT
< Scan3dCoordinateTransformSelectorEnums > & 
Scan3dCoordinateTransformSelector
 Description: Sets the index to read/write a coordinate transform value. More...
 
GenApi::IFloatScan3dTransformValue
 Description: Specifies the transform value selected. More...
 
GenApi::IEnumerationT
< Scan3dCoordinateReferenceSelectorEnums > & 
Scan3dCoordinateReferenceSelector
 Description: Sets the index to read a coordinate system reference value defining the transform of a point from the current (Anchor or Transformed) system to the reference system. More...
 
GenApi::IFloatScan3dCoordinateReferenceValue
 Description: Returns the reference value selected. More...
 
GenApi::IIntegerChunkPartSelector
 Description: Selects the part to access in chunk data in a multipart transmission. More...
 
GenApi::IEnumerationT
< ChunkImageComponentEnums > & 
ChunkImageComponent
 Description: Returns the component of the payload image. More...
 
GenApi::IIntegerChunkPixelDynamicRangeMin
 Description: Returns the minimum value of dynamic range of the image included in the payload. More...
 
GenApi::IIntegerChunkPixelDynamicRangeMax
 Description: Returns the maximum value of dynamic range of the image included in the payload. More...
 
GenApi::IIntegerChunkTimestampLatchValue
 Description: Returns the last Timestamp latched with the TimestampLatch command. More...
 
GenApi::IIntegerChunkLineStatusAll
 Description: Returns the status of all the I/O lines at the time of the FrameStart internal event. More...
 
GenApi::IEnumerationT
< ChunkCounterSelectorEnums > & 
ChunkCounterSelector
 Description: Selects which counter to retrieve data from. More...
 
GenApi::IIntegerChunkCounterValue
 Description: Returns the value of the selected Chunk counter at the time of the FrameStart event. More...
 
GenApi::IEnumerationT
< ChunkTimerSelectorEnums > & 
ChunkTimerSelector
 Description: Selects which Timer to retrieve data from. More...
 
GenApi::IFloatChunkTimerValue
 Description: Returns the value of the selected Timer at the time of the FrameStart internal event. More...
 
GenApi::IEnumerationT
< ChunkEncoderSelectorEnums > & 
ChunkEncoderSelector
 Description: Selects which Encoder to retrieve data from. More...
 
GenApi::IIntegerChunkScanLineSelector
 Description: Index for vector representation of one chunk value per line in an image. More...
 
GenApi::IIntegerChunkEncoderValue
 Description: Returns the counter's value of the selected Encoder at the time of the FrameStart in area scan mode or the counter's value at the time of the LineStart selected by ChunkScanLineSelector in LineScan mode. More...
 
GenApi::IEnumerationT
< ChunkEncoderStatusEnums > & 
ChunkEncoderStatus
 Description: Returns the motion status of the selected encoder. More...
 
GenApi::IEnumerationT
< ChunkExposureTimeSelectorEnums > & 
ChunkExposureTimeSelector
 Description: Selects which exposure time is read by the ChunkExposureTime feature. More...
 
GenApi::IIntegerChunkLinePitch
 Description: Returns the LinePitch of the image included in the payload. More...
 
GenApi::IEnumerationT
< ChunkSourceIDEnums > & 
ChunkSourceID
 Description: Returns the identifier of Source that the image comes from. More...
 
GenApi::IEnumerationT
< ChunkRegionIDEnums > & 
ChunkRegionID
 Description: Returns the identifier of Region that the image comes from. More...
 
GenApi::IIntegerChunkTransferBlockID
 Description: Returns the unique identifier of the transfer block used to transport the payload. More...
 
GenApi::IEnumerationT
< ChunkTransferStreamIDEnums > & 
ChunkTransferStreamID
 Description: Returns identifier of the stream that generated this block. More...
 
GenApi::IIntegerChunkTransferQueueCurrentBlockCount
 Description: Returns the current number of blocks in the transfer queue. More...
 
GenApi::IIntegerChunkStreamChannelID
 Description: Returns identifier of the stream channel used to carry the block. More...
 
GenApi::IEnumerationT
< ChunkScan3dDistanceUnitEnums > & 
ChunkScan3dDistanceUnit
 Description: Returns the Distance Unit of the payload image. More...
 
GenApi::IEnumerationT
< ChunkScan3dOutputModeEnums > & 
ChunkScan3dOutputMode
 Description: Returns the Calibrated Mode of the payload image. More...
 
GenApi::IEnumerationT
< ChunkScan3dCoordinateSystemEnums > & 
ChunkScan3dCoordinateSystem
 Description: Returns the Coordinate System of the image included in the payload. More...
 
GenApi::IEnumerationT
< ChunkScan3dCoordinateSystemReferenceEnums > & 
ChunkScan3dCoordinateSystemReference
 Description: Returns the Coordinate System Position of the image included in the payload. More...
 
GenApi::IEnumerationT
< ChunkScan3dCoordinateSelectorEnums > & 
ChunkScan3dCoordinateSelector
 Description: Selects which Coordinate to retrieve data from. More...
 
GenApi::IFloatChunkScan3dCoordinateScale
 Description: Returns the Scale for the selected coordinate axis of the image included in the payload. More...
 
GenApi::IFloatChunkScan3dCoordinateOffset
 Description: Returns the Offset for the selected coordinate axis of the image included in the payload. More...
 
GenApi::IBooleanChunkScan3dInvalidDataFlag
 Description: Returns if a specific non-valid data flag is used in the data stream. More...
 
GenApi::IFloatChunkScan3dInvalidDataValue
 Description: Returns the Invalid Data Value used for the image included in the payload. More...
 
GenApi::IFloatChunkScan3dAxisMin
 Description: Returns the Minimum Axis value for the selected coordinate axis of the image included in the payload. More...
 
GenApi::IFloatChunkScan3dAxisMax
 Description: Returns the Maximum Axis value for the selected coordinate axis of the image included in the payload. More...
 
GenApi::IEnumerationT
< ChunkScan3dCoordinateTransformSelectorEnums > & 
ChunkScan3dCoordinateTransformSelector
 Description: Selector for transform values. More...
 
GenApi::IFloatChunkScan3dTransformValue
 Description: Returns the transform value. More...
 
GenApi::IEnumerationT
< ChunkScan3dCoordinateReferenceSelectorEnums > & 
ChunkScan3dCoordinateReferenceSelector
 Description: Selector to read a coordinate system reference value defining the transform of a point from one system to the other. More...
 
GenApi::IFloatChunkScan3dCoordinateReferenceValue
 Description: Reads the value of a position or pose coordinate for the anchor or transformed coordinate systems relative to the reference point. More...
 
GenApi::IIntegerTestPendingAck
 Description: Tests the device's pending acknowledge feature. More...
 
GenApi::IEnumerationT
< DeviceTapGeometryEnums > & 
DeviceTapGeometry
 Description: This device tap geometry feature describes the geometrical properties characterizing the taps of a camera as presented at the output of the device. More...
 
GenApi::IEnumerationT
< GevPhysicalLinkConfigurationEnums > & 
GevPhysicalLinkConfiguration
 Description: Controls the principal physical link configuration to use on next restart/power-up of the device. More...
 
GenApi::IEnumerationT
< GevCurrentPhysicalLinkConfigurationEnums > & 
GevCurrentPhysicalLinkConfiguration
 Description: Indicates the current physical link configuration of the device. More...
 
GenApi::IIntegerGevActiveLinkCount
 Description: Indicates the current number of active logical links. More...
 
GenApi::IBooleanGevPAUSEFrameReception
 Description: Controls whether incoming PAUSE Frames are handled on the given logical link. More...
 
GenApi::IBooleanGevPAUSEFrameTransmission
 Description: Controls whether PAUSE Frames can be generated on the given logical link. More...
 
GenApi::IEnumerationT
< GevIPConfigurationStatusEnums > & 
GevIPConfigurationStatus
 Description: Reports the current IP configuration status. More...
 
GenApi::IIntegerGevDiscoveryAckDelay
 Description: Indicates the maximum randomized delay the device will wait to acknowledge a discovery command. More...
 
GenApi::IEnumerationT
< GevGVCPExtendedStatusCodesSelectorEnums > & 
GevGVCPExtendedStatusCodesSelector
 Description: Selects the GigE Vision version to control extended status codes for. More...
 
GenApi::IBooleanGevGVCPExtendedStatusCodes
 Description: Enables the generation of extended status codes. More...
 
GenApi::IIntegerGevPrimaryApplicationSwitchoverKey
 Description: Controls the key to use to authenticate primary application switchover requests. More...
 
GenApi::IEnumerationT
< GevGVSPExtendedIDModeEnums > & 
GevGVSPExtendedIDMode
 Description: Enables the extended IDs mode. More...
 
GenApi::IIntegerGevPrimaryApplicationSocket
 Description: Returns the UDP source port of the primary application. More...
 
GenApi::IIntegerGevPrimaryApplicationIPAddress
 Description: Returns the address of the primary application. More...
 
GenApi::IBooleanGevSCCFGPacketResendDestination
 Description: Enables the alternate IP destination for stream packets resent due to a packet resend request. More...
 
GenApi::IBooleanGevSCCFGAllInTransmission
 Description: Enables the selected GVSP transmitter to use the single packet per data block All-in Transmission mode. More...
 
GenApi::IIntegerGevSCZoneCount
 Description: Reports the number of zones per block transmitted on the selected stream channel. More...
 
GenApi::IIntegerGevSCZoneDirectionAll
 Description: Reports the transmission direction of each zone transmitted on the selected stream channel. More...
 
GenApi::IBooleanGevSCZoneConfigurationLock
 Description: Controls whether the selected stream channel multi-zone configuration is locked. More...
 
GenApi::IIntegeraPAUSEMACCtrlFramesTransmitted
 Description: Reports the number of transmitted PAUSE frames. More...
 
GenApi::IIntegeraPAUSEMACCtrlFramesReceived
 Description: Reports the number of received PAUSE frames. More...
 
GenApi::IEnumerationT
< ClConfigurationEnums > & 
ClConfiguration
 Description: This Camera Link specific feature describes the configuration used by the camera. More...
 
GenApi::IEnumerationT
< ClTimeSlotsCountEnums > & 
ClTimeSlotsCount
 Description: This Camera Link specific feature describes the time multiplexing of the camera link connection to transfer more than the configuration allows, in one single clock. More...
 
GenApi::IEnumerationT
< CxpLinkConfigurationStatusEnums > & 
CxpLinkConfigurationStatus
 Description: This feature indicates the current and active Link configuration used by the Device. More...
 
GenApi::IEnumerationT
< CxpLinkConfigurationPreferredEnums > & 
CxpLinkConfigurationPreferred
 Description: Provides the Link configuration that allows the Transmitter Device to operate in its default mode. More...
 
GenApi::IEnumerationT
< CxpLinkConfigurationEnums > & 
CxpLinkConfiguration
 Description: This feature allows specifying the Link configuration for the communication between the Receiver and Transmitter Device. More...
 
GenApi::IIntegerCxpConnectionSelector
 Description: Selects the CoaXPress physical connection to control. More...
 
GenApi::IEnumerationT
< CxpConnectionTestModeEnums > & 
CxpConnectionTestMode
 Description: Enables the test mode for an individual physical connection of the Device. More...
 
GenApi::IIntegerCxpConnectionTestErrorCount
 Description: Reports the current connection error count for test packets recieved by the device on the connection selected by CxpConnectionSelector. More...
 
GenApi::IIntegerCxpConnectionTestPacketCount
 Description: Reports the current count for test packets recieved by the device on the connection selected by CxpConnectionSelector. More...
 
GenApi::ICommandCxpPoCxpAuto
 Description: Activate automatic control of the Power over CoaXPress (PoCXP) for the Link. More...
 
GenApi::ICommandCxpPoCxpTurnOff
 Description: Disable Power over CoaXPress (PoCXP) for the Link. More...
 
GenApi::ICommandCxpPoCxpTripReset
 Description: Reset the Power over CoaXPress (PoCXP) Link after an over-current trip on the Device connection(s). More...
 
GenApi::IEnumerationT
< CxpPoCxpStatusEnums > & 
CxpPoCxpStatus
 Description: Returns the Power over CoaXPress (PoCXP) status of the Device. More...
 
GenApi::IIntegerChunkInferenceFrameId
 Description: Returns the frame ID associated with the most recent inference result. More...
 
GenApi::IIntegerChunkInferenceResult
 Description: Returns the chunk data inference result. More...
 
GenApi::IFloatChunkInferenceConfidence
 Description: Returns the chunk data inference confidence percentage. More...
 
GenApi::IRegisterChunkInferenceBoundingBoxResult
 Description: Returns the chunk inference bounding box result data. More...
 
- Public Attributes inherited from ICameraBase
TransportLayerDevice TLDevice
 Gets vital camera information by connecting to the camera's bootstrap registers. More...
 
TransportLayerStream TLStream
 Gets information about the stream data by connecting to the camera's bootstrap registers. More...
 

Protected Member Functions

 Camera ()
 
- Protected Member Functions inherited from CameraBase
 CameraBase (void)
 Default constructor. More...
 
 CameraBase (const CameraBase &)
 Copy constructor. More...
 
CameraBaseoperator= (const CameraBase &)
 Assignment operator. More...
 
- Protected Member Functions inherited from ICameraBase
 ICameraBase ()
 
 ICameraBase (const ICameraBase &)
 
ICameraBaseoperator= (const ICameraBase &)
 

Additional Inherited Members

- Protected Attributes inherited from ICameraBase
CameraBaseData * m_pCameraBaseData
 

Detailed Description

The camera object class.

Constructor & Destructor Documentation

~Camera ( )
Camera ( )
protected

Member Function Documentation

void Init ( )
virtual

Implements ICameraBase.

Member Data Documentation

GenApi::IBoolean& AasRoiEnable

 Description: 

Controls whether a user-specified ROI is used for auto algorithm that is currently selected by the AutoAlgorithmSelector feature.

Visibility:

GenApi::IInteger& AasRoiHeight

 Description: 

Controls the width of the ROI used by the auto algorithm that is currently selected by the AutoAlgorithmSelector feature.

Visibility:

GenApi::IInteger& AasRoiOffsetX

 Description: 

Controls the x-offset of the ROI used by the auto algorithm that is currently selected by the AutoAlgorithmSelector feature.

Visibility:

GenApi::IInteger& AasRoiOffsetY

 Description: 

Controls the y-offset of the ROI used by the auto algorithm that is currently selected by the AutoAlgorithmSelector feature.

Visibility:

GenApi::IInteger& AasRoiWidth

 Description: 

Controls the width of the ROI used by the auto algorithm that is currently selected by the AutoAlgorithmSelector feature.

Visibility:

GenApi::ICommand& AcquisitionAbort

Description: Aborts the Acquisition immediately.

This will end the capture without completing the current Frame or waiting on a trigger. If no Acquisition is in progress, the command is ignored. Visibility: Expert

GenApi::ICommand& AcquisitionArm

Description: Arms the device before an AcquisitionStart command.

This optional command validates all the current features for consistency and prepares the device for a fast start of the Acquisition. Visibility: Expert

GenApi::IInteger& AcquisitionBurstFrameCount

 Description: 

This feature is used only if the FrameBurstStart trigger is enabled and the FrameBurstEnd trigger is disabled.

Note that the total number of frames captured is also conditioned by AcquisitionFrameCount if AcquisitionMode is MultiFrame and ignored if AcquisitionMode is Single.

 Visibility: 
GenApi::IInteger& AcquisitionFrameCount

 Description: 

Number of images to acquire during a multi frame acquisition.

Visibility:

GenApi::IFloat& AcquisitionFrameRate

Description: User controlled acquisition frame rate in Hertz Visibility:

GenApi::IBoolean& AcquisitionFrameRateEnable

Description: If enabled, AcquisitionFrameRate can be used to manually control the frame rate.

Visibility:

GenApi::IFloat& AcquisitionLineRate

Description: Controls the rate (in Hertz) at which the Lines in a Frame are captured.

Visibility:

Description: Sets the acquisition mode of the device.

Continuous: acquires images continuously. Multi Frame: acquires a specified number of images before stopping acquisition. Single Frame: acquires 1 image before stopping acquisition. Visibility:

GenApi::IFloat& AcquisitionResultingFrameRate

Description: Resulting frame rate in Hertz.

If this does not equal the Acquisition Frame Rate it is because the Exposure Time is greater than the frame time. Visibility:

GenApi::ICommand& AcquisitionStart

Description: This command starts the acquisition of images.

Visibility:

GenApi::IBoolean& AcquisitionStatus

Description: Reads the state of the internal acquisition signal selected using AcquisitionStatusSelector.

Visibility: Expert

Description: Selects the internal acquisition signal to read using AcquisitionStatus.

Visibility: Expert

GenApi::ICommand& AcquisitionStop

Description: This command stops the acquisition of images.

Visibility:

GenApi::IInteger& ActionDeviceKey

Description: 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. Visibility: Guru

GenApi::IInteger& ActionGroupKey

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

Visibility: Guru

GenApi::IInteger& ActionGroupMask

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

Visibility: Guru

GenApi::IInteger& ActionQueueSize

Description: 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. Visibility: Guru

GenApi::IInteger& ActionSelector

Description: Selects to which Action Signal further Action settings apply.

Visibility: Guru

Description: Enables the unconditional action command mode where action commands are processed even when the primary control channel is closed.

Visibility: Guru

GenApi::IBoolean& AdaptiveCompressionEnable

Description: Controls whether lossless compression adapts to the image content.

If disabled, a fixed encoding table is used. Visibility:

 Description: 

Selects which ADC bit depth to use.

A higher ADC bit depth results in better image quality but slower maximum frame rate.

Visibility: 
GenApi::IInteger& aPAUSEMACCtrlFramesReceived

Description: Reports the number of received PAUSE frames.

Visibility: Guru

GenApi::IInteger& aPAUSEMACCtrlFramesTransmitted

Description: Reports the number of transmitted PAUSE frames.

Visibility: Guru

 Description: 

Selects which Auto Algorithm is controlled by the RoiEnable, OffsetX, OffsetY, Width, Height features.

Visibility:

GenApi::IFloat& AutoExposureControlLoopDamping

 Description: 

It controls how fast the exposure and gain get settled.

If the value is too small, it may cause the system to be unstable. Range is from 0.0 to 1.0. Default = 0.2.

Visibility:

 Description: 

Selects whether to adjust gain or exposure first.

When gain priority is selected, the camera fixes the gain to 0 dB, and the exposure is adjusted according to the target grey level. If the maximum exposure is reached before the target grey level is hit, the gain starts to change to meet the target. This mode is used to have the minimum noise. When exposure priority is selected, the camera sets the exposure to a small value (default is 5 ms). The gain is adjusted according to the target grey level. If maximum gain is reached before the target grey level is hit, the exposure starts to change to meet the target. This mode is used to capture fast motion.

Visibility:

GenApi::IFloat& AutoExposureEVCompensation

 Description: 

The EV compensation value used in the exposure compensation.

This allows you to adjust the resultant image intensity with one control. A positive value makes the image brighter. A negative value makes the image darker. Range from -3 to 3 with a step of 1/3. Default = 0.

 Visibility: 
GenApi::IFloat& AutoExposureExposureTimeLowerLimit

 Description: 

The smallest exposure time that auto exposure can set.

Visibility:

GenApi::IFloat& AutoExposureExposureTimeUpperLimit

 Description: 

The largest exposure time that auto exposure can set.

Visibility:

GenApi::IFloat& AutoExposureGainLowerLimit

 Description: 

The smallest gain that auto exposure can set.

Visibility:

GenApi::IFloat& AutoExposureGainUpperLimit

 Description: 

The largest gain that auto exposure can set.

Visibility:

GenApi::IFloat& AutoExposureGreyValueLowerLimit

 Description: 

The lowest value in percentage that the target mean may reach.

Visibility:

GenApi::IFloat& AutoExposureGreyValueUpperLimit

 Description: 

The highest value in percentage that the target mean may reach.

Visibility:

 Description: 

Selects a lighting mode: Backlight, Frontlight or Normal (default).

a. Backlight compensation: used when a strong light is coming from the back of the object. b. Frontlight compensation: used when a strong light is shining in the front of the object while the background is dark. c. Normal lighting: used when the object is not under backlight or frontlight conditions. When normal lighting is selected, metering modes are available.

 Visibility: 

 Description: 

Selects a metering mode: average, spot, or partial metering.

a. Average: Measures the light from the entire scene uniformly to determine the final exposure value. Every portion of the exposed area has the same contribution. b. Spot: Measures a small area (about 3%) in the center of the scene while the rest of the scene is ignored. This mode is used when the scene has a high contrast and the object of interest is relatively small. c. Partial: Measures the light from a larger area (about 11%) in the center of the scene. This mode is used when very dark or bright regions appear at the edge of the frame. Note: Metering mode is available only when Lighting Mode Selector is Normal.

 Visibility: 
GenApi::IFloat& AutoExposureTargetGreyValue

 Description: 

This is the user-specified target grey level (image mean) to apply to the current image.

Note that the target grey level is in the linear domain before gamma correction is applied.

Visibility: 

 Description: 

This indicates whether the target image grey level is automatically set by the camera or manually set by the user.

Note that the target grey level is in the linear domain before gamma correction is applied.

Visibility: 
GenApi::IFloat& BalanceRatio

 Description: 

Controls the balance ratio of the selected color relative to green.

Used for white balancing.

 Visibility: 

 Description: 

Selects a balance ratio to configure once a balance ratio control has been selected.

Visibility:

 Description: 

White Balance compensates for color shifts caused by different lighting conditions.

It can be automatically or manually controlled. For manual control, set to Off. For automatic control, set to Once or Continuous.

Visibility: 
GenApi::IFloat& BalanceWhiteAutoDamping

 Description: 

Controls how quickly 'BalanceWhiteAuto' adjusts the values for Red and Blue BalanceRatio in response to changing conditions.

Higher damping means the changes are more gradual.

 Visibility: 
GenApi::IFloat& BalanceWhiteAutoLowerLimit

 Description: 

Controls the minimum value Auto White Balance can set for the Red/Blue BalanceRatio.

Visibility:

Description: Selects the profile used by BalanceWhiteAuto.

Visibility:

GenApi::IFloat& BalanceWhiteAutoUpperLimit

 Description: 

Controls the maximum value Auto White Balance can set the Red/Blue BalanceRatio.

Visibility:

GenApi::IInteger& BinningHorizontal

 Description: 

Number of horizontal photo-sensitive cells to combine together.

This reduces the horizontal resolution (width) of the image. A value of 1 indicates that no horizontal binning is performed by the camera. This value must be 1 for decimation to be active.

 Visibility: 

Description: Visibility:

 Description: 

Selects which binning engine is controlled by the BinningHorizontal and BinningVertical features.

Visibility:

GenApi::IInteger& BinningVertical

 Description: 

Number of vertical photo-sensitive cells to combine together.

This reduces the vertical resolution (height) of the image. A value of 1 indicates that no vertical binning is performed by the camera. This value must be 1 for decimation to be active.

 Visibility: 

Description: Visibility:

GenApi::IFloat& BlackLevel

 Description: 

Controls the offset of the video signal in percent.

Visibility:

Description: Controls the mode for automatic black level adjustment.

The exact algorithm used to implement this adjustment is device-specific. Visibility: Expert

Description: Controls the mode for automatic black level balancing between the sensor color channels or taps.

The black level coefficients of each channel are adjusted so they are matched. Visibility: Expert

GenApi::IBoolean& BlackLevelClampingEnable

 Description: 

Enable the black level auto clamping feature which performing dark current compensation.

Visibility:

GenApi::IInteger& BlackLevelRaw

 Description: 

Controls the offset of the video signal in camera specific units.

Visibility:

 Description: 

Selects which black level to control.

Only All can be set by the user. Analog and Digital are read-only.

Visibility:

GenApi::IFloat& ChunkBlackLevel

Description: Returns the black level used to capture the image.

Visibility:

Description: Selects which black level to retrieve Visibility:

GenApi::IInteger& ChunkCompressionMode

Description: Returns the compression mode of the last image payload.

Visibility:

GenApi::IFloat& ChunkCompressionRatio

Description: Returns the compression ratio of the last image payload.

Visibility:

Description: Selects which counter to retrieve data from.

Visibility: Expert

GenApi::IInteger& ChunkCounterValue

Description: Returns the value of the selected Chunk counter at the time of the FrameStart event.

Visibility: Expert

GenApi::IInteger& ChunkCRC

Description: Returns the CRC of the image payload.

Visibility:

GenApi::IBoolean& ChunkEnable

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

Visibility:

Description: Selects which Encoder to retrieve data from.

Visibility: Expert

Description: Returns the motion status of the selected encoder.

Visibility: Expert

GenApi::IInteger& ChunkEncoderValue

Description: Returns the counter's value of the selected Encoder at the time of the FrameStart in area scan mode or the counter's value at the time of the LineStart selected by ChunkScanLineSelector in LineScan mode.

Visibility: Expert

GenApi::IInteger& ChunkExposureEndLineStatusAll

Description: Returns the status of all the I/O lines at the end of exposure event.

Visibility:

GenApi::IFloat& ChunkExposureTime

Description: Returns the exposure time used to capture the image.

Visibility:

Description: Selects which exposure time is read by the ChunkExposureTime feature.

Visibility: Expert

GenApi::IInteger& ChunkFrameID

Description: Returns the image frame ID.

Visibility:

GenApi::IFloat& ChunkGain

Description: Returns the gain used to capture the image.

Visibility:

Description: Selects which gain to retrieve Visibility:

GenApi::IInteger& ChunkHeight

Description: Returns the height of the image included in the payload.

Visibility:

GenApi::IInteger& ChunkImage

Description: Returns the image payload.

Visibility:

Description: Returns the component of the payload image.

This can be used to identify the image component of a generic part in a multipart transfer. Visibility: Expert

GenApi::IRegister& ChunkInferenceBoundingBoxResult

Description: Returns the chunk inference bounding box result data.

Visibility: Expert

GenApi::IFloat& ChunkInferenceConfidence

Description: Returns the chunk data inference confidence percentage.

Visibility: Expert

GenApi::IInteger& ChunkInferenceFrameId

Description: Returns the frame ID associated with the most recent inference result.

Visibility: Expert

GenApi::IInteger& ChunkInferenceResult

Description: Returns the chunk data inference result.

Visibility: Expert

GenApi::IInteger& ChunkLinePitch

Description: Returns the LinePitch of the image included in the payload.

Visibility: Expert

GenApi::IInteger& ChunkLineStatusAll

Description: Returns the status of all the I/O lines at the time of the FrameStart internal event.

Visibility: Expert

GenApi::IBoolean& ChunkModeActive

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

Visibility:

GenApi::IInteger& ChunkOffsetX

Description: Returns the Offset X of the image included in the payload.

Visibility:

GenApi::IInteger& ChunkOffsetY

Description: Returns the Offset Y of the image included in the payload.

Visibility:

GenApi::IInteger& ChunkPartSelector

Description: Selects the part to access in chunk data in a multipart transmission.

Visibility: Expert

GenApi::IInteger& ChunkPixelDynamicRangeMax

Description: Returns the maximum value of dynamic range of the image included in the payload.

Visibility: Expert

GenApi::IInteger& ChunkPixelDynamicRangeMin

Description: Returns the minimum value of dynamic range of the image included in the payload.

Visibility: Expert

Description: Format of the pixel provided by the camera Visibility:

Description: Returns the identifier of Region that the image comes from.

Visibility: Expert

GenApi::IFloat& ChunkScan3dAxisMax

Description: Returns the Maximum Axis value for the selected coordinate axis of the image included in the payload.

Visibility: Expert

GenApi::IFloat& ChunkScan3dAxisMin

Description: Returns the Minimum Axis value for the selected coordinate axis of the image included in the payload.

Visibility: Expert

GenApi::IFloat& ChunkScan3dCoordinateOffset

Description: Returns the Offset for the selected coordinate axis of the image included in the payload.

Visibility: Expert

GenApi::IEnumerationT<ChunkScan3dCoordinateReferenceSelectorEnums>& ChunkScan3dCoordinateReferenceSelector

Description: Selector to read a coordinate system reference value defining the transform of a point from one system to the other.

Visibility: Expert

GenApi::IFloat& ChunkScan3dCoordinateReferenceValue

Description: Reads the value of a position or pose coordinate for the anchor or transformed coordinate systems relative to the reference point.

Visibility: Expert

GenApi::IFloat& ChunkScan3dCoordinateScale

Description: Returns the Scale for the selected coordinate axis of the image included in the payload.

Visibility: Expert

Description: Selects which Coordinate to retrieve data from.

Visibility: Expert

Description: Returns the Coordinate System of the image included in the payload.

Visibility: Expert

GenApi::IEnumerationT<ChunkScan3dCoordinateSystemReferenceEnums>& ChunkScan3dCoordinateSystemReference

Description: Returns the Coordinate System Position of the image included in the payload.

Visibility: Expert

GenApi::IEnumerationT<ChunkScan3dCoordinateTransformSelectorEnums>& ChunkScan3dCoordinateTransformSelector

Description: Selector for transform values.

Visibility: Expert

Description: Returns the Distance Unit of the payload image.

Visibility: Expert

GenApi::IBoolean& ChunkScan3dInvalidDataFlag

Description: Returns if a specific non-valid data flag is used in the data stream.

Visibility: Expert

GenApi::IFloat& ChunkScan3dInvalidDataValue

Description: Returns the Invalid Data Value used for the image included in the payload.

Visibility: Expert

Description: Returns the Calibrated Mode of the payload image.

Visibility: Expert

GenApi::IFloat& ChunkScan3dTransformValue

Description: Returns the transform value.

Visibility: Expert

GenApi::IInteger& ChunkScanLineSelector

Description: Index for vector representation of one chunk value per line in an image.

Visibility: Expert

Description: Selects which chunk data to enable or disable.

Visibility:

GenApi::IInteger& ChunkSequencerSetActive

Description: Returns the index of the active set of the running sequencer included in the payload.

Visibility:

GenApi::IString& ChunkSerialData

Description: Returns the serial data that was received.

Visibility:

GenApi::IInteger& ChunkSerialDataLength

Description: Returns the length of the received serial data that was included in the payload.

Visibility:

GenApi::IBoolean& ChunkSerialReceiveOverflow

Description: Returns the status of the chunk serial receive overflow.

Visibility:

Description: Returns the identifier of Source that the image comes from.

Visibility: Expert

GenApi::IInteger& ChunkStreamChannelID

Description: Returns identifier of the stream channel used to carry the block.

Visibility: Expert

Description: Selects which Timer to retrieve data from.

Visibility: Expert

GenApi::IFloat& ChunkTimerValue

Description: Returns the value of the selected Timer at the time of the FrameStart internal event.

Visibility: Expert

GenApi::IInteger& ChunkTimestamp

Description: Returns the Timestamp of the image.

Visibility:

GenApi::IInteger& ChunkTimestampLatchValue

Description: Returns the last Timestamp latched with the TimestampLatch command.

Visibility: Expert

GenApi::IInteger& ChunkTransferBlockID

Description: Returns the unique identifier of the transfer block used to transport the payload.

Visibility: Expert

GenApi::IInteger& ChunkTransferQueueCurrentBlockCount

Description: Returns the current number of blocks in the transfer queue.

Visibility: Expert

Description: Returns identifier of the stream that generated this block.

Visibility: Expert

GenApi::IInteger& ChunkWidth

Description: Returns the width of the image included in the payload.

Visibility:

Description: This Camera Link specific feature describes the configuration used by the camera.

It helps especially when a camera is capable of operation in a non-standard configuration, and when the features PixelSize, SensorDigitizationTaps, and DeviceTapGeometry do not provide enough information for interpretation of the image data provided by the camera. Visibility: Beginner

Description: This Camera Link specific feature describes the time multiplexing of the camera link connection to transfer more than the configuration allows, in one single clock.

Visibility: Expert

GenApi::IBoolean& ColorTransformationEnable

 Description: 

Enables/disables the color transform selected with ColorTransformationSelector.

For RGB to YUV this is read-only. Enabling/disabling RGB to YUV can only be done by changing pixel format.

Visibility: 

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

Visibility:

GenApi::IFloat& ColorTransformationValue

 Description: 

Represents the value of the selected Gain factor or Offset inside the Transformation matrix in floating point precision.

Visibility:

 Description: 

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

Visibility:

GenApi::IFloat& CompressionRatio

Description: Reports the ratio between the uncompressed image size and compressed image size.

Visibility:

Description: When FrameRate is enabled, camera drops frames if datarate is saturated.

If FrameRate is disabled, camera adjusts the framerate to match the maximum achievable datarate. Visibility:

GenApi::IInteger& CounterDelay

Description: Sets the delay (or number of events) before the CounterStart event is generated.

Visibility:

GenApi::IInteger& CounterDuration

Description: Sets the duration (or number of events) before the CounterEnd event is generated.

Visibility:

Description: Selects the activation mode of the event to increment the Counter.

Visibility:

Description: Selects the event that will increment the counter Visibility:

GenApi::ICommand& CounterReset

Description: Does a software reset of the selected Counter and starts it.

The counter starts counting events immediately after the reset unless a Counter trigger is active. CounterReset can be used to reset the Counter independently from the CounterResetSource. To disable the counter temporarily, set CounterEventSource to Off. Visibility: Expert

Description: Selects the Activation mode of the Counter Reset Source signal.

Visibility:

Description: Selects the signal that will be the source to reset the counter.

Visibility:

Description: Selects which counter to configure Visibility:

Description: Returns the current status of the counter.

Visibility:

Description: Selects the activation mode of the trigger to start the counter.

Visibility:

Description: Selects the source of the trigger to start the counter Visibility:

GenApi::IInteger& CounterValue

Description: Current counter value Visibility:

GenApi::IInteger& CounterValueAtReset

Description: Value of the selected Counter when it was reset by a trigger.

Visibility:

GenApi::IInteger& CxpConnectionSelector

Description: Selects the CoaXPress physical connection to control.

Visibility: Expert

GenApi::IInteger& CxpConnectionTestErrorCount

Description: Reports the current connection error count for test packets recieved by the device on the connection selected by CxpConnectionSelector.

Visibility: Expert

Description: Enables the test mode for an individual physical connection of the Device.

Visibility: Expert

GenApi::IInteger& CxpConnectionTestPacketCount

Description: Reports the current count for test packets recieved by the device on the connection selected by CxpConnectionSelector.

Visibility: Expert

Description: This feature allows specifying the Link configuration for the communication between the Receiver and Transmitter Device.

In most cases this feature does not need to be written because automatic discovery will set configuration correctly to the value returned by CxpLinkConfigurationPreferred. Note that the currently active configuration of the Link can be read using CxpLinkConfigurationStatus. Visibility: Beginner

Description: Provides the Link configuration that allows the Transmitter Device to operate in its default mode.

Visibility: Expert

Description: This feature indicates the current and active Link configuration used by the Device.

Visibility: Beginner

GenApi::ICommand& CxpPoCxpAuto

Description: Activate automatic control of the Power over CoaXPress (PoCXP) for the Link.

Visibility: Expert

Description: Returns the Power over CoaXPress (PoCXP) status of the Device.

Visibility: Expert

GenApi::ICommand& CxpPoCxpTripReset

Description: Reset the Power over CoaXPress (PoCXP) Link after an over-current trip on the Device connection(s).

Visibility: Expert

GenApi::ICommand& CxpPoCxpTurnOff

Description: Disable Power over CoaXPress (PoCXP) for the Link.

Visibility: Expert

GenApi::IInteger& DecimationHorizontal

 Description: 

Horizontal decimation of the image.

This reduces the horizontal resolution (width) of the image by only retaining a single pixel within a window whose size is the decimation factor specified here. A value of 1 indicates that no horizontal decimation is performed by the camera. This value must be 1 for binning to be active.

 Visibility: 

 Description: 

The mode used to reduce the horizontal resolution when DecimationHorizontal is used.

The current implementation only supports a single decimation mode: Discard. Average should be achieved via Binning.

 Visibility: 

Description: Selects which decimation layer is controlled by the DecimationHorizontal and DecimationVertical features.

Visibility:

GenApi::IInteger& DecimationVertical

 Description: 

Vertical decimation of the image.

This reduces the vertical resolution (height) of the image by only retaining a single pixel within a window whose size is the decimation factor specified here. A value of 1 indicates that no vertical decimation is performed by the camera. This value must be 1 for binning to be active.

 Visibility: 

 Description: 

The mode used to reduce the vertical resolution when DecimationVertical is used.

The current implementation only supports a single decimation mode: Discard. Average should be achieved via Binning.

 Visibility: 

Description: Controls the method used for replacing defective pixels.

Visibility:

GenApi::IBoolean& DefectCorrectStaticEnable

Description: Enables/Disables table-based defective pixel correction.

Visibility:

GenApi::ICommand& DefectTableApply

Description: Applies the current defect table, so that any changes made affect images captured by the camera.

This writes the table to volatile memory, so changes to the table are lost if the camera loses power. To save the table to non-volatile memory, use DefectTableSave.

Visibility:

GenApi::IInteger& DefectTableCoordinateX

 Description: 

Returns the X coordinate of the defective pixel at DefectTableIndex within the defective pixel table.

Changes made do not take effect in captured images until the command DefectTableApply is written.

 Visibility: 
GenApi::IInteger& DefectTableCoordinateY

 Description: 

Returns the Y coordinate of the defective pixel at DefectTableIndex within the defective pixel table.

Changes made do not take effect in captured images until the command DefectTableApply is written.

 Visibility: 
GenApi::ICommand& DefectTableFactoryRestore

Description: Restores the Defective Pixel Table to its factory default state, which was calibrated during manufacturing.

This permanently overwrites any changes made to the defect table.

Visibility:

GenApi::IInteger& DefectTableIndex

 Description: 

Controls the offset of the element to access in the defective pixel location table.

Visibility:

GenApi::IInteger& DefectTablePixelCount

 Description: 

The number of defective pixel locations in the current table.

Visibility:

GenApi::ICommand& DefectTableSave

Description: Saves the current defective pixel table non-volatile memory, so that it is preserved when the camera boots up.

This overwrites the existing defective pixel table. The new table is loaded whenever the camera powers up.

Visibility:

Description: Controls how the device performs de-interlacing.

Visibility: Beginner

 Description: 

Character set used by the strings of the device`s bootstrap registers.

Visibility:

GenApi::IFloat& DeviceClockFrequency

Description: Returns the frequency of the selected Clock.

Visibility: Expert

Description: Selects the clock frequency to access from the device.

Visibility: Expert

GenApi::IInteger& DeviceConnectionSelector

Description: Selects which Connection of the device to control.

Visibility: Beginner

GenApi::IInteger& DeviceConnectionSpeed

Description: Indicates the speed of transmission of the specified Connection Visibility: Expert.

Description: Indicates the status of the specified Connection.

Visibility: Expert

GenApi::IInteger& DeviceEventChannelCount

 Description: 

Indicates the number of event channels supported by the device.

Visibility:

GenApi::IString& DeviceFamilyName

Description: Identifier of the product family of the device.

Visibility: Beginner

GenApi::ICommand& DeviceFeaturePersistenceEnd

Description: Indicate to the device the end of feature persistence.

Visibility: Guru

GenApi::ICommand& DeviceFeaturePersistenceStart

Description: Indicate to the device and GenICam XML to get ready for persisting of all streamable features.

Visibility: Guru

GenApi::IString& DeviceFirmwareVersion

Description: Version of the firmware on the device.

Visibility:

GenApi::IInteger& DeviceGenCPVersionMajor

Description: Major version of the GenCP protocol supported by the device.

Visibility: Beginner

GenApi::IInteger& DeviceGenCPVersionMinor

Description: Minor version of the GenCP protocol supported by the device.

Visibility: Beginner

GenApi::IString& DeviceID

Description: Device identifier (serial number).

Visibility:

Description: Controls the LED behaviour: Inactive (off), Active (current status), or Error Status (off unless an error occurs).

Visibility:

GenApi::IFloat& DeviceLinkBandwidthReserve

 Description: 

Percentage of streamed data bandwidth reserved for packet resend.

Visibility:

GenApi::IFloat& DeviceLinkCommandTimeout

Description: Indicates the command timeout of the specified Link.

This corresponds to the maximum response time of the device for a command sent on that link. Visibility: Guru

GenApi::IInteger& DeviceLinkConnectionCount

Description: Returns the number of physical connection of the device used by a particular Link.

Visibility: Beginner

GenApi::IInteger& DeviceLinkCurrentThroughput

Description: Current bandwidth of streamed data.

Visibility:

Description: Activate or deactivate the Link's heartbeat.

Visibility: Expert

GenApi::IFloat& DeviceLinkHeartbeatTimeout

Description: Controls the current heartbeat timeout of the specific Link.

Visibility: Guru

GenApi::IInteger& DeviceLinkSelector

Description: Selects which Link of the device to control.

Visibility: Beginner

GenApi::IInteger& DeviceLinkSpeed

 Description: 

Indicates the speed of transmission negotiated on the specified Link.

(Bps)

 Visibility: 
GenApi::IInteger& DeviceLinkThroughputLimit

 Description: 

Limits the maximum bandwidth of the data that will be streamed out by the device on the selected Link.

If necessary, delays will be uniformly inserted between transport layer packets in order to control the peak bandwidth.

 Visibility: 

Description: Controls if the DeviceLinkThroughputLimit is active.

When disabled, lower level TL specific features are expected to control the throughput. When enabled, DeviceLinkThroughputLimit controls the overall throughput. Visibility: Expert

GenApi::IInteger& DeviceManifestEntrySelector

Description: Selects the manifest entry to reference.

Visibility: Guru

GenApi::IString& DeviceManifestPrimaryURL

Description: Indicates the first URL to the GenICam XML device description file of the selected manifest entry.

Visibility: Guru

GenApi::IInteger& DeviceManifestSchemaMajorVersion

Description: Indicates the major version number of the schema file of the selected manifest entry.

Visibility: Guru

GenApi::IInteger& DeviceManifestSchemaMinorVersion

Description: Indicates the minor version number of the schema file of the selected manifest entry.

Visibility: Guru

GenApi::IString& DeviceManifestSecondaryURL

Description: Indicates the second URL to the GenICam XML device description file of the selected manifest entry.

Visibility: Guru

GenApi::IInteger& DeviceManifestXMLMajorVersion

Description: Indicates the major version number of the GenICam XML file of the selected manifest entry.

Visibility: Guru

GenApi::IInteger& DeviceManifestXMLMinorVersion

Description: Indicates the minor version number of the GenICam XML file of the selected manifest entry.

Visibility: Guru

GenApi::IInteger& DeviceManifestXMLSubMinorVersion

Description: Indicates the subminor version number of the GenICam XML file of the selected manifest entry.

Visibility: Guru

GenApi::IString& DeviceManufacturerInfo

Description: Manufacturer information about the device.

Visibility:

GenApi::IInteger& DeviceMaxThroughput

 Description: 

Maximum bandwidth of the data that can be streamed out of the device.

This can be used to estimate if the physical connection(s) can sustain transfer of free-running images from the camera at its maximum speed.

 Visibility: 
GenApi::IString& DeviceModelName

Description: Model of the device.

Visibility:

 Description: 

Selects the power supply source to control or read.

Visibility:

GenApi::ICommand& DeviceRegistersCheck

Description: Perform the validation of the current register set for consistency.

This will update the DeviceRegistersValid flag. Visibility: Expert

Description: Endianness of the registers of the device.

Visibility:

GenApi::ICommand& DeviceRegistersStreamingEnd

Description: Announce the end of registers streaming.

This will do a register set validation for consistency and activate it. This will also update the DeviceRegistersValid flag. Visibility: Guru

GenApi::ICommand& DeviceRegistersStreamingStart

Description: Prepare the device for registers streaming without checking for consistency.

Visibility: Guru

GenApi::IBoolean& DeviceRegistersValid

Description: Returns if the current register set is valid and consistent.

Visibility: Expert

GenApi::ICommand& DeviceReset

Description: This is a command that immediately resets and reboots the device.

Visibility:

Description: Scan type of the sensor of the device.

Visibility:

GenApi::IString& DeviceSerialNumber

 Description: 

Device's serial number.

This string is a unique identifier of the device.

Visibility: 

Description: This feature controls the baud rate used by the selected serial port.

Visibility: Expert

Description: Selects which serial port of the device to control.

Visibility: Expert

GenApi::IInteger& DeviceSFNCVersionMajor

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

Visibility: Beginner

GenApi::IInteger& DeviceSFNCVersionMinor

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

Visibility: Beginner

GenApi::IInteger& DeviceSFNCVersionSubMinor

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

Visibility: Beginner

GenApi::IInteger& DeviceStreamChannelCount

 Description: 

Indicates the number of streaming channels supported by the device.

Visibility:

Description: Endianness of multi-byte pixel data for this stream.

Visibility: Guru

GenApi::IInteger& DeviceStreamChannelLink

Description: Index of device's Link to use for streaming the specifed stream channel.

Visibility: Guru

GenApi::IInteger& DeviceStreamChannelPacketSize

Description: Specifies the stream packet size, in bytes, to send on the selected channel for a Transmitter or specifies the maximum packet size supported by a receiver.

Visibility: Expert

GenApi::IInteger& DeviceStreamChannelSelector

Description: Selects the stream channel to control.

Visibility: Expert

Description: Reports the type of the stream channel.

Visibility: Guru

Description: This device tap geometry feature describes the geometrical properties characterizing the taps of a camera as presented at the output of the device.

Visibility: Expert

GenApi::IFloat& DeviceTemperature

Description: Device temperature in degrees Celsius (C).

Visibility:

 Description: 

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

Visibility:

Description: Transport Layer type of the device.

Visibility:

GenApi::IInteger& DeviceTLVersionMajor

 Description: 

Major version of the Transport Layer of the device.

Visibility:

GenApi::IInteger& DeviceTLVersionMinor

 Description: 

Minor version of the Transport Layer of the device.

Visibility:

GenApi::IInteger& DeviceTLVersionSubMinor

Description: Sub minor version of the Transport Layer of the device.

Visibility: Beginner

Description: Returns the device type.

Visibility: Guru

GenApi::IInteger& DeviceUptime

Description: Total time since the device was powered up in seconds.

Visibility:

GenApi::IString& DeviceUserID

Description: User-programmable device identifier.

Visibility:

GenApi::IString& DeviceVendorName

Description: Name of the manufacturer of the device.

Visibility:

GenApi::IString& DeviceVersion

Description: Version of the device.

Visibility:

GenApi::IInteger& EncoderDivider

Description: Sets how many Encoder increment/decrements that are needed generate an Encoder output pulse signal.

Visibility: Expert

Description: Selects if the count of encoder uses FourPhase mode with jitter filtering or the HighResolution mode without jitter filtering.

Visibility: Expert

Description: Selects the conditions for the Encoder interface to generate a valid Encoder output signal.

Visibility: Expert

GenApi::ICommand& EncoderReset

Description: Does a software reset of the selected Encoder and starts it.

The Encoder starts counting events immediately after the reset. EncoderReset can be used to reset the Encoder independently from the EncoderResetSource. Visibility: Expert

Description: Selects the Activation mode of the Encoder Reset Source signal.

Visibility: Expert

Description: Selects the signals that will be the source to reset the Encoder.

Visibility: Expert

Description: Selects which Encoder to configure.

Visibility: Expert

Description: Selects the signal which will be the source of the A input of the Encoder.

Visibility: Expert

Description: Selects the signal which will be the source of the B input of the Encoder.

Visibility: Expert

Description: Returns the motion status of the encoder.

Visibility: Expert

GenApi::IFloat& EncoderTimeout

Description: Sets the maximum time interval between encoder counter increments before the status turns to static.

Visibility: Expert

GenApi::IInteger& EncoderValue

Description: Reads or writes the current value of the position counter of the selected Encoder.

Visibility: Expert

GenApi::IInteger& EncoderValueAtReset

Description: Reads the value of the of the position counter of the selected Encoder when it was reset by a signal or by an explicit EncoderReset command.

Visibility: Expert

GenApi::IInteger& EnumerationCount

Description: Number of enumerations since uptime.

Visibility:

GenApi::IInteger& EventAcquisitionEnd

Description: Returns the unique Identifier of the Acquisition End type of Event.

Visibility: Expert

GenApi::IInteger& EventAcquisitionEndFrameID

Description: Returns the unique Identifier of the Frame (or image) that generated the Acquisition End Event.

Visibility: Expert

GenApi::IInteger& EventAcquisitionEndTimestamp

Description: Returns the Timestamp of the Acquisition End Event.

Visibility: Expert

GenApi::IInteger& EventAcquisitionError

Description: Returns the unique Identifier of the Acquisition Error type of Event.

Visibility: Expert

GenApi::IInteger& EventAcquisitionErrorFrameID

Description: Returns the unique Identifier of the Frame (or image) that generated the Acquisition Error Event.

Visibility: Expert

GenApi::IInteger& EventAcquisitionErrorTimestamp

Description: Returns the Timestamp of the Acquisition Error Event.

Visibility: Expert

GenApi::IInteger& EventAcquisitionStart

Description: Returns the unique Identifier of the Acquisition Start type of Event.

Visibility: Expert

GenApi::IInteger& EventAcquisitionStartFrameID

Description: Returns the unique Identifier of the Frame (or image) that generated the Acquisition Start Event.

Visibility: Expert

GenApi::IInteger& EventAcquisitionStartTimestamp

Description: Returns the Timestamp of the Acquisition Start Event.

Visibility: Expert

GenApi::IInteger& EventAcquisitionTransferEnd

Description: Returns the unique Identifier of the Acquisition Transfer End type of Event.

Visibility: Expert

GenApi::IInteger& EventAcquisitionTransferEndFrameID

Description: Returns the unique Identifier of the Frame (or image) that generated the Acquisition Transfer End Event.

Visibility: Expert

GenApi::IInteger& EventAcquisitionTransferEndTimestamp

Description: Returns the Timestamp of the Acquisition Transfer End Event.

Visibility: Expert

GenApi::IInteger& EventAcquisitionTransferStart

Description: Returns the unique Identifier of the Acquisition Transfer Start type of Event.

Visibility: Expert

GenApi::IInteger& EventAcquisitionTransferStartFrameID

Description: Returns the unique Identifier of the Frame (or image) that generated the Acquisition Transfer Start Event.

Visibility: Expert

GenApi::IInteger& EventAcquisitionTransferStartTimestamp

Description: Returns the Timestamp of the Acquisition Transfer Start Event.

Visibility: Expert

GenApi::IInteger& EventAcquisitionTrigger

Description: Returns the unique Identifier of the Acquisition Trigger type of Event.

Visibility: Expert

GenApi::IInteger& EventAcquisitionTriggerFrameID

Description: Returns the unique Identifier of the Frame (or image) that generated the Acquisition Trigger Event.

Visibility: Expert

GenApi::IInteger& EventAcquisitionTriggerTimestamp

Description: Returns the Timestamp of the Acquisition Trigger Event.

Visibility: Expert

GenApi::IInteger& EventActionLate

Description: Returns the unique Identifier of the Action Late type of Event.

Visibility: Expert

GenApi::IInteger& EventActionLateFrameID

Description: Returns the unique Identifier of the Frame (or image) that generated the Action Late Event.

Visibility: Expert

GenApi::IInteger& EventActionLateTimestamp

Description: Returns the Timestamp of the Action Late Event.

Visibility: Expert

GenApi::IInteger& EventCounter0End

Description: Returns the unique Identifier of the Counter 0 End type of Event.

Visibility: Expert

GenApi::IInteger& EventCounter0EndFrameID

Description: Returns the unique Identifier of the Frame (or image) that generated the Counter 0 End Event.

Visibility: Expert

GenApi::IInteger& EventCounter0EndTimestamp

Description: Returns the Timestamp of the Counter 0 End Event.

Visibility: Expert

GenApi::IInteger& EventCounter0Start

Description: Returns the unique Identifier of the Counter 0 Start type of Event.

Visibility: Expert

GenApi::IInteger& EventCounter0StartFrameID

Description: Returns the unique Identifier of the Frame (or image) that generated the Counter 0 Start Event.

Visibility: Expert

GenApi::IInteger& EventCounter0StartTimestamp

Description: Returns the Timestamp of the Counter 0 Start Event.

Visibility: Expert

GenApi::IInteger& EventCounter1End

Description: Returns the unique Identifier of the Counter 1 End type of Event.

Visibility: Expert

GenApi::IInteger& EventCounter1EndFrameID

Description: Returns the unique Identifier of the Frame (or image) that generated the Counter 1 End Event.

Visibility: Expert

GenApi::IInteger& EventCounter1EndTimestamp

Description: Returns the Timestamp of the Counter 1 End Event.

Visibility: Expert

GenApi::IInteger& EventCounter1Start

Description: Returns the unique Identifier of the Counter 1 Start type of Event.

Visibility: Expert

GenApi::IInteger& EventCounter1StartFrameID

Description: Returns the unique Identifier of the Frame (or image) that generated the Counter 1 Start Event.

Visibility: Expert

GenApi::IInteger& EventCounter1StartTimestamp

Description: Returns the Timestamp of the Counter 1 Start Event.

Visibility: Expert

GenApi::IInteger& EventEncoder0Restarted

Description: Returns the unique Identifier of the Encoder 0 Restarted type of Event.

Visibility: Expert

GenApi::IInteger& EventEncoder0RestartedFrameID

Description: Returns the unique Identifier of the Frame (or image) that generated the Encoder 0 Restarted Event.

Visibility: Expert

GenApi::IInteger& EventEncoder0RestartedTimestamp

Description: Returns the Timestamp of the Encoder 0 Restarted Event.

Visibility: Expert

GenApi::IInteger& EventEncoder0Stopped

Description: Returns the unique Identifier of the Encoder 0 Stopped type of Event.

Visibility: Expert

GenApi::IInteger& EventEncoder0StoppedFrameID

Description: Returns the unique Identifier of the Frame (or image) that generated the Encoder 0 Stopped Event.

Visibility: Expert

GenApi::IInteger& EventEncoder0StoppedTimestamp

Description: Returns the Timestamp of the Encoder 0 Stopped Event.

Visibility: Expert

GenApi::IInteger& EventEncoder1Restarted

Description: Returns the unique Identifier of the Encoder 1 Restarted type of Event.

Visibility: Expert

GenApi::IInteger& EventEncoder1RestartedFrameID

Description: Returns the unique Identifier of the Frame (or image) that generated the Encoder 1 Restarted Event.

Visibility: Expert

GenApi::IInteger& EventEncoder1RestartedTimestamp

Description: Returns the Timestamp of the Encoder 1 Restarted Event.

Visibility: Expert

GenApi::IInteger& EventEncoder1Stopped

Description: Returns the unique Identifier of the Encoder 1 Stopped type of Event.

Visibility: Expert

GenApi::IInteger& EventEncoder1StoppedFrameID

Description: Returns the unique Identifier of the Frame (or image) that generated the Encoder 1 Stopped Event.

Visibility: Expert

GenApi::IInteger& EventEncoder1StoppedTimestamp

Description: Returns the Timestamp of the Encoder 1 Stopped Event.

Visibility: Expert

GenApi::IInteger& EventError

Description: Returns the unique identifier of the Error type of Event.

Visibility:

GenApi::IInteger& EventErrorCode

Description: Returns the error code for the error that happened Visibility:

GenApi::IInteger& EventErrorFrameID

Description: Returns the unique Identifier of the Frame (or image) that generated the Error Event.

Visibility:

GenApi::IInteger& EventErrorTimestamp

Description: Returns the Timestamp of the Error Event.

Visibility:

GenApi::IInteger& EventExposureEnd

Description: Returns the unique identifier of the Exposure End type of Event.

Visibility:

GenApi::IInteger& EventExposureEndFrameID

Description: Returns the unique Identifier of the Frame (or image) that generated the Exposure End Event.

Visibility:

GenApi::IInteger& EventExposureEndTimestamp

Description: Returns the Timestamp of the Exposure End Event.

Visibility:

GenApi::IInteger& EventExposureStart

Description: Returns the unique Identifier of the Exposure Start type of Event.

Visibility: Expert

GenApi::IInteger& EventExposureStartFrameID

Description: Returns the unique Identifier of the Frame (or image) that generated the Exposure Start Event.

Visibility: Expert

GenApi::IInteger& EventExposureStartTimestamp

Description: Returns the Timestamp of the Exposure Start Event.

Visibility: Expert

GenApi::IInteger& EventFrameBurstEnd

Description: Returns the unique Identifier of the Frame Burst End type of Event.

Visibility: Expert

GenApi::IInteger& EventFrameBurstEndFrameID

Description: Returns the unique Identifier of the Frame (or image) that generated the Frame Burst End Event.

Visibility: Expert

GenApi::IInteger& EventFrameBurstEndTimestamp

Description: Returns the Timestamp of the Frame Burst End Event.

Visibility: Expert

GenApi::IInteger& EventFrameBurstStart

Description: Returns the unique Identifier of the Frame Burst Start type of Event.

Visibility: Expert

GenApi::IInteger& EventFrameBurstStartFrameID

Description: Returns the unique Identifier of the Frame (or image) that generated the Frame Burst Start Event.

Visibility: Expert

GenApi::IInteger& EventFrameBurstStartTimestamp

Description: Returns the Timestamp of the Frame Burst Start Event.

Visibility: Expert

GenApi::IInteger& EventFrameEnd

Description: Returns the unique Identifier of the Frame End type of Event.

Visibility: Expert

GenApi::IInteger& EventFrameEndFrameID

Description: Returns the unique Identifier of the Frame (or image) that generated the Frame End Event.

Visibility: Expert

GenApi::IInteger& EventFrameEndTimestamp

Description: Returns the Timestamp of the Frame End Event.

Visibility: Expert

GenApi::IInteger& EventFrameStart

Description: Returns the unique Identifier of the Frame Start type of Event.

Visibility: Expert

GenApi::IInteger& EventFrameStartFrameID

Description: Returns the unique Identifier of the Frame (or image) that generated the Frame Start Event.

Visibility: Expert

GenApi::IInteger& EventFrameStartTimestamp

Description: Returns the Timestamp of the Frame Start Event.

Visibility: Expert

GenApi::IInteger& EventFrameTransferEnd

Description: Returns the unique Identifier of the Frame Transfer End type of Event.

Visibility: Expert

GenApi::IInteger& EventFrameTransferEndFrameID

Description: Returns the unique Identifier of the Frame (or image) that generated the Frame Transfer End Event.

Visibility: Expert

GenApi::IInteger& EventFrameTransferEndTimestamp

Description: Returns the Timestamp of the Frame Transfer End Event.

Visibility: Expert

GenApi::IInteger& EventFrameTransferStart

Description: Returns the unique Identifier of the Frame Transfer Start type of Event.

Visibility: Expert

GenApi::IInteger& EventFrameTransferStartFrameID

Description: Returns the unique Identifier of the Frame (or image) that generated the Frame Transfer Start Event.

Visibility: Expert

GenApi::IInteger& EventFrameTransferStartTimestamp

Description: Returns the Timestamp of the Frame Transfer Start Event.

Visibility: Expert

GenApi::IInteger& EventFrameTrigger

Description: Returns the unique Identifier of the FrameTrigger type of Event.

It can be used to register a callback function to be notified of the event occurrence. Its value uniquely identifies the type event received. Visibility: Expert

GenApi::IInteger& EventFrameTriggerFrameID

Description: Returns the unique Identifier of the Frame (or image) that generated the FrameTrigger Event.

Visibility: Expert

GenApi::IInteger& EventFrameTriggerTimestamp

Description: Returns the Timestamp of the FrameTrigger Event.

It can be used to determine precisely when the event occurred. Visibility: Expert

GenApi::IInteger& EventLine0AnyEdge

Description: Returns the unique Identifier of the Line 0 Any Edge type of Event.

Visibility: Expert

GenApi::IInteger& EventLine0AnyEdgeFrameID

Description: Returns the unique Identifier of the Frame (or image) that generated the Line 0 Any Edge Event.

Visibility: Expert

GenApi::IInteger& EventLine0AnyEdgeTimestamp

Description: Returns the Timestamp of the Line 0 Any Edge Event.

Visibility: Expert

GenApi::IInteger& EventLine0FallingEdge

Description: Returns the unique Identifier of the Line 0 Falling Edge type of Event.

Visibility: Expert

GenApi::IInteger& EventLine0FallingEdgeFrameID

Description: Returns the unique Identifier of the Frame (or image) that generated the Line 0 Falling Edge Event.

Visibility: Expert

GenApi::IInteger& EventLine0FallingEdgeTimestamp

Description: Returns the Timestamp of the Line 0 Falling Edge Event.

Visibility: Expert

GenApi::IInteger& EventLine0RisingEdge

Description: Returns the unique Identifier of the Line 0 Rising Edge type of Event.

Visibility: Expert

GenApi::IInteger& EventLine0RisingEdgeFrameID

Description: Returns the unique Identifier of the Frame (or image) that generated the Line 0 Rising Edge Event.

Visibility: Expert

GenApi::IInteger& EventLine0RisingEdgeTimestamp

Description: Returns the Timestamp of the Line 0 Rising Edge Event.

Visibility: Expert

GenApi::IInteger& EventLine1AnyEdge

Description: Returns the unique Identifier of the Line 1 Any Edge type of Event.

Visibility: Expert

GenApi::IInteger& EventLine1AnyEdgeFrameID

Description: Returns the unique Identifier of the Frame (or image) that generated the Line 1 Any Edge Event.

Visibility: Expert

GenApi::IInteger& EventLine1AnyEdgeTimestamp

Description: Returns the Timestamp of the Line 1 Any Edge Event.

Visibility: Expert

GenApi::IInteger& EventLine1FallingEdge

Description: Returns the unique Identifier of the Line 1 Falling Edge type of Event.

Visibility: Expert

GenApi::IInteger& EventLine1FallingEdgeFrameID

Description: Returns the unique Identifier of the Frame (or image) that generated the Line 1 Falling Edge Event.

Visibility: Expert

GenApi::IInteger& EventLine1FallingEdgeTimestamp

Description: Returns the Timestamp of the Line 1 Falling Edge Event.

Visibility: Expert

GenApi::IInteger& EventLine1RisingEdge

Description: Returns the unique Identifier of the Line 1 Rising Edge type of Event.

Visibility: Expert

GenApi::IInteger& EventLine1RisingEdgeFrameID

Description: Returns the unique Identifier of the Frame (or image) that generated the Line 1 Rising Edge Event.

Visibility: Expert

GenApi::IInteger& EventLine1RisingEdgeTimestamp

Description: Returns the Timestamp of the Line 1 Rising Edge Event.

Visibility: Expert

GenApi::IInteger& EventLinkSpeedChange

Description: Returns the unique Identifier of the Link Speed Change type of Event.

Visibility: Expert

GenApi::IInteger& EventLinkSpeedChangeFrameID

Description: Returns the unique Identifier of the Frame (or image) that generated the Link Speed Change Event.

Visibility: Expert

GenApi::IInteger& EventLinkSpeedChangeTimestamp

Description: Returns the Timestamp of the Link Speed Change Event.

Visibility: Expert

GenApi::IInteger& EventLinkTrigger0

Description: Returns the unique Identifier of the Link Trigger 0 type of Event.

Visibility: Expert

GenApi::IInteger& EventLinkTrigger0FrameID

Description: Returns the unique Identifier of the Frame (or image) that generated the Link Trigger 0 Event.

Visibility: Expert

GenApi::IInteger& EventLinkTrigger0Timestamp

Description: Returns the Timestamp of the Link Trigger 0 Event.

Visibility: Expert

GenApi::IInteger& EventLinkTrigger1

Description: Returns the unique Identifier of the Link Trigger 1 type of Event.

Visibility: Expert

GenApi::IInteger& EventLinkTrigger1FrameID

Description: Returns the unique Identifier of the Frame (or image) that generated the Link Trigger 1 Event.

Visibility: Expert

GenApi::IInteger& EventLinkTrigger1Timestamp

Description: Returns the Timestamp of the Link Trigger 1 Event.

Visibility: Expert

Description: Enables/Disables the selected event.

Visibility:

Description: Selects which Event to enable or disable.

Visibility:

GenApi::IInteger& EventSequencerSetChange

Description: Returns the unique Identifier of the Sequencer Set Change type of Event.

Visibility: Expert

GenApi::IInteger& EventSequencerSetChangeFrameID

Description: Returns the unique Identifier of the Frame (or image) that generated the Sequencer Set Change Event.

Visibility: Expert

GenApi::IInteger& EventSequencerSetChangeTimestamp

Description: Returns the Timestamp of the Sequencer Set Change Event.

Visibility: Expert

GenApi::IString& EventSerialData

Description: Returns the serial data that was received.

Visibility:

GenApi::IInteger& EventSerialDataLength

Description: Returns the length of the received serial data that was included in the event payload.

Visibility:

GenApi::IInteger& EventSerialPortReceive

Description: Returns the unique identifier of the Serial Port Receive type of Event.

Visibility:

GenApi::IInteger& EventSerialPortReceiveTimestamp

Description: Returns the Timestamp of the Serial Port Receive Event.

Visibility:

GenApi::IBoolean& EventSerialReceiveOverflow

Description: Returns the status of the event serial receive overflow.

Visibility:

GenApi::IInteger& EventStream0TransferBlockEnd

Description: Returns the unique Identifier of the Stream 0 Transfer Block End type of Event.

Visibility: Expert

GenApi::IInteger& EventStream0TransferBlockEndFrameID

Description: Returns the unique Identifier of the Frame (or image) that generated the Stream 0 Transfer Block End Event.

Visibility: Expert

GenApi::IInteger& EventStream0TransferBlockEndTimestamp

Description: Returns the Timestamp of the Stream 0 Transfer Block End Event.

Visibility: Expert

GenApi::IInteger& EventStream0TransferBlockStart

Description: Returns the unique Identifier of the Stream 0 Transfer Block Start type of Event.

Visibility: Expert

GenApi::IInteger& EventStream0TransferBlockStartFrameID

Description: Returns the unique Identifier of the Frame (or image) that generated the Stream 0 Transfer Block Start Event.

Visibility: Expert

GenApi::IInteger& EventStream0TransferBlockStartTimestamp

Description: Returns the Timestamp of the Stream 0 Transfer Block Start Event.

Visibility: Expert

GenApi::IInteger& EventStream0TransferBlockTrigger

Description: Returns the unique Identifier of the Stream 0 Transfer Block Trigger type of Event.

Visibility: Expert

GenApi::IInteger& EventStream0TransferBlockTriggerFrameID

Description: Returns the unique Identifier of the Frame (or image) that generated the Stream 0 Transfer Block Trigger Event.

Visibility: Expert

GenApi::IInteger& EventStream0TransferBlockTriggerTimestamp

Description: Returns the Timestamp of the Stream 0 Transfer Block Trigger Event.

Visibility: Expert

GenApi::IInteger& EventStream0TransferBurstEnd

Description: Returns the unique Identifier of the Stream 0 Transfer Burst End type of Event.

Visibility: Expert

GenApi::IInteger& EventStream0TransferBurstEndFrameID

Description: Returns the unique Identifier of the Frame (or image) that generated the Stream 0 Transfer Burst End Event.

Visibility: Expert

GenApi::IInteger& EventStream0TransferBurstEndTimestamp

Description: Returns the Timestamp of the Stream 0 Transfer Burst End Event.

Visibility: Expert

GenApi::IInteger& EventStream0TransferBurstStart

Description: Returns the unique Identifier of the Stream 0 Transfer Burst Start type of Event.

Visibility: Expert

GenApi::IInteger& EventStream0TransferBurstStartFrameID

Description: Returns the unique Identifier of the Frame (or image) that generated the Stream 0 Transfer Burst Start Event.

Visibility: Expert

GenApi::IInteger& EventStream0TransferBurstStartTimestamp

Description: Returns the Timestamp of the Stream 0 Transfer Burst Start Event.

Visibility: Expert

GenApi::IInteger& EventStream0TransferEnd

Description: Returns the unique Identifier of the Stream 0 Transfer End type of Event.

Visibility: Expert

GenApi::IInteger& EventStream0TransferEndFrameID

Description: Returns the unique Identifier of the Frame (or image) that generated the Stream 0 Transfer End Event.

Visibility: Expert

GenApi::IInteger& EventStream0TransferEndTimestamp

Description: Returns the Timestamp of the Stream 0 Transfer End Event.

Visibility: Expert

GenApi::IInteger& EventStream0TransferOverflow

Description: Returns the unique Identifier of the Stream 0 Transfer Overflow type of Event.

Visibility: Expert

GenApi::IInteger& EventStream0TransferOverflowFrameID

Description: Returns the unique Identifier of the Frame (or image) that generated the Stream 0 Transfer Overflow Event.

Visibility: Expert

GenApi::IInteger& EventStream0TransferOverflowTimestamp

Description: Returns the Timestamp of the Stream 0 Transfer Overflow Event.

Visibility: Expert

GenApi::IInteger& EventStream0TransferPause

Description: Returns the unique Identifier of the Stream 0 Transfer Pause type of Event.

Visibility: Expert

GenApi::IInteger& EventStream0TransferPauseFrameID

Description: Returns the unique Identifier of the Frame (or image) that generated the Stream 0 Transfer Pause Event.

Visibility: Expert

GenApi::IInteger& EventStream0TransferPauseTimestamp

Description: Returns the Timestamp of the Stream 0 Transfer Pause Event.

Visibility: Expert

GenApi::IInteger& EventStream0TransferResume

Description: Returns the unique Identifier of the Stream 0 Transfer Resume type of Event.

Visibility: Expert

GenApi::IInteger& EventStream0TransferResumeFrameID

Description: Returns the unique Identifier of the Frame (or image) that generated the Stream 0 Transfer Resume Event.

Visibility: Expert

GenApi::IInteger& EventStream0TransferResumeTimestamp

Description: Returns the Timestamp of the Stream 0 Transfer Resume Event.

Visibility: Expert

GenApi::IInteger& EventStream0TransferStart

Description: Returns the unique Identifier of the Stream 0 Transfer Start type of Event.

Visibility: Expert

GenApi::IInteger& EventStream0TransferStartFrameID

Description: Returns the unique Identifier of the Frame (or image) that generated the Stream 0 Transfer Start Event.

Visibility: Expert

GenApi::IInteger& EventStream0TransferStartTimestamp

Description: Returns the Timestamp of the Stream 0 Transfer Start Event.

Visibility: Expert

GenApi::IInteger& EventTest

Description: Returns the unique identifier of the Test type of Event.

Visibility:

GenApi::IInteger& EventTestTimestamp

Description: Returns the Timestamp of the Test Event.

Visibility:

GenApi::IInteger& EventTimer0End

Description: Returns the unique Identifier of the Timer 0 End type of Event.

Visibility: Expert

GenApi::IInteger& EventTimer0EndFrameID

Description: Returns the unique Identifier of the Frame (or image) that generated the Timer 0 End Event.

Visibility: Expert

GenApi::IInteger& EventTimer0EndTimestamp

Description: Returns the Timestamp of the Timer 0 End Event.

Visibility: Expert

GenApi::IInteger& EventTimer0Start

Description: Returns the unique Identifier of the Timer 0 Start type of Event.

Visibility: Expert

GenApi::IInteger& EventTimer0StartFrameID

Description: Returns the unique Identifier of the Frame (or image) that generated the Timer 0 Start Event.

Visibility: Expert

GenApi::IInteger& EventTimer0StartTimestamp

Description: Returns the Timestamp of the Timer 0 Start Event.

Visibility: Expert

GenApi::IInteger& EventTimer1End

Description: Returns the unique Identifier of the Timer 1 End type of Event.

Visibility: Expert

GenApi::IInteger& EventTimer1EndFrameID

Description: Returns the unique Identifier of the Frame (or image) that generated the Timer 1 End Event.

Visibility: Expert

GenApi::IInteger& EventTimer1EndTimestamp

Description: Returns the Timestamp of the Timer 1 End Event.

Visibility: Expert

GenApi::IInteger& EventTimer1Start

Description: Returns the unique Identifier of the Timer 1 Start type of Event.

Visibility: Expert

GenApi::IInteger& EventTimer1StartFrameID

Description: Returns the unique Identifier of the Frame (or image) that generated the Timer 1 Start Event.

Visibility: Expert

GenApi::IInteger& EventTimer1StartTimestamp

Description: Returns the Timestamp of the Timer 1 Start Event.

Visibility: Expert

Description: Control sensor active exposure mode.

Visibility:

Description: Sets the automatic exposure mode Visibility:

 Description: 

Sets the operation mode of the Exposure.

Visibility:

GenApi::IFloat& ExposureTime

 Description: 

Exposure time in microseconds when Exposure Mode is Timed.

Visibility:

Description: Sets the configuration mode of the ExposureTime feature.

Visibility: Beginner

Description: Selects which exposure time is controlled by the ExposureTime feature.

This allows for independent control over the exposure components. Visibility: Beginner

GenApi::ICommand& FactoryReset

Description: Returns all user tables to factory default Visibility:

GenApi::IRegister& FileAccessBuffer

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

Visibility: Guru

GenApi::IInteger& FileAccessLength

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

Visibility:

GenApi::IInteger& FileAccessOffset

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

Visibility:

 Description: 

The mode of the file when it is opened.

The file can be opened for reading, writting or both. This must be set before opening the file.

Visibility: 
GenApi::ICommand& FileOperationExecute

 Description: 

This is a command that executes the selected file operation on the selected file.

Visibility:

GenApi::IInteger& FileOperationResult

Description: Represents the file operation result.

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

 Description: 

Sets operation to execute on the selected file when the execute command is given.

Visibility:

Description: Represents the file operation execution status.

Visibility:

 Description: 

Selects which file is being operated on.

This must be set before performing any file operations.

Visibility: 
GenApi::IInteger& FileSize

Description: Represents the size of the selected file in bytes.

Visibility:

 Description: 

Controls the amplification of the video signal in dB.

Visibility:

 Description: 

Sets the automatic gain mode.

Set to Off for manual control. Set to Once for a single automatic adjustment then return to Off. Set to Continuous for constant adjustment. In automatic modes, the camera adjusts the gain to maximize the dynamic range. Visibility:

Description: Sets the mode for automatic gain balancing between the sensor color channels or taps.

The gain coefficients of each channel or tap are adjusted so they are matched. Visibility: Beginner

Description: Selects which gain to control.

The All selection is a total amplification across all channels (or taps).

Visibility:

Description: Controls the gamma correction of pixel intensity.

Visibility:

GenApi::IBoolean& GammaEnable

Description: Enables/disables gamma correction.

Visibility:

GenApi::IInteger& GevActiveLinkCount

Description: Indicates the current number of active logical links.

Visibility: Expert

Description: Controls the device access privilege of an application.

Visibility:

GenApi::IInteger& GevCurrentDefaultGateway

Description: Reports the default gateway IP address to be used on the given logical link.

Visibility:

GenApi::IInteger& GevCurrentIPAddress

Description: Reports the IP address for the given logical link.

Visibility:

GenApi::IBoolean& GevCurrentIPConfigurationDHCP

Description: Controls whether the DHCP IP configuration scheme is activated on the given logical link.

Visibility:

GenApi::IBoolean& GevCurrentIPConfigurationLLA

Description: Controls whether the Link Local Address IP configuration scheme is activated on the given logical link.

Visibility:

GenApi::IBoolean& GevCurrentIPConfigurationPersistentIP

Description: Controls whether the PersistentIP configuration scheme is activated on the given logical link.

Visibility:

GenApi::IEnumerationT<GevCurrentPhysicalLinkConfigurationEnums>& GevCurrentPhysicalLinkConfiguration

Description: Indicates the current physical link configuration of the device.

Visibility: Expert

GenApi::IInteger& GevCurrentSubnetMask

Description: Reports the subnet mask of the given logical link.

Visibility:

GenApi::IInteger& GevDiscoveryAckDelay

Description: Indicates the maximum randomized delay the device will wait to acknowledge a discovery command.

Visibility: Expert

GenApi::IString& GevFirstURL

Description: The first choice of URL for the XML device description file.

Visibility:

GenApi::IBoolean& GevGVCPExtendedStatusCodes

Description: Enables the generation of extended status codes.

Visibility: Guru

GenApi::IEnumerationT<GevGVCPExtendedStatusCodesSelectorEnums>& GevGVCPExtendedStatusCodesSelector

Description: Selects the GigE Vision version to control extended status codes for.

Visibility: Guru

GenApi::IBoolean& GevGVCPHeartbeatDisable

Description: Disables the GVCP heartbeat.

Visibility:

GenApi::IBoolean& GevGVCPPendingAck

Description: Enables the generation of PENDING_ACK.

Visibility:

GenApi::IInteger& GevGVCPPendingTimeout

Description: Indicates the longest GVCP command execution time before the device returns a PENDING_ACK in milliseconds.

Visibility:

Description: Enables the extended IDs mode.

Visibility: Expert

GenApi::IInteger& GevHeartbeatTimeout

Description: Indicates the current heartbeat timeout in milliseconds.

Visibility:

GenApi::IBoolean& GevIEEE1588

Description: Enables the IEEE 1588 Precision Time Protocol to control the timestamp register.

Visibility:

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

Visibility:

Description: Provides the mode of the IEEE 1588 clock.

Visibility:

Description: Provides the status of the IEEE 1588 clock.

Visibility:

GenApi::IInteger& GevInterfaceSelector

Description: Selects which logical link to control.

Visibility:

Description: Reports the current IP configuration status.

Visibility: Beginner

GenApi::IInteger& GevMACAddress

Description: MAC address of the logical link.

Visibility:

GenApi::IInteger& GevMCDA

Description: Controls the destination IP address of the message channel Visibility:

GenApi::IInteger& GevMCPHostPort

Description: The port to which the device must send messages Visibility:

GenApi::IInteger& GevMCRC

Description: Indicates the number of retries of the message channel.

Visibility:

GenApi::IInteger& GevMCSP

Description: Indicates the source port of the message channel.

Visibility:

GenApi::IInteger& GevMCTT

Description: Indicates the transmission timeout of the message channel.

Visibility:

GenApi::IInteger& GevNumberOfInterfaces

Description: Indicates the number of physical network interfaces supported by this device.

Visibility:

GenApi::IBoolean& GevPAUSEFrameReception

Description: Controls whether incoming PAUSE Frames are handled on the given logical link.

Visibility: Expert

GenApi::IBoolean& GevPAUSEFrameTransmission

Description: Controls whether PAUSE Frames can be generated on the given logical link.

Visibility: Expert

GenApi::IInteger& GevPersistentDefaultGateway

Description: Controls the persistent default gateway for this logical link.

Visibility:

GenApi::IInteger& GevPersistentIPAddress

Description: Controls the Persistent IP address for this logical link.

Visibility:

GenApi::IInteger& GevPersistentSubnetMask

Description: Controls the Persistent subnet mask associated with the Persistent IP address on this logical link.

Visibility:

Description: Controls the principal physical link configuration to use on next restart/power-up of the device.

Visibility: Expert

GenApi::IInteger& GevPrimaryApplicationIPAddress

Description: Returns the address of the primary application.

Visibility: Guru

GenApi::IInteger& GevPrimaryApplicationSocket

Description: Returns the UDP source port of the primary application.

Visibility: Guru

GenApi::IInteger& GevPrimaryApplicationSwitchoverKey

Description: Controls the key to use to authenticate primary application switchover requests.

Visibility: Guru

GenApi::IBoolean& GevSCCFGAllInTransmission

Description: Enables the selected GVSP transmitter to use the single packet per data block All-in Transmission mode.

Visibility: Guru

GenApi::IBoolean& GevSCCFGExtendedChunkData

Description: Enables cameras to use the extended chunk data payload type for this stream channel.

Visibility:

GenApi::IBoolean& GevSCCFGPacketResendDestination

Description: Enables the alternate IP destination for stream packets resent due to a packet resend request.

When True, the source IP address provided in the packet resend command packet is used. When False, the value set in the GevSCDA[GevStreamChannelSelector] feature is used. Visibility: Guru

GenApi::IBoolean& GevSCCFGUnconditionalStreaming

Description: Enables the camera to continue to stream, for this stream channel, if its control channel is closed or regardless of the reception of any ICMP messages (such as destination unreachable messages).

Visibility:

GenApi::IInteger& GevSCDA

Description: Controls the destination IP address of the selected stream channel to which a GVSP transmitter must send data stream or the destination IP address from which a GVSP receiver may receive data stream.

Visibility:

GenApi::IInteger& GevSCPD

Description: Controls the delay (in GEV timestamp counter unit) to insert between each packet for this stream channel.

This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device. Visibility:

GenApi::IInteger& GevSCPDirection

Description: Transmit or Receive of the channel Visibility:

GenApi::IInteger& GevSCPHostPort

Description: Controls the port of the selected channel to which a GVSP transmitter must send data stream or the port from which a GVSP receiver may receive data stream.

Visibility:

GenApi::IInteger& GevSCPInterfaceIndex

Description: Index of the logical link to use.

Visibility:

GenApi::IBoolean& GevSCPSBigEndian

Description: Endianness of multi-byte pixel data for this stream.

Visibility:

GenApi::IBoolean& GevSCPSDoNotFragment

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

Visibility:

GenApi::IBoolean& GevSCPSFireTestPacket

Description: Sends a test packet.

Visibility:

GenApi::IInteger& GevSCPSPacketSize

Description: Specifies the stream packet size (in bytes) to send on this channel.

Visibility:

GenApi::IInteger& GevSCSP

Description: Indicates the source port of the stream channel.

Visibility:

GenApi::IBoolean& GevSCZoneConfigurationLock

Description: Controls whether the selected stream channel multi-zone configuration is locked.

When locked, the GVSP transmitter is not allowed to change the number of zones and their direction during block acquisition and transmission. Visibility: Guru

GenApi::IInteger& GevSCZoneCount

Description: Reports the number of zones per block transmitted on the selected stream channel.

Visibility: Guru

GenApi::IInteger& GevSCZoneDirectionAll

Description: Reports the transmission direction of each zone transmitted on the selected stream channel.

Visibility: Guru

GenApi::IString& GevSecondURL

Description: The second choice of URL to the XML device description file.

Visibility:

GenApi::IInteger& GevStreamChannelSelector

Description: Selects the stream channel to control.

Visibility:

GenApi::IBoolean& GevSupportedOption

Description: Returns if the selected GEV option is supported.

Visibility:

Description: Selects the GEV option to interrogate for existing support.

Visibility:

GenApi::IInteger& GevTimestampTickFrequency

Description: Indicates the number of timestamp ticks in 1 second (frequency in Hz).

Visibility:

GenApi::IInteger& GuiXmlManifestAddress

Description: Location of the GUI XML manifest table.

Visibility:

 Description: 

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

Visibility:

GenApi::IInteger& HeightMax

Description: Maximum height of the image (in pixels).

This dimension is calculated after vertical binning. HeightMax does not take into account the current Region of interest (Height or OffsetY). Visibility:

GenApi::IBoolean& ImageComponentEnable

Description: Controls if the selected component streaming is active.

Visibility: Beginner

Description: Selects a component to activate data streaming from.

Visibility: Beginner

GenApi::IFloat& ImageCompressionBitrate

Description: Control the rate of the produced compressed stream.

Visibility: Expert

Description: When JPEG is selected as the compression format, a device might optionally offer better control over JPEG-specific options through this feature.

Visibility: Expert

Description: Visibility:

GenApi::IInteger& ImageCompressionQuality

Description: Control the quality of the produced compressed stream.

Visibility: Expert

Description: Two rate controlling options are offered: fixed bit rate or fixed quality.

The exact implementation to achieve one or the other is vendor-specific. Visibility: Expert

GenApi::IBoolean& IspEnable

 Description: 

Controls whether the image processing core is used for optional pixel format mode (i.e.

mono).

Visibility: 
GenApi::IFloat& LineFilterWidth

Description: Filter width in microseconds for the selected line and filter combination Visibility:

Description: Displays the current electrical format of the selected physical input or output Line.

Visibility:

Description: Selects the kind of input filter to configure: Deglitch or Debounce.

Visibility:

GenApi::IBoolean& LineInverter

Description: Controls the inversion of the signal of the selected input or output line.

Visibility:

Description: Controls if the physical Line is used to Input or Output a signal.

Visibility:

GenApi::IInteger& LinePitch

Description: Total number of bytes between 2 successive lines.

This feature is used to facilitate alignment of image data. Visibility: Expert

Description: Selects the physical line (or pin) of the external device connector to configure Visibility:

Description: Selects which internal acquisition or I/O source signal to output on the selected line.

LineMode must be Output. Visibility:

GenApi::IBoolean& LineStatus

Description: Returns the current status of the selected input or output Line Visibility:

GenApi::IInteger& LineStatusAll

Description: Returns the current status of all the line status bits in a hexadecimal representation (Line 0 status corresponds to bit 0, Line 1 status with bit 1, etc).

This allows simultaneous reading of all line statuses at once. Visibility:

GenApi::IInteger& LinkErrorCount

Description: Counts the number of error on the link.

Visibility:

GenApi::IInteger& LinkUptime

Description: Time since the last phy negotiation (enumeration).

Visibility:

Description: Selects the activation mode of the Logic Input Source signal.

Visibility:

Description: Controls which LogicBlockLUT Input Source & Activation to access.

Visibility:

Description: Selects the source for the input into the Logic LUT.

Visibility:

GenApi::IBoolean& LogicBlockLUTOutputValue

Description: Controls the output column of the truth table for the selected LogicBlockLUTRowIndex.

Visibility:

GenApi::IInteger& LogicBlockLUTOutputValueAll

Description: Sets the value of all the output bits in the selected LUT.

Visibility:

GenApi::IInteger& LogicBlockLUTRowIndex

Description: Controls the row of the truth table to access in the selected LUT.

Visibility:

Description: Selects which LogicBlock LUT to configure Visibility:

Description: Selects which LogicBlock to configure Visibility:

GenApi::IBoolean& LUTEnable

 Description: 

Activates the selected LUT.

Visibility:

GenApi::IInteger& LUTIndex

 Description: 

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

Visibility:

 Description: 

Selects which LUT to control.

Visibility:

GenApi::IInteger& LUTValue

 Description: 

Returns the Value at entry LUTIndex of the LUT selected by LUTSelector.

Visibility:

GenApi::IRegister& LUTValueAll

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

Visibility: Guru

GenApi::IInteger& MaxDeviceResetTime

Description: Time to wait until device reset complete (ms).

Visibility:

GenApi::IInteger& OffsetX

 Description: 

Horizontal offset from the origin to the ROI (in pixels).

Visibility:

GenApi::IInteger& OffsetY

 Description: 

Vertical offset from the origin to the ROI (in pixels).

Visibility:

GenApi::IInteger& PacketResendRequestCount

Description: Counts the number of resend requests received from the host.

Visibility:

GenApi::IInteger& PayloadSize

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

Visibility:

Description: Type of color filter that is applied to the image.

Only applies to Bayer pixel formats. All others have no color filter.

Visibility:

GenApi::IInteger& PixelDynamicRangeMax

Description: Maximum value that can be returned during the digitization process.

This corresponds to the brightest value of the camera. For color cameras, this returns the biggest value that each color component can take.

Visibility:

GenApi::IInteger& PixelDynamicRangeMin

Description: Minimum value that can be returned during the digitization process.

This corresponds to the darkest value of the camera. For color cameras, this returns the smallest value that each color component can take.

Visibility:

Description: Format of the pixel provided by the camera.

Visibility:

GenApi::IInteger& PixelFormatInfoID

Description: Returns the value used by the streaming channels to identify the selected pixel format.

Visibility: Guru

Description: Select the pixel format for which the information will be returned.

Visibility: Guru

Description: Total size in bits of a pixel of the image.

Visibility:

GenApi::IFloat& PowerSupplyCurrent

 Description: 

Indicates the output current of the selected power supply (A).

Visibility:

GenApi::IFloat& PowerSupplyVoltage

 Description: 

Indicates the current voltage of the selected power supply (V).

Visibility:

Description: Control the destination of the selected region.

Visibility: Expert

Description: Controls if the selected Region of interest is active and streaming.

Visibility: Beginner

Description: Selects the Region of interest to control.

The RegionSelector feature allows devices that are able to extract multiple regions out of an image, to configure the features of those individual regions independently. Visibility: Beginner

GenApi::IBoolean& ReverseX

Description: Horizontally flips the image sent by the device.

The region of interest is applied after flipping. For color cameras the bayer pixel format is affected. For example, BayerRG16 changes to BayerGR16.

Visibility:

GenApi::IBoolean& ReverseY

Description: Vertically flips the image sent by the device.

The region of interest is applied after flipping. For color cameras the bayer pixel format is affected. For example, BayerRG16 changes to BayerGB16.

Visibility:

 Description: 

Used to select from a set of RGBtoRGB transform matricies calibrated for different light sources.

Selecting a value also sets the white balance ratios (BalanceRatioRed and BalanceRatioBlue), but those can be overwritten through manual or auto white balance.

 Visibility: 
GenApi::IFloat& Saturation

Description: Controls the color saturation.

Visibility:

GenApi::IBoolean& SaturationEnable

Description: Enables/disables Saturation adjustment.

Visibility:

GenApi::IFloat& Scan3dAxisMax

Description: Maximum valid transmitted coordinate value of the selected Axis.

Visibility: Expert

GenApi::IFloat& Scan3dAxisMin

Description: Minimum valid transmitted coordinate value of the selected Axis.

Visibility: Expert

GenApi::IFloat& Scan3dCoordinateOffset

Description: Offset when transforming a pixel from relative coordinates to world coordinates.

Visibility: Expert

Description: Sets the index to read a coordinate system reference value defining the transform of a point from the current (Anchor or Transformed) system to the reference system.

Visibility: Expert

GenApi::IFloat& Scan3dCoordinateReferenceValue

Description: Returns the reference value selected.

Reads the value of a rotation or translation value for the current (Anchor or Transformed) coordinate system transformation to the Reference system. Visibility: Expert

GenApi::IFloat& Scan3dCoordinateScale

Description: Scale factor when transforming a pixel from relative coordinates to world coordinates.

Visibility: Expert

Description: Selects the individual coordinates in the vectors for 3D information/transformation.

Visibility: Expert

Description: Specifies the Coordinate system to use for the device.

Visibility: Beginner

Description: Defines coordinate system reference location.

Visibility: Expert

Description: Sets the index to read/write a coordinate transform value.

Visibility: Expert

Description: Specifies the unit used when delivering calibrated distance data.

Visibility: Beginner

GenApi::IBoolean& Scan3dInvalidDataFlag

Description: Enables the definition of a non-valid flag value in the data stream.

Note that the confidence output is an alternate recommended way to identify non-valid pixels. Using an Scan3dInvalidDataValue may give processing penalties due to special handling. Visibility: Expert

GenApi::IFloat& Scan3dInvalidDataValue

Description: Value which identifies a non-valid pixel if Scan3dInvalidDataFlag is enabled.

Visibility: Expert

Description: Controls the Calibration and data organization of the device, naming the coordinates transmitted.

Visibility: Expert

GenApi::IFloat& Scan3dTransformValue

Description: Specifies the transform value selected.

For translations (Scan3dCoordinateTransformSelector = TranslationX/Y/Z) it is expressed in the distance unit of the system, for rotations (Scan3dCoordinateTransformSelector =RotationX/Y/Z) in degrees. Visibility: Expert

GenApi::IString& SensorDescription

Description: Returns Sensor Description Visibility:

Description: Number of digitized samples outputted simultaneously by the camera A/D conversion stage.

Visibility: Expert

GenApi::IInteger& SensorHeight

Description: Effective height of the sensor in pixels.

Visibility:

Description: Sets the shutter mode of the device.

Visibility:

Description: Number of taps of the camera sensor.

Visibility: Expert

GenApi::IInteger& SensorWidth

Description: Effective width of the sensor in pixels.

Visibility:

 Description: 

Controls whether or not a sequencer is in configuration mode.

Visibility:

 Description: 

Display whether the current sequencer configuration is valid to run.

Visibility:

GenApi::IBoolean& SequencerFeatureEnable

 Description: 

Enables the selected feature and makes it active in all sequencer sets.

Visibility:

Description: Controls whether or not a sequencer is active.

Visibility:

GenApi::IInteger& SequencerPathSelector

 Description: 

Selects branching path to be used for subsequent settings.

Visibility:

GenApi::IInteger& SequencerSetActive

Description: Displays the currently active sequencer set.

Visibility:

GenApi::ICommand& SequencerSetLoad

 Description: 

Loads currently selected sequencer to the current device configuration.

Visibility:

GenApi::IInteger& SequencerSetNext

Description: Specifies the next sequencer set.

Visibility:

GenApi::ICommand& SequencerSetSave

 Description: 

Saves the current device configuration to the currently selected sequencer set.

Visibility:

GenApi::IInteger& SequencerSetSelector

 Description: 

Selects the sequencer set to which subsequent settings apply.

Visibility:

GenApi::IInteger& SequencerSetStart

Description: Sets the first sequencer set to be used.

Visibility:

 Description: 

Displays whether the currently selected sequencer set's register contents are valid to use.

Visibility:

 Description: 

Specifies the activation mode of the sequencer trigger.

Visibility:

 Description: 

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

Visibility:

Description: This feature controls the baud rate used by the selected serial port.

Visibility:

GenApi::IInteger& SerialPortDataBits

Description: This feature controls the number of data bits used by the selected serial port.

Possible values that can be used are between 5 and 9. Visibility:

Description: This feature controls the parity used by the selected serial port.

Visibility:

Description: Selects which serial port of the device to control.

Visibility:

Description: Specifies the physical input Line on which to receive serial data.

Visibility:

Description: This feature controls the number of stop bits used by the selected serial port.

Visibility:

GenApi::IInteger& SerialReceiveFramingErrorCount

Description: Returns the number of framing errors that have occurred on the serial port.

Visibility:

GenApi::IInteger& SerialReceiveParityErrorCount

Description: Returns the number of parity errors that have occurred on the serial port.

Visibility:

GenApi::ICommand& SerialReceiveQueueClear

Description: This is a command that clears the device serial port receive queue.

Visibility:

GenApi::IInteger& SerialReceiveQueueCurrentCharacterCount

Description: Returns the number of characters currently in the serial port receive queue.

Visibility:

GenApi::IInteger& SerialReceiveQueueMaxCharacterCount

Description: >Returns the maximum number of characters in the serial port receive queue.

Visibility:

GenApi::IInteger& SerialTransmitQueueCurrentCharacterCount

Description: Returns the number of characters currently in the serial port transmit queue.

Visibility:

GenApi::IInteger& SerialTransmitQueueMaxCharacterCount

Description: >Returns the maximum number of characters in the serial port transmit queue.

Visibility:

GenApi::IFloat& Sharpening

 Description: 

Controls the amount to sharpen a signal.

The sharpened amount is proportional to the difference between a pixel and its neighbors. A negative value smooths out the difference, while a positive value amplifies the difference. You can boost by a maximum of 8x, but smoothing is limited to 1x (in float). Default value: 2.0

 Visibility: 
GenApi::IBoolean& SharpeningAuto

 Description: 

Enables/disables the auto sharpening feature.

When enabled, the camera automatically determines the sharpening threshold based on the noise level of the camera.

Visibility: 
GenApi::IBoolean& SharpeningEnable

 Description: 

Enables/disables the sharpening feature.

Sharpening is disabled by default.

Visibility: 
GenApi::IFloat& SharpeningThreshold

 Description: 

Controls the minimum intensity gradient change to invoke sharpening.

When "Sharpening Auto" is enabled, this is determined automatically by the device. The threshold is specified as a fraction of the total intensity range, and ranges from 0 to 0.25. A threshold higher than 25% produces little to no difference than 25%. High thresholds sharpen only areas with significant intensity changes. Low thresholds sharpen more areas.

Visibility:

GenApi::ICommand& SoftwareSignalPulse

Description: Generates a pulse signal that can be used as a software trigger.

This command can be used to trigger other modules that accept a SoftwareSignal as trigger source. Visibility: Beginner

Description: Selects which Software Signal features to control.

Visibility: Beginner

GenApi::IInteger& SourceCount

Description: Controls or returns the number of sources supported by the device.

Visibility: Beginner

Description: Selects the source to control.

Visibility: Beginner

GenApi::IInteger& Test0001

Description: For testing only.

Visibility:

GenApi::ICommand& TestEventGenerate

Description: This command generates a test event and sends it to the host.

Visibility:

 Description: 

Selects the type of test pattern that is generated by the device as image source.

Visibility:

 Description: 

Selects which test pattern generator is controlled by the TestPattern feature.

Visibility:

GenApi::IInteger& TestPendingAck

Description: Tests the device's pending acknowledge feature.

When this feature is written, the device waits a time period corresponding to the value of TestPendingAck before acknowledging the write. Visibility: Guru

GenApi::IFloat& TimerDelay

Description: Sets the duration (in microseconds) of the delay to apply at the reception of a trigger before starting the Timer.

Visibility: Expert

GenApi::IFloat& TimerDuration

Description: Sets the duration (in microseconds) of the Timer pulse.

Visibility: Expert

GenApi::ICommand& TimerReset

Description: Does a software reset of the selected timer and starts it.

The timer starts immediately after the reset unless a timer trigger is active. Visibility: Expert

Description: Selects which Timer to configure.

Visibility: Expert

Description: Returns the current status of the Timer.

Visibility: Expert

Description: Selects the activation mode of the trigger to start the Timer.

Visibility: Expert

Description: Selects the source of the trigger to start the Timer.

Visibility: Expert

GenApi::IFloat& TimerValue

Description: Reads or writes the current value (in microseconds) of the selected Timer.

Visibility: Expert

GenApi::IInteger& Timestamp

Description: Reports the current value of the device timestamp counter.

Visibility: Expert

GenApi::ICommand& TimestampLatch

Description: Latches the current timestamp counter into TimestampLatchValue.

Visibility:

GenApi::IInteger& TimestampLatchValue

Description: Returns the latched value of the timestamp counter.

Visibility:

GenApi::ICommand& TimestampReset

Description: Resets the current value of the device timestamp counter.

Visibility:

GenApi::IInteger& TLParamsLocked

Description: Visibility:

GenApi::ICommand& TransferAbort

Description: Aborts immediately the streaming of data block(s).

Aborting the transfer will result in the lost of the data that is present or currently entering in the block queue. However, the next new block received will be stored in the queue and transferred to the host when the streaming is restarted. If implemented, this feature should be available when the TransferControlMode is set to "UserControlled". Visibility: Expert

GenApi::IInteger& TransferBlockCount

Description: Specifies the number of data blocks (images) that the device should stream before stopping.

This feature is only active if the Transfer Operation Mode is set to Multi Block. Visibility:

GenApi::IInteger& TransferBurstCount

Description: Number of Block(s) to transfer for each TransferBurstStart trigger.

Visibility: Expert

Description: Selects the color component for the control of the TransferStreamChannel feature.

Visibility: Guru

Description: Selects the control method for the transfers.

Basic and Automatic start transmitting data as soon as there is enough data to fill a link layer packet. User Controlled allows you to directly control the transfer of blocks. Visibility:

Description: Selects the operation mode of the transfer.

Continuous is similar to Basic/Automatic but you can start/stop the transfer while acquisition runs independently. Multi Block transmits a specified number of blocks and then stops. Visibility:

GenApi::ICommand& TransferPause

Description: Pauses the streaming of data Block(s).

Pausing the streaming will immediately suspend the ongoing data transfer even if a block is partially transfered. The device will resume its transmission at the reception of a TransferResume command. Visibility: Guru

GenApi::IInteger& TransferQueueCurrentBlockCount

Description: Returns number of data blocks (images) currently in the transfer queue.

Visibility:

GenApi::IInteger& TransferQueueMaxBlockCount

Description: Returns the maximum number of data blocks (images) in the transfer queue Visibility:

Description: Specifies the operation mode of the transfer queue.

Visibility:

GenApi::IInteger& TransferQueueOverflowCount

Description: Returns number of images that have been lost before being transmitted because the transmit queue hasn't been cleared fast enough.

Visibility:

GenApi::ICommand& TransferResume

Description: Resumes a data Blocks streaming that was previously paused by a TransferPause command.

Visibility: Guru

Description: Selects which stream transfers are currently controlled by the selected Transfer features.

Visibility: Expert

GenApi::ICommand& TransferStart

Description: Starts the streaming of data blocks (images) out of the device.

This feature is available when the Transfer Control Mode is set to User Controlled. Visibility:

GenApi::IBoolean& TransferStatus

Description: Reads the status of the Transfer module signal selected by TransferStatusSelector.

Visibility: Guru

Description: Selects which status of the transfer module to read.

Visibility: Guru

GenApi::ICommand& TransferStop

Description: Stops the streaming of data block (images).

The current block transmission is completed. This feature is available when the Transfer Control Mode is set to User Controlled. Visibility:

GenApi::IInteger& TransferStreamChannel

Description: Selects the streaming channel that will be used to transfer the selected stream of data.

In general, this feature can be omitted and the default streaming channel will be used. Visibility: Guru

Description: Specifies the activation mode of the transfer control trigger.

Visibility: Guru

Description: Controls if the selected trigger is active.

Visibility: Guru

Description: Selects the type of transfer trigger to configure.

Visibility: Guru

Description: Specifies the signal to use as the trigger source for transfers.

Visibility: Guru

Description: Specifies the activation mode of the trigger.

Visibility:

GenApi::IFloat& TriggerDelay

 Description: 

Specifies the delay in microseconds (us) to apply after the trigger reception before activating it.

Visibility:

GenApi::IInteger& TriggerDivider

Description: Specifies a division factor for the incoming trigger pulses.

Visibility: Expert

GenApi::ICommand& TriggerEventTest

Description: This command generates a test event and sends it to the host.

Visibility:

 Description: 

Controls whether or not trigger is active.

Visibility:

GenApi::IInteger& TriggerMultiplier

Description: Specifies a multiplication factor for the incoming trigger pulses.

It is used generally used in conjunction with TriggerDivider to control the ratio of triggers that are accepted. Visibility: Expert

Description: Specifies the overlap mode of the trigger.

Visibility:

Description: Selects the type of trigger to configure.

Visibility:

GenApi::ICommand& TriggerSoftware

 Description: 

Generates an internal trigger if Trigger Source is set to Software.

Visibility:

 Description: 

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

Visibility:

Description: Selects which bit of the User Output register is set by UserOutputValue.

Visibility:

GenApi::IBoolean& UserOutputValue

Description: Value of the selected user output, either logic high (enabled) or logic low (disabled).

Visibility:

GenApi::IInteger& UserOutputValueAll

Description: Returns the current status of all the user output status bits in a hexadecimal representation (UserOutput 0 status corresponds to bit 0, UserOutput 1 status with bit 1, etc).

This allows simultaneous reading of all user output statuses at once. Visibility:

GenApi::IInteger& UserOutputValueAllMask

Description: Sets the write mask to apply to the value specified by UserOutputValueAll before writing it in the User Output register.

If the UserOutputValueAllMask feature is present, setting the user Output register using UserOutputValueAll will only change the bits that have a corresponding bit in the mask set to one. Visibility: Expert

 Description: 

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

Visibility:

GenApi::IBoolean& UserSetFeatureEnable

Description: Whether or not the selected feature is saved to user sets.

Visibility:

GenApi::ICommand& UserSetLoad

 Description: 

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

Visibility:

GenApi::ICommand& UserSetSave

 Description: 

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

Visibility:

 Description: 

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

Visibility:

GenApi::IBoolean& V3_3Enable

Description: Internally generated 3.3V rail.

Enable to supply external circuits with power. This is different than standard logic outputs in that it is comparatively slow to switch but can supply a more significant amount of power. This is only available on some pins. Visibility:

GenApi::IFloat& WhiteClip

Description: Controls the maximal intensity taken by the video signal before being clipped as an absolute physical value.

The video signal will never exceed the white clipping point: it will saturate at that level. Visibility: Expert

Description: Selects which White Clip to control.

Visibility: Expert

 Description: 

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

Visibility:

GenApi::IInteger& WidthMax

 Description: 

Maximum width of the image (in pixels).

The dimension is calculated after horizontal binning. WidthMax does not take into account the current Region of interest (Width or OffsetX).

 Visibility: 

The documentation for this class was generated from the following file:
Contact Support Spinnaker® SDK Programmer's Guide and API Reference