IDS peak comfortC  v1.3.0
ids_peak_comfort_c.h
Go to the documentation of this file.
1 
9 #ifndef PEAK_COMFORT_C_H
10 #define PEAK_COMFORT_C_H
11 
12 /* Function declaration modifiers */
13 #if defined(_WIN32)
14 # ifndef PEAK_NO_DECLSPEC_STATEMENTS
15 # ifdef paiconstant_EXPORTING
16 # define PEAK_EXPORT __declspec(dllexport)
17 # else
18 # define PEAK_EXPORT __declspec(dllimport)
19 # endif
20 # else
21 # define PEAK_EXPORT
22 # endif
23 # if defined(_M_IX86) || defined(__i386__)
24 # define PEAK_CALLCONV __cdecl
25 # else
26 # define PEAK_CALLCONV
27 # endif
28 #elif defined(__linux__)
29 # define PEAK_EXPORT
30 # if defined(__i386__)
31 # define PEAK_CALLCONV __attribute__((cdecl))
32 # else
33 # define PEAK_CALLCONV
34 # endif
35 #else
36 # error Platform is not supported yet!
37 #endif
38 
39 #ifdef __cplusplus
40 # include <cstddef>
41 # include <cstdint>
42 
43 extern "C" {
44 #else
45 # include <stddef.h>
46 # include <stdint.h>
47 #endif
48 
49 /* helper entities */
50 struct peak_camera;
51 struct peak_frame;
52 struct peak_video;
53 
54 #define PEAK_VERSION_CODE(major,minor,subminor,patch) (((major) << 24) + ((minor) << 16) + ((subminor) << 8) + (patch))
55 #define PEAK_API_STATUS PEAK_EXPORT peak_status PEAK_CALLCONV
56 #define PEAK_API_ACCESS_STATUS PEAK_EXPORT peak_access_status PEAK_CALLCONV
57 #define PEAK_API_BOOL PEAK_EXPORT peak_bool PEAK_CALLCONV
58 #define PEAK_API_CAMERA_ID PEAK_EXPORT peak_camera_id PEAK_CALLCONV
59 
522 #define PEAK_INVALID_HANDLE NULL
523 
536 #define PEAK_INFINITE 0xffffffff
537 
545 typedef uint8_t peak_bool;
546 
554 #define PEAK_TRUE 1
555 
563 #define PEAK_FALSE 0
564 
565 #pragma pack(push, 1)
566 
572 typedef struct
573 {
575  uint8_t* memoryAddress;
576 
578  size_t memorySize;
579 
587  void* userContext;
588 
589 } peak_buffer;
590 #pragma pack(pop)
591 
592 #pragma pack(push, 1)
593 
601 typedef struct
602 {
604  uint32_t width;
605 
607  uint32_t height;
608 
609 } peak_size;
610 #pragma pack(pop)
611 
612 #pragma pack(push, 1)
613 
621 typedef struct
622 {
624  uint32_t x;
625 
627  uint32_t y;
628 
629 } peak_position;
630 #pragma pack(pop)
631 
632 #pragma pack(push, 1)
633 
637 typedef struct
638 {
641 
644 
645 } peak_roi;
646 #pragma pack(pop)
647 
648 #pragma pack(push, 1)
649 
664 typedef union
665 {
667  struct
668  {
670  double element_00;
671 
673  double element_01;
674 
676  double element_02;
677 
679  double element_10;
680 
682  double element_11;
683 
685  double element_12;
686 
688  double element_20;
689 
691  double element_21;
692 
694  double element_22;
695 
696  } elements;
697 
699  double elementArray[3][3];
700 
701 } peak_matrix;
702 #pragma pack(pop)
703 
710 #define PEAK_IDENTITY_MATRIX { 1.0, 0.0, 0.0, \
711  0.0, 1.0, 0.0, \
712  0.0, 0.0, 1.0 }
713 
720 typedef enum
721 {
724 
727 
734 
741 
747 
750 
753 
756 
759 
762 
765 
768 
771 
774 
777 
780 
783 
786 
789 
790 } peak_status;
791 
803 #define PEAK_SUCCESS(status) ((((status) & 0xf000) == 0x0000) ? PEAK_TRUE : PEAK_FALSE)
804 
816 #define PEAK_WARNING(status) ((((status) & 0xf000) == 0x4000) ? PEAK_TRUE : PEAK_FALSE)
817 
829 #define PEAK_ERROR(status) ((((status) & 0xf000) == 0x8000) ? PEAK_TRUE : PEAK_FALSE)
830 
839 typedef enum
840 {
849 
857 
863 
870 
876 
882 
888 
890 
905 #define PEAK_IS_WRITEABLE(accessStatus) ((((accessStatus) & 0x2000) == 0x2000) ? PEAK_TRUE : PEAK_FALSE)
906 
921 #define PEAK_IS_READABLE(accessStatus) ((((accessStatus) & 0x1000) == 0x1000) ? PEAK_TRUE : PEAK_FALSE)
922 
937 PEAK_API_STATUS peak_Library_Init();
938 
954 PEAK_API_STATUS peak_Library_Exit();
955 
973 PEAK_API_STATUS peak_Library_GetVersion(uint32_t* majorVersion, uint32_t* minorVersion, uint32_t* subminorVersion,
974  uint32_t* patchVersion);
975 
1016 PEAK_API_STATUS peak_Library_GetLastError(peak_status* lastErrorCode, char* lastErrorMessage,
1017  size_t* lastErrorMessageSize);
1018 
1025 typedef enum
1026 {
1032 
1035 
1038 
1041 
1044 
1046 
1058 typedef struct peak_camera* peak_camera_handle;
1059 
1073 typedef uint64_t peak_camera_id;
1074 
1081 #define PEAK_INVALID_CAMERA_ID UINT64_C(0)
1082 
1083 #pragma pack(push, 1)
1084 
1093 typedef struct
1094 {
1096  peak_camera_id cameraID;
1097 
1100 
1105  char modelName[64];
1106 
1111  char serialNumber[64];
1112 
1120  char userDefinedName[64];
1121 
1122  uint8_t reserved[448];
1123 
1125 #pragma pack(pop)
1126 
1146 PEAK_API_STATUS peak_CameraList_Update(size_t* cameraCount);
1147 
1179 PEAK_API_STATUS peak_CameraList_Get(peak_camera_descriptor* cameraList, size_t* cameraCount);
1180 
1200 PEAK_API_CAMERA_ID peak_Camera_ID_FromHandle(peak_camera_handle hCam);
1201 
1222 PEAK_API_CAMERA_ID peak_Camera_ID_FromSerialNumber(const char* serialNumber);
1223 
1246 PEAK_API_CAMERA_ID peak_Camera_ID_FromUserDefinedName(const char* userDefinedName);
1247 
1248 #pragma pack(push, 1)
1249 
1261 typedef union
1262 {
1264  uint8_t octets[6];
1265 
1267  struct
1268  {
1270  uint16_t high_part;
1271 
1273  uint32_t low_part;
1274 
1275  } parts;
1276 
1278 #pragma pack(pop)
1279 
1299 PEAK_API_CAMERA_ID peak_Camera_ID_FromMAC(peak_mac_address macAddress);
1300 
1321 PEAK_API_ACCESS_STATUS peak_Camera_GetAccessStatus(peak_camera_id cameraID);
1322 
1338 PEAK_API_STATUS peak_Camera_GetDescriptor(peak_camera_id cameraID, peak_camera_descriptor* cameraDescriptor);
1339 
1358 PEAK_API_STATUS peak_Camera_Open(peak_camera_id cameraID, peak_camera_handle* hCam);
1359 
1377 PEAK_API_STATUS peak_Camera_OpenFirstAvailable(peak_camera_handle* hCam);
1378 
1394 PEAK_API_STATUS peak_Camera_Close(peak_camera_handle hCam);
1395 
1410 PEAK_API_STATUS peak_Camera_ResetToDefaultSettings(peak_camera_handle hCam);
1411 
1440 PEAK_API_STATUS peak_Camera_UserDefinedName_Set(peak_camera_handle hCam, const char* userDefinedName);
1441 
1473 PEAK_API_STATUS peak_Camera_UserDefinedName_Get(peak_camera_handle hCam, char* userDefinedName,
1474  size_t* userDefinedNameSize);
1475 
1476 #pragma pack(push, 1)
1477 
1489 typedef union
1490 {
1492  uint32_t addr;
1493 
1495  uint8_t parts[4];
1496 
1497 } peak_ip_address;
1498 #pragma pack (pop)
1499 
1500 #pragma pack (push, 1)
1501 
1507 typedef struct
1508 {
1511 
1514 
1515  uint8_t reserved[4];
1516 
1517 } peak_ip_config;
1518 #pragma pack (pop)
1519 
1526 typedef enum
1527 {
1533 
1539 
1545 
1553 
1562 
1564 
1565 #pragma pack (push, 1)
1566 
1574 typedef struct
1575 {
1578 
1581 
1584 
1587 
1590 
1591  uint8_t reservedCamera[64];
1592 
1595 
1598 
1599  uint8_t reserved[64];
1600 
1602 #pragma pack (pop)
1603 
1634 PEAK_API_ACCESS_STATUS peak_EthernetConfig_GetAccessStatus(peak_camera_id cameraID);
1635 
1653 PEAK_API_STATUS peak_EthernetConfig_GetInfo(peak_camera_id cameraID, peak_ethernet_info* ethernetInfo);
1654 
1683 PEAK_API_ACCESS_STATUS peak_EthernetConfig_DHCP_GetAccessStatus(peak_camera_id cameraID);
1684 
1716 PEAK_API_STATUS peak_EthernetConfig_DHCP_Enable(peak_camera_id cameraID, peak_bool enabled);
1717 
1731 PEAK_API_BOOL peak_EthernetConfig_DHCP_IsEnabled(peak_camera_id cameraID);
1732 
1764 PEAK_API_ACCESS_STATUS peak_EthernetConfig_PersistentIP_GetAccessStatus(peak_camera_id cameraID);
1765 
1791 PEAK_API_STATUS peak_EthernetConfig_PersistentIP_Set(peak_camera_id cameraID, peak_ip_config persistentIP);
1792 
1811 PEAK_API_STATUS peak_EthernetConfig_PersistentIP_Get(peak_camera_id cameraID, peak_ip_config* persistentIP);
1812 
1833 typedef struct peak_frame* peak_frame_handle;
1834 
1842 #pragma pack(push, 1)
1843 typedef struct
1844 {
1851  uint32_t numUnderrun;
1852 
1859  uint32_t numDropped;
1860 
1867  uint32_t numIncomplete;
1868 
1875  double fps;
1876 
1877  uint8_t reserved[256];
1878 
1880 #pragma pack(pop)
1881 
1925 PEAK_API_STATUS peak_Acquisition_Start(peak_camera_handle hCam, uint32_t numberOfFrames);
1926 
1949 PEAK_API_STATUS peak_Acquisition_Stop(peak_camera_handle hCam);
1950 
1966 PEAK_API_BOOL peak_Acquisition_IsStarted(peak_camera_handle hCam);
1967 
2002 PEAK_API_STATUS peak_Acquisition_WaitForFrame(peak_camera_handle hCam, uint32_t timeout_ms, peak_frame_handle* hFrame);
2003 
2021 PEAK_API_STATUS peak_Acquisition_GetInfo(peak_camera_handle hCam, peak_acquisition_info* acquisitionInfo);
2022 
2039 PEAK_API_STATUS peak_Acquisition_Buffer_GetRequiredSize(peak_camera_handle hCam, size_t* requiredBufferSize);
2040 
2056 PEAK_API_STATUS peak_Acquisition_Buffer_GetRequiredCount(peak_camera_handle hCam, size_t* requiredBufferCount);
2057 
2092 PEAK_API_STATUS peak_Acquisition_Buffer_Announce(peak_camera_handle hCam, uint8_t* memoryAddress, size_t memorySize,
2093  void* userContext);
2094 
2117 PEAK_API_STATUS peak_Acquisition_Buffer_Revoke(peak_camera_handle hCam, uint8_t* memoryAddress);
2118 
2138 PEAK_API_STATUS peak_Acquisition_Buffer_RevokeAll(peak_camera_handle hCam);
2139 
2146 typedef enum
2147 {
2153 
2156 
2159 
2162 
2165 
2168 
2171 
2174 
2177 
2180 
2183 
2186 
2189 
2192 
2195 
2198 
2201 
2204 
2207 
2210 
2213 
2216 
2219 
2222 
2225 
2228 
2231 
2234 
2237 
2240 
2243 
2246 
2249 
2252 
2255 
2258 
2261 
2264 
2267 
2270 
2276 
2282 
2288 
2294 
2300 
2306 
2312 
2318 
2324 
2330 
2332 
2333 #pragma pack(push, 1)
2334 
2340 typedef struct
2341 {
2347 
2353 
2358  uint32_t numChannels;
2359 
2365 
2371 
2377 
2378  uint8_t reserved[64];
2379 
2381 #pragma pack(pop)
2382 
2399 PEAK_API_STATUS peak_PixelFormat_GetInfo(peak_pixel_format pixelFormat, peak_pixel_format_info* pixelFormatInfo);
2400 
2421 PEAK_API_STATUS peak_Frame_Release(peak_camera_handle hCam, peak_frame_handle hFrame);
2422 
2429 typedef enum
2430 {
2436 
2443 
2444 } peak_frame_type;
2445 
2452 #pragma pack(push, 1)
2453 typedef struct
2454 {
2457 
2460 
2468  uint64_t frameID;
2469 
2474  uint64_t timestamp_ns;
2475 
2478 
2481 
2486  peak_bool isComplete;
2487 
2494 
2503 
2509 
2510  uint8_t reserved[256];
2511 
2512 } peak_frame_info;
2513 #pragma pack(pop)
2514 
2530 PEAK_API_STATUS peak_Frame_GetInfo(peak_frame_handle hFrame, peak_frame_info* frameInfo);
2531 
2547 PEAK_API_STATUS peak_Frame_Type_Get(peak_frame_handle hFrame, peak_frame_type* frameType);
2548 
2564 PEAK_API_STATUS peak_Frame_Buffer_Get(peak_frame_handle hFrame, peak_buffer* buffer);
2565 
2581 PEAK_API_STATUS peak_Frame_ID_Get(peak_frame_handle hFrame, uint64_t* frameID);
2582 
2598 PEAK_API_STATUS peak_Frame_Timestamp_Get(peak_frame_handle hFrame, uint64_t* timestamp_ns);
2599 
2615 PEAK_API_STATUS peak_Frame_ROI_Get(peak_frame_handle hFrame, peak_roi* roi);
2616 
2632 PEAK_API_STATUS peak_Frame_PixelFormat_Get(peak_frame_handle hFrame, peak_pixel_format* pixelFormat);
2633 
2648 PEAK_API_BOOL peak_Frame_IsComplete(peak_frame_handle hFrame);
2649 
2665 PEAK_API_STATUS peak_Frame_BytesExpected_Get(peak_frame_handle hFrame, size_t* bytesExpected);
2666 
2682 PEAK_API_STATUS peak_Frame_BytesWritten_Get(peak_frame_handle hFrame, size_t* bytesWritten);
2683 
2699 PEAK_API_STATUS peak_Frame_ProcessingTime_Get(peak_frame_handle hFrame, uint32_t* processingTime_ms);
2700 
2716 typedef enum
2717 {
2723 
2729 
2735 
2741 
2748 
2755 
2757 
2785 PEAK_API_ACCESS_STATUS peak_CameraSettings_ParameterSet_GetAccessStatus(peak_camera_handle hCam,
2786  peak_parameter_set parameterSet);
2787 
2826 PEAK_API_STATUS peak_CameraSettings_ParameterSet_GetList(peak_camera_handle hCam, peak_parameter_set* parameterSetList,
2827  size_t* parameterSetCount);
2828 
2852 PEAK_API_STATUS peak_CameraSettings_ParameterSet_Store(peak_camera_handle hCam, peak_parameter_set parameterSet);
2853 
2875 PEAK_API_STATUS peak_CameraSettings_ParameterSet_Apply(peak_camera_handle hCam, peak_parameter_set parameterSet);
2876 
2901 PEAK_API_ACCESS_STATUS peak_CameraSettings_ParameterSet_Startup_GetAccessStatus(peak_camera_handle hCam);
2902 
2927 PEAK_API_STATUS peak_CameraSettings_ParameterSet_Startup_Set(peak_camera_handle hCam, peak_parameter_set parameterSet);
2928 
2947 PEAK_API_STATUS peak_CameraSettings_ParameterSet_Startup_Get(peak_camera_handle hCam, peak_parameter_set* parameterSet);
2948 
2974 PEAK_API_ACCESS_STATUS peak_CameraSettings_DiskFile_GetAccessStatus(peak_camera_handle hCam);
2975 
2998 PEAK_API_STATUS peak_CameraSettings_DiskFile_Store(peak_camera_handle hCam, const char* file);
2999 
3022 PEAK_API_STATUS peak_CameraSettings_DiskFile_Apply(peak_camera_handle hCam, const char* file);
3023 
3048 PEAK_API_ACCESS_STATUS peak_FrameRate_GetAccessStatus(peak_camera_handle hCam);
3049 
3072 PEAK_API_STATUS peak_FrameRate_GetRange(peak_camera_handle hCam, double* minFrameRate_fps, double* maxFrameRate_fps,
3073  double* incFrameRate_fps);
3074 
3093 PEAK_API_STATUS peak_FrameRate_Set(peak_camera_handle hCam, double frameRate_fps);
3094 
3112 PEAK_API_STATUS peak_FrameRate_Get(peak_camera_handle hCam, double* frameRate_fps);
3113 
3138 PEAK_API_ACCESS_STATUS peak_ExposureTime_GetAccessStatus(peak_camera_handle hCam);
3139 
3162 PEAK_API_STATUS peak_ExposureTime_GetRange(peak_camera_handle hCam, double* minExposureTime_us,
3163  double* maxExposureTime_us, double* incExposureTime_us);
3164 
3183 PEAK_API_STATUS peak_ExposureTime_Set(peak_camera_handle hCam, double exposureTime_us);
3184 
3202 PEAK_API_STATUS peak_ExposureTime_Get(peak_camera_handle hCam, double* exposureTime_us);
3203 
3228 PEAK_API_ACCESS_STATUS peak_PixelClock_GetAccessStatus(peak_camera_handle hCam);
3229 
3243 PEAK_API_BOOL peak_PixelClock_HasRange(peak_camera_handle hCam);
3244 
3270 PEAK_API_STATUS peak_PixelClock_GetRange(peak_camera_handle hCam, double* minPixelClock_MHz, double* maxPixelClock_MHz,
3271  double* incPixelClock_MHz);
3272 
3313 PEAK_API_STATUS peak_PixelClock_GetList(peak_camera_handle hCam, double* pixelClockList, size_t* pixelClockCount);
3314 
3335 PEAK_API_STATUS peak_PixelClock_Set(peak_camera_handle hCam, double pixelClock_MHz);
3336 
3354 PEAK_API_STATUS peak_PixelClock_Get(peak_camera_handle hCam, double* pixelClock_MHz);
3355 
3365 typedef enum
3366 {
3372 
3378 
3384 
3390 
3396 
3402 
3408 
3409 } peak_io_channel;
3410 
3439 PEAK_API_ACCESS_STATUS peak_IOChannel_GetAccessStatus(peak_camera_handle hCam, peak_io_channel ioChannel);
3440 
3472 PEAK_API_STATUS peak_IOChannel_GetList(peak_camera_handle hCam, peak_io_channel* ioChannelList, size_t* ioChannelCount);
3473 
3501 PEAK_API_ACCESS_STATUS peak_IOChannel_Level_GetAccessStatus(peak_camera_handle hCam, peak_io_channel ioChannel);
3502 
3517 PEAK_API_BOOL peak_IOChannel_Level_IsHigh(peak_camera_handle hCam, peak_io_channel ioChannel);
3518 
3547 PEAK_API_ACCESS_STATUS peak_IOChannel_Inverter_GetAccessStatus(peak_camera_handle hCam, peak_io_channel ioChannel);
3548 
3567 PEAK_API_STATUS peak_IOChannel_Inverter_Enable(peak_camera_handle hCam, peak_io_channel ioChannel, peak_bool enabled);
3568 
3583 PEAK_API_BOOL peak_IOChannel_Inverter_IsEnabled(peak_camera_handle hCam, peak_io_channel ioChannel);
3584 
3614 PEAK_API_ACCESS_STATUS peak_IOChannel_NoiseFilter_GetAccessStatus(peak_camera_handle hCam, peak_io_channel ioChannel);
3615 
3634 PEAK_API_STATUS peak_IOChannel_NoiseFilter_Enable(peak_camera_handle hCam, peak_io_channel ioChannel,
3635  peak_bool enabled);
3636 
3651 PEAK_API_BOOL peak_IOChannel_NoiseFilter_IsEnabled(peak_camera_handle hCam, peak_io_channel ioChannel);
3652 
3678 PEAK_API_STATUS peak_IOChannel_NoiseFilter_Duration_GetRange(peak_camera_handle hCam, peak_io_channel ioChannel,
3679  double* minNoiseFilterDuration_us, double* maxNoiseFilterDuration_us, double* incNoiseFilterDuration_us);
3680 
3702 PEAK_API_STATUS peak_IOChannel_NoiseFilter_Duration_Set(peak_camera_handle hCam, peak_io_channel ioChannel,
3703  double noiseFilterDuration_us);
3704 
3724 PEAK_API_STATUS peak_IOChannel_NoiseFilter_Duration_Get(peak_camera_handle hCam, peak_io_channel ioChannel,
3725  double* noiseFilterDuration_us);
3726 
3733 typedef enum
3734 {
3740 
3746 
3752 
3754 
3776 typedef struct
3777 {
3783 
3789 
3791 
3807 #define PEAK_TRIGGER_MODE_HARDWARE_TRIGGER { PEAK_TRIGGER_TARGET_FRAME_START, PEAK_IO_CHANNEL_TRIGGER_INPUT }
3808 
3822 #define PEAK_TRIGGER_MODE_SOFTWARE_TRIGGER { PEAK_TRIGGER_TARGET_FRAME_START, PEAK_IO_CHANNEL_SOFTWARE }
3823 
3848 PEAK_API_ACCESS_STATUS peak_Trigger_GetAccessStatus(peak_camera_handle hCam);
3849 
3869 PEAK_API_STATUS peak_Trigger_Enable(peak_camera_handle hCam, peak_bool enabled);
3870 
3884 PEAK_API_BOOL peak_Trigger_IsEnabled(peak_camera_handle hCam);
3885 
3901 PEAK_API_BOOL peak_Trigger_IsExecutable(peak_camera_handle hCam);
3902 
3925 PEAK_API_STATUS peak_Trigger_Execute(peak_camera_handle hCam);
3926 
3956 PEAK_API_ACCESS_STATUS peak_Trigger_Mode_GetAccessStatus(peak_camera_handle hCam, peak_trigger_mode triggerMode);
3957 
3986 PEAK_API_STATUS peak_Trigger_Mode_Set(peak_camera_handle hCam, peak_trigger_mode triggerMode);
3987 
4006 PEAK_API_STATUS peak_Trigger_Mode_Get(peak_camera_handle hCam, peak_trigger_mode* triggerMode);
4007 
4016 typedef enum
4017 {
4023 
4029 
4035 
4041 
4043 
4070 PEAK_API_ACCESS_STATUS peak_Trigger_Edge_GetAccessStatus(peak_camera_handle hCam);
4071 
4110 PEAK_API_STATUS peak_Trigger_Edge_GetList(peak_camera_handle hCam, peak_trigger_edge* triggerEdgeList,
4111  size_t* triggerEdgeCount);
4112 
4133 PEAK_API_STATUS peak_Trigger_Edge_Set(peak_camera_handle hCam, peak_trigger_edge triggerEdge);
4134 
4153 PEAK_API_STATUS peak_Trigger_Edge_Get(peak_camera_handle hCam, peak_trigger_edge* triggerEdge);
4154 
4181 PEAK_API_ACCESS_STATUS peak_Trigger_Delay_GetAccessStatus(peak_camera_handle hCam);
4182 
4207 PEAK_API_STATUS peak_Trigger_Delay_GetRange(peak_camera_handle hCam, double* minTriggerDelay_us,
4208  double* maxTriggerDelay_us, double* incTriggerDelay_us);
4209 
4230 PEAK_API_STATUS peak_Trigger_Delay_Set(peak_camera_handle hCam, double triggerDelay_us);
4231 
4250 PEAK_API_STATUS peak_Trigger_Delay_Get(peak_camera_handle hCam, double* triggerDelay_us);
4251 
4278 PEAK_API_ACCESS_STATUS peak_Trigger_Divider_GetAccessStatus(peak_camera_handle hCam);
4279 
4304 PEAK_API_STATUS peak_Trigger_Divider_GetRange(peak_camera_handle hCam, uint32_t* minTriggerDivider,
4305  uint32_t* maxTriggerDivider, uint32_t* incTriggerDivider);
4306 
4326 PEAK_API_STATUS peak_Trigger_Divider_Set(peak_camera_handle hCam, uint32_t triggerDivider);
4327 
4346 PEAK_API_STATUS peak_Trigger_Divider_Get(peak_camera_handle hCam, uint32_t* triggerDivider);
4347 
4374 PEAK_API_ACCESS_STATUS peak_Trigger_Burst_GetAccessStatus(peak_camera_handle hCam);
4375 
4400 PEAK_API_STATUS peak_Trigger_Burst_GetRange(peak_camera_handle hCam, uint32_t* minTriggerBurst,
4401  uint32_t* maxTriggerBurst, uint32_t* incTriggerBurst);
4402 
4422 PEAK_API_STATUS peak_Trigger_Burst_Set(peak_camera_handle hCam, uint32_t triggerBurst);
4423 
4442 PEAK_API_STATUS peak_Trigger_Burst_Get(peak_camera_handle hCam, uint32_t* triggerBurst);
4443 
4450 typedef enum
4451 {
4457 
4463 
4469 
4475 
4477 
4500 typedef struct
4501 {
4507 
4513 
4514 } peak_flash_mode;
4515 
4531 #define PEAK_FLASH_MODE_EXPOSURE_ACTIVE { PEAK_FLASH_REFERENCE_EXPOSURE_ACTIVE, PEAK_IO_CHANNEL_FLASH_OUTPUT }
4532 
4546 #define PEAK_FLASH_MODE_ACQUISITION_ACTIVE { PEAK_FLASH_REFERENCE_ACQUISITION_ACTIVE, PEAK_IO_CHANNEL_FLASH_OUTPUT }
4547 
4561 #define PEAK_FLASH_MODE_GLOBAL_START_WINDOW { PEAK_FLASH_REFERENCE_GLOBAL_START_WINDOW, PEAK_IO_CHANNEL_FLASH_OUTPUT }
4562 
4587 PEAK_API_ACCESS_STATUS peak_Flash_GetAccessStatus(peak_camera_handle hCam);
4588 
4607 PEAK_API_STATUS peak_Flash_Enable(peak_camera_handle hCam, peak_bool enabled);
4608 
4622 PEAK_API_BOOL peak_Flash_IsEnabled(peak_camera_handle hCam);
4623 
4652 PEAK_API_ACCESS_STATUS peak_Flash_Mode_GetAccessStatus(peak_camera_handle hCam, peak_flash_mode flashMode);
4653 
4683 PEAK_API_STATUS peak_Flash_Mode_Set(peak_camera_handle hCam, peak_flash_mode flashMode);
4684 
4703 PEAK_API_STATUS peak_Flash_Mode_Get(peak_camera_handle hCam, peak_flash_mode* flashMode);
4704 
4731 PEAK_API_ACCESS_STATUS peak_Flash_StartDelay_GetAccessStatus(peak_camera_handle hCam);
4732 
4757 PEAK_API_STATUS peak_Flash_StartDelay_GetRange(peak_camera_handle hCam, double* minFlashStartDelay_us,
4758  double* maxFlashStartDelay_us, double* incFlashStartDelay_us);
4759 
4779 PEAK_API_STATUS peak_Flash_StartDelay_Set(peak_camera_handle hCam, double flashStartDelay_us);
4780 
4799 PEAK_API_STATUS peak_Flash_StartDelay_Get(peak_camera_handle hCam, double* flashStartDelay_us);
4800 
4827 PEAK_API_ACCESS_STATUS peak_Flash_EndDelay_GetAccessStatus(peak_camera_handle hCam);
4828 
4853 PEAK_API_STATUS peak_Flash_EndDelay_GetRange(peak_camera_handle hCam, double* minFlashEndDelay_us,
4854  double* maxFlashEndDelay_us, double* incFlashEndDelay_us);
4855 
4876 PEAK_API_STATUS peak_Flash_EndDelay_Set(peak_camera_handle hCam, double flashEndDelay_us);
4877 
4896 PEAK_API_STATUS peak_Flash_EndDelay_Get(peak_camera_handle hCam, double* flashEndDelay_us);
4897 
4924 PEAK_API_ACCESS_STATUS peak_Flash_Duration_GetAccessStatus(peak_camera_handle hCam);
4925 
4950 PEAK_API_STATUS peak_Flash_Duration_GetRange(peak_camera_handle hCam, double* minFlashDuration_us,
4951  double* maxFlashDuration_us, double* incFlashDuration_us);
4952 
4971 PEAK_API_STATUS peak_Flash_Duration_Set(peak_camera_handle hCam, double flashDuration_us);
4972 
4991 PEAK_API_STATUS peak_Flash_Duration_Get(peak_camera_handle hCam, double* flashDuration_us);
4992 
5016 PEAK_API_ACCESS_STATUS peak_Focus_GetAccessStatus(peak_camera_handle hCam);
5017 
5038 PEAK_API_STATUS peak_Focus_GetRange(peak_camera_handle hCam, uint32_t* minFocus, uint32_t* maxFocus,
5039  uint32_t* incFocus);
5040 
5062 PEAK_API_STATUS peak_Focus_Set(peak_camera_handle hCam, uint32_t focus);
5063 
5081 PEAK_API_STATUS peak_Focus_Get(peak_camera_handle hCam, uint32_t* focus);
5082 
5107 PEAK_API_ACCESS_STATUS peak_PixelFormat_GetAccessStatus(peak_camera_handle hCam);
5108 
5147 PEAK_API_STATUS peak_PixelFormat_GetList(peak_camera_handle hCam, peak_pixel_format* pixelFormatList,
5148  size_t* pixelFormatCount);
5149 
5168 PEAK_API_STATUS peak_PixelFormat_Set(peak_camera_handle hCam, peak_pixel_format pixelFormat);
5169 
5187 PEAK_API_STATUS peak_PixelFormat_Get(peak_camera_handle hCam, peak_pixel_format* pixelFormat);
5188 
5195 typedef enum
5196 {
5202 
5205 
5208 
5211 
5212 } peak_gain_type;
5213 
5220 typedef enum
5221 {
5227 
5230 
5233 
5236 
5239 
5241 
5270 PEAK_API_ACCESS_STATUS peak_Gain_GetAccessStatus(peak_camera_handle hCam, peak_gain_type gainType,
5271  peak_gain_channel gainChannel);
5272 
5306 PEAK_API_STATUS peak_Gain_GetChannelList(peak_camera_handle hCam, peak_gain_type gainType,
5307  peak_gain_channel* gainChannelList, size_t* gainChannelCount);
5308 
5336 PEAK_API_STATUS peak_Gain_GetRange(peak_camera_handle hCam, peak_gain_type gainType, peak_gain_channel gainChannel,
5337  double* minGain, double* maxGain, double* incGain);
5338 
5362 PEAK_API_STATUS peak_Gain_Set(peak_camera_handle hCam, peak_gain_type gainType, peak_gain_channel gainChannel,
5363  double gain);
5364 
5387 PEAK_API_STATUS peak_Gain_Get(peak_camera_handle hCam, peak_gain_type gainType, peak_gain_channel gainChannel,
5388  double* gain);
5389 
5413 PEAK_API_ACCESS_STATUS peak_Gamma_GetAccessStatus(peak_camera_handle hCam);
5414 
5435 PEAK_API_STATUS peak_Gamma_GetRange(peak_camera_handle hCam, double* minGamma, double* maxGamma, double* incGamma);
5436 
5455 PEAK_API_STATUS peak_Gamma_Set(peak_camera_handle hCam, double gamma);
5456 
5474 PEAK_API_STATUS peak_Gamma_Get(peak_camera_handle hCam, double* gamma);
5475 
5483 typedef enum
5484 {
5490 
5496 
5505 
5507 
5532 PEAK_API_ACCESS_STATUS peak_ColorCorrection_GetAccessStatus(peak_camera_handle hCam);
5533 
5575 PEAK_API_STATUS peak_ColorCorrection_Mode_GetList(peak_camera_handle hCam,
5576  peak_color_correction_mode* colorCorrectionModeList, size_t* colorCorrectionModeCount);
5577 
5599 PEAK_API_STATUS peak_ColorCorrection_Mode_Set(peak_camera_handle hCam, peak_color_correction_mode colorCorrectionMode);
5600 
5617 PEAK_API_STATUS peak_ColorCorrection_Mode_Get(peak_camera_handle hCam, peak_color_correction_mode* colorCorrectionMode);
5618 
5643 PEAK_API_ACCESS_STATUS peak_ColorCorrection_Matrix_GetAccessStatus(peak_camera_handle hCam);
5644 
5665 PEAK_API_STATUS peak_ColorCorrection_Matrix_GetRange(peak_camera_handle hCam, double* minMatrixElementValue,
5666  double* maxMatrixElementValue, double* incMatrixElementValue);
5667 
5686 PEAK_API_STATUS peak_ColorCorrection_Matrix_Set(peak_camera_handle hCam, peak_matrix colorCorrectionMatrix);
5687 
5705 PEAK_API_STATUS peak_ColorCorrection_Matrix_Get(peak_camera_handle hCam, peak_matrix* colorCorrectionMatrix);
5706 
5722 PEAK_API_STATUS peak_ColorCorrection_Enable(peak_camera_handle hCam, peak_bool enabled);
5723 
5737 PEAK_API_BOOL peak_ColorCorrection_IsEnabled(peak_camera_handle hCam);
5738 
5745 typedef enum
5746 {
5752 
5760 
5766 
5772 
5774 
5781 typedef enum
5782 {
5788 
5797 
5806 
5808 
5833 PEAK_API_ACCESS_STATUS peak_AutoBrightness_GetAccessStatus(peak_camera_handle hCam);
5834 
5855 PEAK_API_STATUS peak_AutoBrightness_Target_GetRange(peak_camera_handle hCam, uint32_t* minAutoBrightnessTarget,
5856  uint32_t* maxAutoBrightnessTarget, uint32_t* incAutoBrightnessTarget);
5857 
5876 PEAK_API_STATUS peak_AutoBrightness_Target_Set(peak_camera_handle hCam, uint32_t autoBrightnessTarget);
5877 
5895 PEAK_API_STATUS peak_AutoBrightness_Target_Get(peak_camera_handle hCam, uint32_t* autoBrightnessTarget);
5896 
5918 PEAK_API_STATUS peak_AutoBrightness_TargetTolerance_GetRange(peak_camera_handle hCam,
5919  uint32_t* minAutoBrightnessTargetTolerance, uint32_t* maxAutoBrightnessTargetTolerance,
5920  uint32_t* incAutoBrightnessTargetTolerance);
5921 
5941 PEAK_API_STATUS peak_AutoBrightness_TargetTolerance_Set(peak_camera_handle hCam,
5942  uint32_t autoBrightnessTargetTolerance);
5943 
5961 PEAK_API_STATUS peak_AutoBrightness_TargetTolerance_Get(peak_camera_handle hCam,
5962  uint32_t* autoBrightnessTargetTolerance);
5963 
5985 PEAK_API_STATUS peak_AutoBrightness_TargetPercentile_GetRange(peak_camera_handle hCam,
5986  double* minAutoBrightnessTargetPercentile, double* maxAutoBrightnessTargetPercentile,
5987  double* incAutoBrightnessTargetPercentile);
5988 
6008 PEAK_API_STATUS peak_AutoBrightness_TargetPercentile_Set(peak_camera_handle hCam,
6009  double autoBrightnessTargetPercentile);
6010 
6028 PEAK_API_STATUS peak_AutoBrightness_TargetPercentile_Get(peak_camera_handle hCam,
6029  double* autoBrightnessTargetPercentile);
6030 
6049 PEAK_API_STATUS peak_AutoBrightness_ROI_Mode_Set(peak_camera_handle hCam,
6050  peak_auto_feature_roi_mode autoBrightnessROIMode);
6051 
6069 PEAK_API_STATUS peak_AutoBrightness_ROI_Mode_Get(peak_camera_handle hCam,
6070  peak_auto_feature_roi_mode* autoBrightnessROIMode);
6071 
6096 PEAK_API_STATUS peak_AutoBrightness_ROI_Offset_GetRange(peak_camera_handle hCam,
6097  peak_position* minAutoBrightnessROIOffset, peak_position* maxAutoBrightnessROIOffset,
6098  peak_position* incAutoBrightnessROIOffset);
6099 
6124 PEAK_API_STATUS peak_AutoBrightness_ROI_Size_GetRange(peak_camera_handle hCam, peak_size* minAutoBrightnessROISize,
6125  peak_size* maxAutoBrightnessROISize, peak_size* incAutoBrightnessROISize);
6126 
6152 PEAK_API_STATUS peak_AutoBrightness_ROI_Set(peak_camera_handle hCam, peak_roi autoBrightnessROI);
6153 
6171 PEAK_API_STATUS peak_AutoBrightness_ROI_Get(peak_camera_handle hCam, peak_roi* autoBrightnessROI);
6172 
6199 PEAK_API_ACCESS_STATUS peak_AutoBrightness_Exposure_GetAccessStatus(peak_camera_handle hCam);
6200 
6219 PEAK_API_STATUS peak_AutoBrightness_Exposure_Mode_Set(peak_camera_handle hCam, peak_auto_feature_mode autoExposureMode);
6220 
6238 PEAK_API_STATUS peak_AutoBrightness_Exposure_Mode_Get(peak_camera_handle hCam, peak_auto_feature_mode* autoExposureMode);
6239 
6266 PEAK_API_ACCESS_STATUS peak_AutoBrightness_Gain_GetAccessStatus(peak_camera_handle hCam);
6267 
6286 PEAK_API_STATUS peak_AutoBrightness_Gain_Mode_Set(peak_camera_handle hCam, peak_auto_feature_mode autoGainMode);
6287 
6305 PEAK_API_STATUS peak_AutoBrightness_Gain_Mode_Get(peak_camera_handle hCam, peak_auto_feature_mode* autoGainMode);
6306 
6331 PEAK_API_ACCESS_STATUS peak_AutoWhiteBalance_GetAccessStatus(peak_camera_handle hCam);
6332 
6351 PEAK_API_STATUS peak_AutoWhiteBalance_ROI_Mode_Set(peak_camera_handle hCam,
6352  peak_auto_feature_roi_mode autoWhiteBalanceROIMode);
6353 
6371 PEAK_API_STATUS peak_AutoWhiteBalance_ROI_Mode_Get(peak_camera_handle hCam,
6372  peak_auto_feature_roi_mode* autoWhiteBalanceROIMode);
6373 
6400 PEAK_API_STATUS peak_AutoWhiteBalance_ROI_Offset_GetRange(peak_camera_handle hCam,
6401  peak_position* minAutoWhiteBalanceROIOffset, peak_position* maxAutoWhiteBalanceROIOffset,
6402  peak_position* incAutoWhiteBalanceROIOffset);
6403 
6430 PEAK_API_STATUS peak_AutoWhiteBalance_ROI_Size_GetRange(peak_camera_handle hCam, peak_size* minAutoWhiteBalanceROISize,
6431  peak_size* maxAutoWhiteBalanceROISize, peak_size* incAutoWhiteBalanceROISize);
6432 
6458 PEAK_API_STATUS peak_AutoWhiteBalance_ROI_Set(peak_camera_handle hCam, peak_roi autoWhiteBalanceROI);
6459 
6477 PEAK_API_STATUS peak_AutoWhiteBalance_ROI_Get(peak_camera_handle hCam, peak_roi* autoWhiteBalanceROI);
6478 
6497 PEAK_API_STATUS peak_AutoWhiteBalance_Mode_Set(peak_camera_handle hCam, peak_auto_feature_mode autoWhiteBalanceMode);
6498 
6516 PEAK_API_STATUS peak_AutoWhiteBalance_Mode_Get(peak_camera_handle hCam, peak_auto_feature_mode* autoWhiteBalanceMode);
6517 
6541 PEAK_API_ACCESS_STATUS peak_ROI_GetAccessStatus(peak_camera_handle hCam);
6542 
6566 PEAK_API_STATUS peak_ROI_Offset_GetRange(peak_camera_handle hCam, peak_position* minROIOffset,
6567  peak_position* maxROIOffset, peak_position* incROIOffset);
6568 
6592 PEAK_API_STATUS peak_ROI_Size_GetRange(peak_camera_handle hCam, peak_size* minROISize, peak_size* maxROISize,
6593  peak_size* incROISize);
6594 
6614 PEAK_API_STATUS peak_ROI_Set(peak_camera_handle hCam, peak_roi roi);
6615 
6633 PEAK_API_STATUS peak_ROI_Get(peak_camera_handle hCam, peak_roi* roi);
6634 
6658 PEAK_API_ACCESS_STATUS peak_Binning_GetAccessStatus(peak_camera_handle hCam);
6659 
6698 PEAK_API_STATUS peak_Binning_FactorX_GetList(peak_camera_handle hCam, uint32_t* binningFactorXList,
6699  size_t* binningFactorXCount);
6700 
6739 PEAK_API_STATUS peak_Binning_FactorY_GetList(peak_camera_handle hCam, uint32_t* binningFactorYList,
6740  size_t* binningFactorYCount);
6741 
6762 PEAK_API_STATUS peak_Binning_Set(peak_camera_handle hCam, uint32_t binningFactorX, uint32_t binningFactorY);
6763 
6782 PEAK_API_STATUS peak_Binning_Get(peak_camera_handle hCam, uint32_t* binningFactorX, uint32_t* binningFactorY);
6783 
6808 PEAK_API_ACCESS_STATUS peak_Decimation_GetAccessStatus(peak_camera_handle hCam);
6809 
6850 PEAK_API_STATUS peak_Decimation_FactorX_GetList(peak_camera_handle hCam, uint32_t* decimationFactorXList,
6851  size_t* decimationFactorXCount);
6852 
6893 PEAK_API_STATUS peak_Decimation_FactorY_GetList(peak_camera_handle hCam, uint32_t* decimationFactorYList,
6894  size_t* decimationFactorYCount);
6895 
6916 PEAK_API_STATUS peak_Decimation_Set(peak_camera_handle hCam, uint32_t decimationFactorX, uint32_t decimationFactorY);
6917 
6936 PEAK_API_STATUS peak_Decimation_Get(peak_camera_handle hCam, uint32_t* decimationFactorX, uint32_t* decimationFactorY);
6937 
6962 PEAK_API_ACCESS_STATUS peak_Mirror_LeftRight_GetAccessStatus(peak_camera_handle hCam);
6963 
6980 PEAK_API_STATUS peak_Mirror_LeftRight_Enable(peak_camera_handle hCam, peak_bool enabled);
6981 
6995 PEAK_API_BOOL peak_Mirror_LeftRight_IsEnabled(peak_camera_handle hCam);
6996 
7021 PEAK_API_ACCESS_STATUS peak_Mirror_UpDown_GetAccessStatus(peak_camera_handle hCam);
7022 
7039 PEAK_API_STATUS peak_Mirror_UpDown_Enable(peak_camera_handle hCam, peak_bool enabled);
7040 
7054 PEAK_API_BOOL peak_Mirror_UpDown_IsEnabled(peak_camera_handle hCam);
7055 
7062 typedef enum
7063 {
7069 
7075 
7081 
7083 
7111 PEAK_API_ACCESS_STATUS peak_CameraMemory_Area_GetAccessStatus(peak_camera_handle hCam,
7112  peak_camera_memory_area cameraMemoryArea);
7113 
7153 PEAK_API_STATUS peak_CameraMemory_Area_GetList(peak_camera_handle hCam,
7154  peak_camera_memory_area* cameraMemoryAreaList, size_t* cameraMemoryAreaCount);
7155 
7178 PEAK_API_STATUS peak_CameraMemory_Area_Size_Get(peak_camera_handle hCam,
7179  peak_camera_memory_area cameraMemoryArea, size_t* cameraMemoryAreaSize);
7180 
7201 PEAK_API_STATUS peak_CameraMemory_Area_Data_Clear(peak_camera_handle hCam,
7202  peak_camera_memory_area cameraMemoryArea);
7203 
7235 PEAK_API_STATUS peak_CameraMemory_Area_Data_Write(peak_camera_handle hCam,
7236  peak_camera_memory_area cameraMemoryArea, const uint8_t* data, size_t dataSize);
7237 
7267 PEAK_API_STATUS peak_CameraMemory_Area_Data_Read(peak_camera_handle hCam,
7268  peak_camera_memory_area cameraMemoryArea, uint8_t* data, size_t dataSize);
7269 
7306 PEAK_API_STATUS peak_GFA_EnableWriteAccess(peak_camera_handle hCam, peak_bool enabled);
7307 
7323 PEAK_API_BOOL peak_GFA_IsWriteAccessEnabled(peak_camera_handle hCam);
7324 
7334 typedef enum
7335 {
7341 
7344 
7347 
7350 
7353 
7356 
7357 } peak_gfa_module;
7358 
7390 PEAK_API_ACCESS_STATUS peak_GFA_Feature_GetAccessStatus(peak_camera_handle hCam, peak_gfa_module module,
7391  const char* featureName);
7392 
7408 PEAK_API_BOOL peak_GFA_Float_HasRange(peak_camera_handle hCam, peak_gfa_module module, const char* floatFeatureName);
7409 
7443 PEAK_API_STATUS peak_GFA_Float_GetRange(peak_camera_handle hCam, peak_gfa_module module, const char* floatFeatureName,
7444  double* minFloatValue, double* maxFloatValue, double* incFloatValue);
7445 
7490 PEAK_API_STATUS peak_GFA_Float_GetList(peak_camera_handle hCam, peak_gfa_module module, const char* floatFeatureName,
7491  double* floatList, size_t* floatCount);
7492 
7523 PEAK_API_STATUS peak_GFA_Float_Set(peak_camera_handle hCam, peak_gfa_module module, const char* floatFeatureName,
7524  double floatValue);
7525 
7550 PEAK_API_STATUS peak_GFA_Float_Get(peak_camera_handle hCam, peak_gfa_module module, const char* floatFeatureName,
7551  double* floatValue);
7552 
7568 PEAK_API_BOOL peak_GFA_Integer_HasRange(peak_camera_handle hCam, peak_gfa_module module,
7569  const char* integerFeatureName);
7570 
7604 PEAK_API_STATUS peak_GFA_Integer_GetRange(peak_camera_handle hCam, peak_gfa_module module,
7605  const char* integerFeatureName, int64_t* minIntegerValue, int64_t* maxIntegerValue, int64_t* incIntegerValue);
7606 
7653 PEAK_API_STATUS peak_GFA_Integer_GetList(peak_camera_handle hCam, peak_gfa_module module,
7654  const char* integerFeatureName, int64_t* integerList, size_t* integerCount);
7655 
7686 PEAK_API_STATUS peak_GFA_Integer_Set(peak_camera_handle hCam, peak_gfa_module module, const char* integerFeatureName,
7687  int64_t integerValue);
7688 
7713 PEAK_API_STATUS peak_GFA_Integer_Get(peak_camera_handle hCam, peak_gfa_module module, const char* integerFeatureName,
7714  int64_t* integerValue);
7715 
7745 PEAK_API_STATUS peak_GFA_Boolean_Set(peak_camera_handle hCam, peak_gfa_module module, const char* booleanFeatureName,
7746  peak_bool booleanValue);
7747 
7772 PEAK_API_STATUS peak_GFA_Boolean_Get(peak_camera_handle hCam, peak_gfa_module module, const char* booleanFeatureName,
7773  peak_bool* booleanValue);
7774 
7803 PEAK_API_STATUS peak_GFA_String_Set(peak_camera_handle hCam, peak_gfa_module module, const char* stringFeatureName,
7804  const char* stringValue);
7805 
7850 PEAK_API_STATUS peak_GFA_String_Get(peak_camera_handle hCam, peak_gfa_module module, const char* stringFeatureName,
7851  char* stringValue, size_t* stringValueSize);
7852 
7879 PEAK_API_STATUS peak_GFA_Command_Execute(peak_camera_handle hCam, peak_gfa_module module,
7880  const char* commandFeatureName);
7881 
7914 PEAK_API_STATUS peak_GFA_Command_WaitForDone(peak_camera_handle hCam, peak_gfa_module module,
7915  const char* commandFeatureName, uint32_t timeout_ms);
7916 
7926  typedef struct
7927 {
7929  char symbolicValue[64];
7930 
7932  int64_t integerValue;
7933 
7935 
7981 PEAK_API_STATUS peak_GFA_Enumeration_GetList(peak_camera_handle hCam, peak_gfa_module module,
7982  const char* enumerationFeatureName, peak_gfa_enumeration_entry* enumerationEntryList,
7983  size_t* enumerationEntryCount);
7984 
8019 PEAK_API_ACCESS_STATUS peak_GFA_EnumerationEntry_GetAccessStatus(peak_camera_handle hCam, peak_gfa_module module,
8020  const char* enumerationFeatureName, const peak_gfa_enumeration_entry* enumerationEntry);
8021 
8054 PEAK_API_ACCESS_STATUS peak_GFA_EnumerationEntry_GetAccessStatusBySymbolicValue(peak_camera_handle hCam,
8055  peak_gfa_module module, const char* enumerationFeatureName, const char* enumerationEntrySymbolicValue);
8056 
8088 PEAK_API_ACCESS_STATUS peak_GFA_EnumerationEntry_GetAccessStatusByIntegerValue(peak_camera_handle hCam,
8089  peak_gfa_module module, const char* enumerationFeatureName, int64_t enumerationEntryIntegerValue);
8090 
8124 PEAK_API_STATUS peak_GFA_Enumeration_Set(peak_camera_handle hCam, peak_gfa_module module,
8125  const char* enumerationFeatureName, const peak_gfa_enumeration_entry* enumerationEntry);
8126 
8158 PEAK_API_STATUS peak_GFA_Enumeration_SetBySymbolicValue(peak_camera_handle hCam, peak_gfa_module module,
8159  const char* enumerationFeatureName, const char* enumerationEntrySymbolicValue);
8160 
8191 PEAK_API_STATUS peak_GFA_Enumeration_SetByIntegerValue(peak_camera_handle hCam, peak_gfa_module module,
8192  const char* enumerationFeatureName, int64_t enumerationEntryIntegerValue);
8193 
8218 PEAK_API_STATUS peak_GFA_Enumeration_Get(peak_camera_handle hCam, peak_gfa_module module,
8219  const char* enumerationFeatureName, peak_gfa_enumeration_entry* enumerationEntry);
8220 
8251 PEAK_API_STATUS peak_GFA_Register_Set(peak_camera_handle hCam, peak_gfa_module module, const char* registerFeatureName,
8252  const uint8_t* registerValue, size_t registerValueSize);
8253 
8293 PEAK_API_STATUS peak_GFA_Register_Get(peak_camera_handle hCam, peak_gfa_module module, const char* registerFeatureName,
8294  uint8_t* registerValue, size_t* registerValueSize);
8295 
8325 PEAK_API_STATUS peak_GFA_Data_Write(peak_camera_handle hCam, peak_gfa_module module, uint64_t address,
8326  const uint8_t* data, size_t dataSize);
8327 
8352 PEAK_API_STATUS peak_GFA_Data_Read(peak_camera_handle hCam, peak_gfa_module module, uint64_t address, uint8_t* data,
8353  size_t dataSize);
8354 
8391 PEAK_API_STATUS peak_IPL_PixelFormat_GetList(peak_camera_handle hCam, peak_pixel_format inputPixelFormat,
8392  peak_pixel_format* outputPixelFormatList, size_t* outputPixelFormatCount);
8393 
8417 PEAK_API_STATUS peak_IPL_PixelFormat_Set(peak_camera_handle hCam, peak_pixel_format pixelFormat);
8418 
8434 PEAK_API_STATUS peak_IPL_PixelFormat_Get(peak_camera_handle hCam, peak_pixel_format* pixelFormat);
8435 
8454 PEAK_API_STATUS peak_IPL_Gain_GetRange(peak_camera_handle hCam, peak_gain_channel gainChannel, double* minGain,
8455  double* maxGain, double* incGain);
8456 
8476 PEAK_API_STATUS peak_IPL_Gain_Set(peak_camera_handle hCam, peak_gain_channel gainChannel, double gain);
8477 
8496 PEAK_API_STATUS peak_IPL_Gain_Get(peak_camera_handle hCam, peak_gain_channel gainChannel, double* gain);
8497 
8515 PEAK_API_STATUS peak_IPL_Gamma_GetRange(peak_camera_handle hCam, double* minGamma, double* maxGamma, double* incGamma);
8516 
8533 PEAK_API_STATUS peak_IPL_Gamma_Set(peak_camera_handle hCam, double gamma);
8534 
8550 PEAK_API_STATUS peak_IPL_Gamma_Get(peak_camera_handle hCam, double* gamma);
8551 
8566 PEAK_API_STATUS peak_IPL_ColorCorrection_Matrix_Set(peak_camera_handle hCam, peak_matrix colorCorrectionMatrix);
8567 
8583 PEAK_API_STATUS peak_IPL_ColorCorrection_Matrix_Get(peak_camera_handle hCam, peak_matrix* colorCorrectionMatrix);
8584 
8600 PEAK_API_STATUS peak_IPL_ColorCorrection_Saturation_Get(peak_camera_handle hCam, double* saturation);
8601 
8618 PEAK_API_STATUS peak_IPL_ColorCorrection_Saturation_Set(peak_camera_handle hCam, double saturation);
8619 
8638 PEAK_API_STATUS peak_IPL_ColorCorrection_Saturation_GetRange(peak_camera_handle hCam, double* minSaturation, double* maxSaturation, double* incSaturation);
8639 
8654 PEAK_API_STATUS peak_IPL_ColorCorrection_Enable(peak_camera_handle hCam, peak_bool enabled);
8655 
8669 PEAK_API_BOOL peak_IPL_ColorCorrection_IsEnabled(peak_camera_handle hCam);
8670 
8689 PEAK_API_STATUS peak_IPL_AutoBrightness_Target_GetRange(peak_camera_handle hCam, uint32_t* minAutoBrightnessTarget,
8690  uint32_t* maxAutoBrightnessTarget, uint32_t* incAutoBrightnessTarget);
8691 
8708 PEAK_API_STATUS peak_IPL_AutoBrightness_Target_Set(peak_camera_handle hCam, uint32_t autoBrightnessTarget);
8709 
8725 PEAK_API_STATUS peak_IPL_AutoBrightness_Target_Get(peak_camera_handle hCam, uint32_t* autoBrightnessTarget);
8726 
8746 PEAK_API_STATUS peak_IPL_AutoBrightness_TargetTolerance_GetRange(peak_camera_handle hCam,
8747  uint32_t* minAutoBrightnessTargetTolerance, uint32_t* maxAutoBrightnessTargetTolerance,
8748  uint32_t* incAutoBrightnessTargetTolerance);
8749 
8767 PEAK_API_STATUS peak_IPL_AutoBrightness_TargetTolerance_Set(peak_camera_handle hCam,
8768  uint32_t autoBrightnessTargetTolerance);
8769 
8785 PEAK_API_STATUS peak_IPL_AutoBrightness_TargetTolerance_Get(peak_camera_handle hCam,
8786  uint32_t* autoBrightnessTargetTolerance);
8787 
8807 PEAK_API_STATUS peak_IPL_AutoBrightness_TargetPercentile_GetRange(peak_camera_handle hCam,
8808  double* minAutoBrightnessTargetPercentile, double* maxAutoBrightnessTargetPercentile,
8809  double* incAutoBrightnessTargetPercentile);
8810 
8828 PEAK_API_STATUS peak_IPL_AutoBrightness_TargetPercentile_Set(peak_camera_handle hCam,
8829  double autoBrightnessTargetPercentile);
8830 
8846 PEAK_API_STATUS peak_IPL_AutoBrightness_TargetPercentile_Get(peak_camera_handle hCam,
8847  double* autoBrightnessTargetPercentile);
8848 
8865 PEAK_API_STATUS peak_IPL_AutoBrightness_ROI_Mode_Set(peak_camera_handle hCam,
8866  peak_auto_feature_roi_mode autoBrightnessROIMode);
8867 
8883 PEAK_API_STATUS peak_IPL_AutoBrightness_ROI_Mode_Get(peak_camera_handle hCam,
8884  peak_auto_feature_roi_mode* autoBrightnessROIMode);
8885 
8907 PEAK_API_STATUS peak_IPL_AutoBrightness_ROI_Offset_GetRange(peak_camera_handle hCam,
8908  peak_position* minAutoBrightnessROIOffset, peak_position* maxAutoBrightnessROIOffset,
8909  peak_position* incAutoBrightnessROIOffset);
8910 
8932 PEAK_API_STATUS peak_IPL_AutoBrightness_ROI_Size_GetRange(peak_camera_handle hCam,
8933  peak_size* minAutoBrightnessROISize, peak_size* maxAutoBrightnessROISize, peak_size* incAutoBrightnessROISize);
8934 
8959 PEAK_API_STATUS peak_IPL_AutoBrightness_ROI_Set(peak_camera_handle hCam, peak_roi autoBrightnessROI);
8960 
8976 PEAK_API_STATUS peak_IPL_AutoBrightness_ROI_Get(peak_camera_handle hCam, peak_roi* autoBrightnessROI);
8977 
8994 PEAK_API_STATUS peak_IPL_AutoBrightness_Exposure_Mode_Set(peak_camera_handle hCam,
8995  peak_auto_feature_mode autoExposureMode);
8996 
9012 PEAK_API_STATUS peak_IPL_AutoBrightness_Exposure_Mode_Get(peak_camera_handle hCam,
9013  peak_auto_feature_mode* autoExposureMode);
9014 
9031 PEAK_API_STATUS peak_IPL_AutoBrightness_Gain_Mode_Set(peak_camera_handle hCam, peak_auto_feature_mode autoGainMode);
9032 
9048 PEAK_API_STATUS peak_IPL_AutoBrightness_Gain_Mode_Get(peak_camera_handle hCam, peak_auto_feature_mode* autoGainMode);
9049 
9066 PEAK_API_STATUS peak_IPL_AutoWhiteBalance_ROI_Mode_Set(peak_camera_handle hCam,
9067  peak_auto_feature_roi_mode autoWhiteBalanceROIMode);
9068 
9084 PEAK_API_STATUS peak_IPL_AutoWhiteBalance_ROI_Mode_Get(peak_camera_handle hCam,
9085  peak_auto_feature_roi_mode* autoWhiteBalanceROIMode);
9086 
9108 PEAK_API_STATUS peak_IPL_AutoWhiteBalance_ROI_Offset_GetRange(peak_camera_handle hCam,
9109  peak_position* minAutoWhiteBalanceROIOffset, peak_position* maxAutoWhiteBalanceROIOffset,
9110  peak_position* incAutoWhiteBalanceROIOffset);
9111 
9133 PEAK_API_STATUS peak_IPL_AutoWhiteBalance_ROI_Size_GetRange(peak_camera_handle hCam,
9134  peak_size* minAutoWhiteBalanceROISize, peak_size* maxAutoWhiteBalanceROISize,
9135  peak_size* incAutoWhiteBalanceROISize);
9136 
9163 PEAK_API_STATUS peak_IPL_AutoWhiteBalance_ROI_Set(peak_camera_handle hCam, peak_roi autoWhiteBalanceROI);
9164 
9180 PEAK_API_STATUS peak_IPL_AutoWhiteBalance_ROI_Get(peak_camera_handle hCam, peak_roi* autoWhiteBalanceROI);
9181 
9198 PEAK_API_STATUS peak_IPL_AutoWhiteBalance_Mode_Set(peak_camera_handle hCam, peak_auto_feature_mode autoWhiteBalanceMode);
9199 
9215 PEAK_API_STATUS peak_IPL_AutoWhiteBalance_Mode_Get(peak_camera_handle hCam,
9216  peak_auto_feature_mode* autoWhiteBalanceMode);
9217 
9222 typedef enum
9223 {
9229 
9232 
9235 
9238 
9240 
9241 #pragma pack(push, 1)
9242 
9247 typedef struct
9248 {
9251 
9254 
9255 } peak_focus_roi;
9256 #pragma pack(pop)
9257 
9282 PEAK_API_ACCESS_STATUS peak_IPL_AutoFocus_GetAccessStatus(peak_camera_handle hCam);
9283 
9304 PEAK_API_STATUS peak_IPL_AutoFocus_ROI_Set(peak_camera_handle hCam, const peak_focus_roi* autoFocusROIList,
9305  size_t autoFocusROICount);
9306 
9338 PEAK_API_STATUS peak_IPL_AutoFocus_ROI_Get(peak_camera_handle hCam, peak_focus_roi* autoFocusROIList,
9339  size_t* autoFocusROICount);
9340 
9357 PEAK_API_STATUS peak_IPL_AutoFocus_Mode_Set(peak_camera_handle hCam, peak_auto_feature_mode autoFocusMode);
9358 
9374 PEAK_API_STATUS peak_IPL_AutoFocus_Mode_Get(peak_camera_handle hCam, peak_auto_feature_mode* autoFocusMode);
9375 
9380 typedef enum
9381 {
9387 
9393 
9400 
9406 
9412 
9414 
9436 PEAK_API_STATUS peak_IPL_AutoFocus_SearchAlgorithm_Set(peak_camera_handle hCam,
9437  peak_auto_focus_search_algorithm searchAlgorithm);
9438 
9456 PEAK_API_STATUS peak_IPL_AutoFocus_SearchAlgorithm_Get(peak_camera_handle hCam,
9457  peak_auto_focus_search_algorithm* searchAlgorithm);
9458 
9463 typedef enum
9464 {
9470 
9476 
9482 
9488 
9494 
9496 
9518 PEAK_API_STATUS peak_IPL_AutoFocus_SharpnessAlgorithm_Set(peak_camera_handle hCam,
9519  peak_sharpness_algorithm sharpnessAlgorithm);
9520 
9538 PEAK_API_STATUS peak_IPL_AutoFocus_SharpnessAlgorithm_Get(peak_camera_handle hCam,
9539  peak_sharpness_algorithm* sharpnessAlgorithm);
9540 
9560 PEAK_API_STATUS peak_IPL_AutoFocus_Range_Set(peak_camera_handle hCam, uint32_t rangeBegin, uint32_t rangeEnd);
9561 
9580 PEAK_API_STATUS peak_IPL_AutoFocus_Range_Get(peak_camera_handle hCam, uint32_t* rangeBegin, uint32_t* rangeEnd);
9581 
9600 PEAK_API_STATUS peak_IPL_AutoFocus_Hysteresis_Set(peak_camera_handle hCam, uint8_t hysteresis);
9601 
9619 PEAK_API_STATUS peak_IPL_AutoFocus_Hysteresis_Get(peak_camera_handle hCam, uint8_t* hysteresis);
9620 
9641 PEAK_API_STATUS peak_IPL_AutoFocus_Hysteresis_GetRange(peak_camera_handle hCam, uint8_t* minHysteresis,
9642  uint8_t* maxHysteresis, uint8_t* incHysteresis);
9643 
9651 typedef enum
9652 {
9658 
9665 
9668 
9674 
9677 
9683 
9685 
9705 PEAK_API_STATUS peak_IPL_HotpixelCorrection_Sensitivity_Set(peak_camera_handle hCam,
9706  peak_hotpixel_correction_sensitivity hotpixelCorrectionSensitivity);
9707 
9723 PEAK_API_STATUS peak_IPL_HotpixelCorrection_Sensitivity_Get(peak_camera_handle hCam,
9724  peak_hotpixel_correction_sensitivity* hotpixelCorrectionSensitivity);
9725 
9760 PEAK_API_STATUS peak_IPL_HotpixelCorrection_GetList(peak_camera_handle hCam, peak_position* hotpixelList,
9761  size_t* hotpixelCount);
9762 
9782 PEAK_API_STATUS peak_IPL_HotpixelCorrection_SetList(peak_camera_handle hCam, peak_position* hotpixelList,
9783  size_t hotpixelCount);
9784 
9802 PEAK_API_STATUS peak_IPL_HotpixelCorrection_ResetList(peak_camera_handle hCam);
9803 
9819 PEAK_API_STATUS peak_IPL_HotpixelCorrection_Enable(peak_camera_handle hCam, peak_bool enabled);
9820 
9834 PEAK_API_BOOL peak_IPL_HotpixelCorrection_IsEnabled(peak_camera_handle hCam);
9835 
9851 PEAK_API_STATUS peak_IPL_Mirror_UpDown_Enable(peak_camera_handle hCam, peak_bool enabled);
9852 
9866 PEAK_API_BOOL peak_IPL_Mirror_UpDown_IsEnabled(peak_camera_handle hCam);
9867 
9883 PEAK_API_STATUS peak_IPL_Mirror_LeftRight_Enable(peak_camera_handle hCam, peak_bool enabled);
9884 
9898 PEAK_API_BOOL peak_IPL_Mirror_LeftRight_IsEnabled(peak_camera_handle hCam);
9899 
9923 PEAK_API_STATUS peak_IPL_ProcessFrame(peak_camera_handle hCam, peak_frame_handle hFrame,
9924  peak_frame_handle* hResultFrame);
9925 
9951 PEAK_API_STATUS peak_IPL_ProcessFrameInplace(peak_camera_handle hCam, peak_frame_handle hFrame);
9952 
9964 typedef struct peak_video* peak_video_handle;
9965 
9972 typedef enum
9973 {
9979 
9982 
9984 
9991 typedef enum
9992 {
9998 
10001 
10003 
10019 PEAK_API_STATUS peak_VideoWriter_Open(peak_video_handle* hVideo, const char* fileName,
10020  peak_video_container container, peak_video_encoder encoder);
10021 
10035 PEAK_API_STATUS peak_VideoWriter_Close(peak_video_handle hVideo);
10036 
10052 PEAK_API_STATUS peak_VideoWriter_AddFrame(peak_video_handle hVideo, peak_frame_handle hFrame);
10053 
10083  peak_video_encoder* encoderList, size_t* encoderCount);
10084 
10123  peak_pixel_format* pixelFormatList, size_t* pixelFormatCount);
10124 
10154  peak_video_container* containerList, size_t* containerCount);
10155 
10163 typedef struct
10164 {
10165  /* \brief Overall encoded frames */
10166  uint64_t encodedFrames;
10167 
10168  /* \brief Overall dropped frames */
10169  uint64_t droppedFrames;
10170 
10171  /* \brief Current file size in bytes */
10172  uint64_t fileSize;
10173 
10174  uint8_t reserved[256];
10175 } peak_video_info;
10176 
10191 PEAK_API_STATUS peak_VideoWriter_GetInfo(peak_video_handle hVideo, peak_video_info* videoInfo);
10192 
10199 typedef enum
10200 {
10206 
10212 
10214 
10221 typedef enum
10222 {
10228 
10234 
10236 
10255  peak_video_handle hVideo, peak_video_container_option containerOption, const void* value, size_t count);
10256 
10276  peak_video_handle hVideo, peak_video_container_option containerOption, void* value, size_t count, size_t* outCount);
10277 
10295 PEAK_API_STATUS peak_VideoWriter_Encoder_Option_Set(
10296  peak_video_handle hVideo, peak_video_encoder_option encoderOption, const void* value, size_t count);
10297 
10316 PEAK_API_STATUS peak_VideoWriter_Encoder_Option_Get(
10317  peak_video_handle hVideo, peak_video_encoder_option encoderOption, void* value, size_t count, size_t* outCount);
10318 
10333 PEAK_API_STATUS peak_VideoWriter_WaitUntilQueueEmpty(peak_video_handle hVideo, int32_t timeout_ms);
10334 
10335 #ifdef __cplusplus
10336 } // extern "C"
10337 #endif // __cplusplus
10338 
10339 #endif // PEAK_COMFORT_C_H
peak_status peak_IPL_AutoFocus_Hysteresis_Get(peak_camera_handle hCam, uint8_t *hysteresis)
Get the host auto focus hysteresis.
Invalid GFA module.
Definition: ids_peak_comfort_c.h:7340
BayerGR10 packed.
Definition: ids_peak_comfort_c.h:2236
peak_ethernet_status
peak Ethernet status
Definition: ids_peak_comfort_c.h:1526
peak_status peak_AutoWhiteBalance_ROI_Offset_GetRange(peak_camera_handle hCam, peak_position *minAutoWhiteBalanceROIOffset, peak_position *maxAutoWhiteBalanceROIOffset, peak_position *incAutoWhiteBalanceROIOffset)
Get the current range of valid auto white balance ROI offsets.
peak_status peak_Frame_BytesExpected_Get(peak_frame_handle hFrame, size_t *bytesExpected)
Query the bytes expected for a complete image.
Image data.
Definition: ids_peak_comfort_c.h:2442
peak_status peak_GFA_Float_Get(peak_camera_handle hCam, peak_gfa_module module, const char *floatFeatureName, double *floatValue)
Get the float feature with the given name.
peak_flash_reference flashReference
Flash reference.
Definition: ids_peak_comfort_c.h:4506
Mono10 packed.
Definition: ids_peak_comfort_c.h:2260
The value or configuration is out of the valid range.
Definition: ids_peak_comfort_c.h:767
Frame start.
Definition: ids_peak_comfort_c.h:3745
peak_status peak_CameraSettings_ParameterSet_GetList(peak_camera_handle hCam, peak_parameter_set *parameterSetList, size_t *parameterSetCount)
Get the list of currently usable parameter sets.
peak_status peak_GFA_EnableWriteAccess(peak_camera_handle hCam, peak_bool enabled)
Enable/Disable the GFA write access.
The current configuration of an addressed module does not allow the requested operation to be execute...
Definition: ids_peak_comfort_c.h:773
BayerGR12 packed.
Definition: ids_peak_comfort_c.h:2239
RGB12.
Definition: ids_peak_comfort_c.h:2206
peak_status peak_VideoWriter_WaitUntilQueueEmpty(peak_video_handle hVideo, int32_t timeout_ms)
Wait until queue is empty.
peak_status peak_Trigger_Delay_GetRange(peak_camera_handle hCam, double *minTriggerDelay_us, double *maxTriggerDelay_us, double *incTriggerDelay_us)
Get the current range of valid trigger delay values.
Invalid auto feature ROI mode.
Definition: ids_peak_comfort_c.h:5787
peak_access_status peak_PixelFormat_GetAccessStatus(peak_camera_handle hCam)
Query the pixel format access status.
peak_status peak_IPL_PixelFormat_Get(peak_camera_handle hCam, peak_pixel_format *pixelFormat)
Get the output pixel format of the host processing.
peak_bool peak_GFA_IsWriteAccessEnabled(peak_camera_handle hCam)
Get the enabled status of the GFA write access.
BayerBG12 packed.
Definition: ids_peak_comfort_c.h:2257
peak_status peak_AutoBrightness_ROI_Mode_Get(peak_camera_handle hCam, peak_auto_feature_roi_mode *autoBrightnessROIMode)
Get the auto brightness ROI mode.
peak_status peak_Gain_GetChannelList(peak_camera_handle hCam, peak_gain_type gainType, peak_gain_channel *gainChannelList, size_t *gainChannelCount)
Get the list of available gain channels for the given gain type.
uint8_t * memoryAddress
The memory address at which the buffer starts.
Definition: ids_peak_comfort_c.h:575
peak_status peak_Acquisition_Start(peak_camera_handle hCam, uint32_t numberOfFrames)
Start an acquisition.
User set 2.
Definition: ids_peak_comfort_c.h:2754
peak_status peak_GFA_String_Set(peak_camera_handle hCam, peak_gfa_module module, const char *stringFeatureName, const char *stringValue)
Set the string feature with the given name.
double element_02
Element 02.
Definition: ids_peak_comfort_c.h:676
User 1.
Definition: ids_peak_comfort_c.h:5504
Mono12 grouped 24.
Definition: ids_peak_comfort_c.h:2329
peak_access_status peak_IPL_AutoFocus_GetAccessStatus(peak_camera_handle hCam)
Query the auto focus access status.
Search algorithm Full Scan.
Definition: ids_peak_comfort_c.h:9411
double element_11
Element 11.
Definition: ids_peak_comfort_c.h:682
peak_status peak_AutoBrightness_TargetTolerance_Get(peak_camera_handle hCam, uint32_t *autoBrightnessTargetTolerance)
Get the auto brightness target tolerance value.
peak_status peak_GFA_Integer_GetList(peak_camera_handle hCam, peak_gfa_module module, const char *integerFeatureName, int64_t *integerList, size_t *integerCount)
Get the list of currently selectable values for the integer feature with the given name...
peak_status peak_GFA_Float_GetRange(peak_camera_handle hCam, peak_gfa_module module, const char *floatFeatureName, double *minFloatValue, double *maxFloatValue, double *incFloatValue)
Get the current range of valid values for the float feature with the given name.
Sharpness algorithm Sobel.
Definition: ids_peak_comfort_c.h:9487
peak_status peak_CameraSettings_ParameterSet_Apply(peak_camera_handle hCam, peak_parameter_set parameterSet)
Apply the specified parameter set.
peak_status peak_IPL_AutoFocus_Mode_Set(peak_camera_handle hCam, peak_auto_feature_mode autoFocusMode)
Set the host auto focus control mode.
HQ.
Definition: ids_peak_comfort_c.h:5495
peak_access_status peak_Gain_GetAccessStatus(peak_camera_handle hCam, peak_gain_type gainType, peak_gain_channel gainChannel)
Query the gain access status for the specified gain type and gain channel.
BayerBG12 grouped 24.
Definition: ids_peak_comfort_c.h:2317
peak_ip_config cameraPersistentIP
The current persistent ip address of the camera.
Definition: ids_peak_comfort_c.h:1586
peak_status peak_EthernetConfig_GetInfo(peak_camera_id cameraID, peak_ethernet_info *ethernetInfo)
Query the ethernet information.
peak_access_status peak_GFA_EnumerationEntry_GetAccessStatusBySymbolicValue(peak_camera_handle hCam, peak_gfa_module module, const char *enumerationFeatureName, const char *enumerationEntrySymbolicValue)
Query the access status of the enumeration entry by its symbolic value.
peak_status peak_GFA_Boolean_Get(peak_camera_handle hCam, peak_gfa_module module, const char *booleanFeatureName, peak_bool *booleanValue)
Get the boolean feature with the given name.
peak_access_status peak_Mirror_UpDown_GetAccessStatus(peak_camera_handle hCam)
Query the up-down mirroring access status.
peak_access_status peak_Trigger_Divider_GetAccessStatus(peak_camera_handle hCam)
Query the trigger divider property access status.
uint32_t numIncomplete
Number of incomplete frame transmissions.
Definition: ids_peak_comfort_c.h:1867
peak_status peak_Flash_Enable(peak_camera_handle hCam, peak_bool enabled)
Enable/Disable the flash.
peak_status peak_IPL_Gamma_GetRange(peak_camera_handle hCam, double *minGamma, double *maxGamma, double *incGamma)
Get the current range of valid host gamma values.
peak_status peak_Trigger_Mode_Set(peak_camera_handle hCam, peak_trigger_mode triggerMode)
Set the trigger mode.
peak_access_status peak_Decimation_GetAccessStatus(peak_camera_handle hCam)
Query the decimation access status.
peak_camera_memory_area
peak Camera Memory Area
Definition: ids_peak_comfort_c.h:7062
peak_status peak_Flash_EndDelay_GetRange(peak_camera_handle hCam, double *minFlashEndDelay_us, double *maxFlashEndDelay_us, double *incFlashEndDelay_us)
Get the current range of valid flash end delay values.
peak_video_container_option
peak container options
Definition: ids_peak_comfort_c.h:10199
Read write access.
Definition: ids_peak_comfort_c.h:887
peak_status peak_AutoBrightness_Gain_Mode_Set(peak_camera_handle hCam, peak_auto_feature_mode autoGainMode)
Set the auto gain control mode.
peak_status peak_Binning_FactorX_GetList(peak_camera_handle hCam, uint32_t *binningFactorXList, size_t *binningFactorXCount)
Get the list of currently selectable factors for the binning in x direction.
peak_status peak_ROI_Offset_GetRange(peak_camera_handle hCam, peak_position *minROIOffset, peak_position *maxROIOffset, peak_position *incROIOffset)
Get the current range of valid ROI offsets.
Mono12.
Definition: ids_peak_comfort_c.h:2197
peak_status peak_IPL_AutoWhiteBalance_ROI_Mode_Get(peak_camera_handle hCam, peak_auto_feature_roi_mode *autoWhiteBalanceROIMode)
Get the host auto white balance ROI mode.
peak_access_status peak_IOChannel_Inverter_GetAccessStatus(peak_camera_handle hCam, peak_io_channel ioChannel)
Query the io channel inverter property access status.
The camera persistent IP is not in the hosts subnet.
Definition: ids_peak_comfort_c.h:1552
Software.
Definition: ids_peak_comfort_c.h:3383
BGR8.
Definition: ids_peak_comfort_c.h:2209
peak_access_status peak_Flash_Mode_GetAccessStatus(peak_camera_handle hCam, peak_flash_mode flashMode)
Query the flash mode access status.
peak_status peak_AutoBrightness_ROI_Mode_Set(peak_camera_handle hCam, peak_auto_feature_roi_mode autoBrightnessROIMode)
Set the auto brightness ROI mode.
Focus ROI weight strong.
Definition: ids_peak_comfort_c.h:9237
peak_status peak_CameraMemory_Area_Data_Clear(peak_camera_handle hCam, peak_camera_memory_area cameraMemoryArea)
Clear a camera memory area.
peak_status peak_GFA_Integer_Get(peak_camera_handle hCam, peak_gfa_module module, const char *integerFeatureName, int64_t *integerValue)
Get the integer feature with the given name.
double element_20
Element 20.
Definition: ids_peak_comfort_c.h:688
peak_access_status peak_EthernetConfig_GetAccessStatus(peak_camera_id cameraID)
Query the ethernet configuration access status.
BayerRG12 grouped 24.
Definition: ids_peak_comfort_c.h:2305
peak_status peak_Decimation_Get(peak_camera_handle hCam, uint32_t *decimationFactorX, uint32_t *decimationFactorY)
Get the decimation factors.
peak_status peak_AutoWhiteBalance_ROI_Get(peak_camera_handle hCam, peak_roi *autoWhiteBalanceROI)
Get the auto white balance ROI.
peak_status peak_Library_Init()
Init the peak comfortC library.
peak_access_status peak_Trigger_Burst_GetAccessStatus(peak_camera_handle hCam)
Query the trigger burst property access status.
void * userContext
User context pointer.
Definition: ids_peak_comfort_c.h:587
peak_status peak_GFA_String_Get(peak_camera_handle hCam, peak_gfa_module module, const char *stringFeatureName, char *stringValue, size_t *stringValueSize)
Get the string feature with the given name.
peak_status peak_IPL_AutoFocus_Range_Get(peak_camera_handle hCam, uint32_t *rangeBegin, uint32_t *rangeEnd)
Get the host auto focus range.
The set value was auto-adjusted.
Definition: ids_peak_comfort_c.h:733
peak_status peak_Frame_ID_Get(peak_frame_handle hFrame, uint64_t *frameID)
Query the frame id of a frame.
peak_status peak_IPL_ColorCorrection_Saturation_Get(peak_camera_handle hCam, double *saturation)
Get the saturation value.
peak_status peak_GFA_Enumeration_SetBySymbolicValue(peak_camera_handle hCam, peak_gfa_module module, const char *enumerationFeatureName, const char *enumerationEntrySymbolicValue)
Set the enumeration feature with the given name by the entries symbolic value.
Quality encoder option.
Definition: ids_peak_comfort_c.h:10233
peak_status peak_IPL_AutoBrightness_ROI_Offset_GetRange(peak_camera_handle hCam, peak_position *minAutoBrightnessROIOffset, peak_position *maxAutoBrightnessROIOffset, peak_position *incAutoBrightnessROIOffset)
Get the current range of valid host auto brightness ROI offsets.
peak_access_status peak_Flash_GetAccessStatus(peak_camera_handle hCam)
Query the flash feature access status.
int64_t integerValue
The integer value of the enumeration entry.
Definition: ids_peak_comfort_c.h:7932
peak_status peak_PixelFormat_Get(peak_camera_handle hCam, peak_pixel_format *pixelFormat)
Get the pixel format.
peak_status peak_CameraSettings_DiskFile_Apply(peak_camera_handle hCam, const char *file)
Apply the camera configuration from the specified disk file.
peak_bool peak_ColorCorrection_IsEnabled(peak_camera_handle hCam)
Get the enabled status of the color correction.
Invalid pixel format.
Definition: ids_peak_comfort_c.h:2152
Any edge.
Definition: ids_peak_comfort_c.h:4040
peak Ethernet info
Definition: ids_peak_comfort_c.h:1574
peak_trigger_target
peak Trigger target
Definition: ids_peak_comfort_c.h:3733
BayerBG10.
Definition: ids_peak_comfort_c.h:2185
peak_status peak_IPL_PixelFormat_GetList(peak_camera_handle hCam, peak_pixel_format inputPixelFormat, peak_pixel_format *outputPixelFormatList, size_t *outputPixelFormatCount)
Get a list of supported output pixel formats for a specific input pixelformat.
peak_status peak_IPL_AutoFocus_Mode_Get(peak_camera_handle hCam, peak_auto_feature_mode *autoFocusMode)
Get the host auto focus control mode.
Write only access.
Definition: ids_peak_comfort_c.h:881
BGR12.
Definition: ids_peak_comfort_c.h:2215
Blue channel.
Definition: ids_peak_comfort_c.h:5235
Invalid ethernet status.
Definition: ids_peak_comfort_c.h:1532
BayerGB10.
Definition: ids_peak_comfort_c.h:2176
peak Frame info
Definition: ids_peak_comfort_c.h:2453
peak_status peak_AutoBrightness_Gain_Mode_Get(peak_camera_handle hCam, peak_auto_feature_mode *autoGainMode)
Get the auto gain control mode.
peak_access_status peak_PixelClock_GetAccessStatus(peak_camera_handle hCam)
Query the pixel clock access status.
peak_status peak_Library_GetLastError(peak_status *lastErrorCode, char *lastErrorMessage, size_t *lastErrorMessageSize)
Query the last error.
The specified or requested data is not present.
Definition: ids_peak_comfort_c.h:782
peak_status peak_Acquisition_Buffer_Announce(peak_camera_handle hCam, uint8_t *memoryAddress, size_t memorySize, void *userContext)
Announce an image buffer.
BayerGR12.
Definition: ids_peak_comfort_c.h:2161
peak_status peak_CameraList_Get(peak_camera_descriptor *cameraList, size_t *cameraCount)
Query the current camera list.
peak_status peak_IPL_AutoFocus_Range_Set(peak_camera_handle hCam, uint32_t rangeBegin, uint32_t rangeEnd)
Set the host auto focus range.
peak_status peak_IPL_Mirror_LeftRight_Enable(peak_camera_handle hCam, peak_bool enabled)
Enable/Disable the left-right host mirroring.
peak_status peak_IPL_AutoBrightness_ROI_Mode_Get(peak_camera_handle hCam, peak_auto_feature_roi_mode *autoBrightnessROIMode)
Get the host auto brightness ROI mode.
peak_status peak_Binning_Set(peak_camera_handle hCam, uint32_t binningFactorX, uint32_t binningFactorY)
Set the binning factors.
peak_auto_focus_search_algorithm
The peak focus search algorithm.
Definition: ids_peak_comfort_c.h:9380
peak_status peak_AutoWhiteBalance_ROI_Set(peak_camera_handle hCam, peak_roi autoWhiteBalanceROI)
Set the auto white balance ROI.
peak_status peak_ROI_Set(peak_camera_handle hCam, peak_roi roi)
Set the ROI.
uint16_t high_part
Upper 2 bytes of the MAC address.
Definition: ids_peak_comfort_c.h:1270
RGBa8.
Definition: ids_peak_comfort_c.h:2218
peak_access_status peak_ColorCorrection_GetAccessStatus(peak_camera_handle hCam)
Query the color correction access status.
peak_access_status peak_EthernetConfig_DHCP_GetAccessStatus(peak_camera_id cameraID)
Query the dhcp access status.
double element_00
Element 00.
Definition: ids_peak_comfort_c.h:670
peak_flash_reference
peak Flash reference
Definition: ids_peak_comfort_c.h:4450
Device or resource is busy.
Definition: ids_peak_comfort_c.h:788
peak_status peak_IPL_HotpixelCorrection_Sensitivity_Set(peak_camera_handle hCam, peak_hotpixel_correction_sensitivity hotpixelCorrectionSensitivity)
Set the host hotpixel correction sensitivity level.
Invalid flash reference.
Definition: ids_peak_comfort_c.h:4456
peak_status peak_Focus_Set(peak_camera_handle hCam, uint32_t focus)
Set the focus value.
uint64_t peak_camera_id
peak Camera ID
Definition: ids_peak_comfort_c.h:1073
Audio Video Interleave.
Definition: ids_peak_comfort_c.h:10000
Global start window.
Definition: ids_peak_comfort_c.h:4468
BayerRG12 packed.
Definition: ids_peak_comfort_c.h:2245
Unspecified warning.
Definition: ids_peak_comfort_c.h:726
peak_auto_feature_mode
peak Auto feature mode
Definition: ids_peak_comfort_c.h:5745
peak_status peak_IPL_AutoBrightness_ROI_Get(peak_camera_handle hCam, peak_roi *autoBrightnessROI)
Get the host auto brightness ROI.
peak_status peak_IPL_Gain_GetRange(peak_camera_handle hCam, peak_gain_channel gainChannel, double *minGain, double *maxGain, double *incGain)
Get the current range of valid host gain values for the specified gain channel.
peak_status peak_GFA_Register_Set(peak_camera_handle hCam, peak_gfa_module module, const char *registerFeatureName, const uint8_t *registerValue, size_t registerValueSize)
Set the register feature with the given name.
peak_access_status peak_FrameRate_GetAccessStatus(peak_camera_handle hCam)
Query the frame rate access status.
Acquisition active.
Definition: ids_peak_comfort_c.h:4474
peak_status peak_Mirror_UpDown_Enable(peak_camera_handle hCam, peak_bool enabled)
Enable/Disable the up-down mirroring.
peak_status peak_Mirror_LeftRight_Enable(peak_camera_handle hCam, peak_bool enabled)
Enable/Disable the left-right mirroring.
peak_status peak_IPL_ColorCorrection_Matrix_Set(peak_camera_handle hCam, peak_matrix colorCorrectionMatrix)
Sets the cost color correction matrix.
peak_status peak_AutoBrightness_TargetPercentile_Set(peak_camera_handle hCam, double autoBrightnessTargetPercentile)
Set the auto brightness target percentile value.
peak_pixel_format
peak Pixel format
Definition: ids_peak_comfort_c.h:2146
peak_status peak_IPL_AutoWhiteBalance_ROI_Size_GetRange(peak_camera_handle hCam, peak_size *minAutoWhiteBalanceROISize, peak_size *maxAutoWhiteBalanceROISize, peak_size *incAutoWhiteBalanceROISize)
Get the current range of valid host auto white balance ROI sizes.
peak_status peak_FrameRate_Set(peak_camera_handle hCam, double frameRate_fps)
Set the frame rate.
peak_status peak_IPL_HotpixelCorrection_Enable(peak_camera_handle hCam, peak_bool enabled)
Enable/Disable the host hotpixel correction.
BayerGB12 grouped 24.
Definition: ids_peak_comfort_c.h:2311
peak_trigger_target triggerTarget
The trigger target.
Definition: ids_peak_comfort_c.h:3782
peak_status peak_Gamma_Get(peak_camera_handle hCam, double *gamma)
Get the gamma value.
peak_status peak_ColorCorrection_Matrix_Get(peak_camera_handle hCam, peak_matrix *colorCorrectionMatrix)
Get the color correction matrix.
double element_21
Element 21.
Definition: ids_peak_comfort_c.h:691
peak_status peak_IPL_AutoBrightness_Target_Set(peak_camera_handle hCam, uint32_t autoBrightnessTarget)
Set the host auto brightness target value.
The GFA module for the access of the GenICam GenTL System module.
Definition: ids_peak_comfort_c.h:7343
peak_status peak_Flash_Mode_Set(peak_camera_handle hCam, peak_flash_mode flashMode)
Set the flash mode.
peak_status peak_Acquisition_Buffer_GetRequiredSize(peak_camera_handle hCam, size_t *requiredBufferSize)
Query the required image buffer size.
BayerGB10 packed.
Definition: ids_peak_comfort_c.h:2248
peak_status peak_PixelFormat_GetInfo(peak_pixel_format pixelFormat, peak_pixel_format_info *pixelFormatInfo)
Query the pixel format info.
Invalid auto feature mode.
Definition: ids_peak_comfort_c.h:5751
A timeout occurred.
Definition: ids_peak_comfort_c.h:776
peak_roi roi
The peak ROI (2D)
Definition: ids_peak_comfort_c.h:9250
peak_auto_feature_roi_mode
peak Auto feature ROI mode
Definition: ids_peak_comfort_c.h:5781
peak_parameter_set
peak Parameter set
Definition: ids_peak_comfort_c.h:2716
Focus ROI weight weak.
Definition: ids_peak_comfort_c.h:9231
peak_status peak_VideoWriter_Encoder_Option_Set(peak_video_handle hVideo, peak_video_encoder_option encoderOption, const void *value, size_t count)
Set additional encoder options.
peak_access_status peak_Gamma_GetAccessStatus(peak_camera_handle hCam)
Query the gamma access status.
peak_status peak_IPL_AutoFocus_ROI_Set(peak_camera_handle hCam, const peak_focus_roi *autoFocusROIList, size_t autoFocusROICount)
Set the list of host auto focus regions of interest.
peak_access_status peak_IOChannel_Level_GetAccessStatus(peak_camera_handle hCam, peak_io_channel ioChannel)
Query the io channel level property access status.
peak_status peak_IPL_AutoBrightness_Target_Get(peak_camera_handle hCam, uint32_t *autoBrightnessTarget)
Get the host auto brightness target value.
uint32_t numDropped
Number of dropped frames.
Definition: ids_peak_comfort_c.h:1859
peak_status peak_PixelClock_GetList(peak_camera_handle hCam, double *pixelClockList, size_t *pixelClockCount)
Get the list of currently selectable pixel clock values.
The peak ROI (2D)
Definition: ids_peak_comfort_c.h:637
peak_access_status peak_CameraSettings_ParameterSet_GetAccessStatus(peak_camera_handle hCam, peak_parameter_set parameterSet)
Query the parameter set access status.
size_t bytesWritten
The number of bytes actually written to the buffer.
Definition: ids_peak_comfort_c.h:2502
Invalid trigger edge.
Definition: ids_peak_comfort_c.h:4022
peak_status peak_Trigger_Mode_Get(peak_camera_handle hCam, peak_trigger_mode *triggerMode)
Get the trigger mode.
peak_status peak_CameraSettings_ParameterSet_Store(peak_camera_handle hCam, peak_parameter_set parameterSet)
Store the current camera configuration in a user-definable parameter set.
peak_access_status peak_Trigger_Mode_GetAccessStatus(peak_camera_handle hCam, peak_trigger_mode triggerMode)
Query the trigger mode access status.
BGR10 packed 32.
Definition: ids_peak_comfort_c.h:2269
Auto feature mode Continuous.
Definition: ids_peak_comfort_c.h:5771
peak_focus_roi_weight
The peak focus ROI weight classes.
Definition: ids_peak_comfort_c.h:9222
Search algorithm Golden Ratio.
Definition: ids_peak_comfort_c.h:9392
peak_io_channel
peak IO channel
Definition: ids_peak_comfort_c.h:3365
peak_video_container
peak Container types
Definition: ids_peak_comfort_c.h:9991
Auto feature Off.
Definition: ids_peak_comfort_c.h:5759
peak_frame_type
peak Frame type
Definition: ids_peak_comfort_c.h:2429
peak_access_status peak_ColorCorrection_Matrix_GetAccessStatus(peak_camera_handle hCam)
Query the color correction matrix access status.
peak_bool peak_IPL_Mirror_LeftRight_IsEnabled(peak_camera_handle hCam)
Get the enabled status of the left-right host mirroring.
peak Buffer descriptor
Definition: ids_peak_comfort_c.h:572
RGB8.
Definition: ids_peak_comfort_c.h:2200
peak_io_channel ioChannel
The iO channel.
Definition: ids_peak_comfort_c.h:3788
double element_01
Element 01.
Definition: ids_peak_comfort_c.h:673
peak_status peak_IPL_AutoBrightness_ROI_Size_GetRange(peak_camera_handle hCam, peak_size *minAutoBrightnessROISize, peak_size *maxAutoBrightnessROISize, peak_size *incAutoBrightnessROISize)
Get the current range of valid host auto brightness ROI sizes.
peak_status peak_Trigger_Execute(peak_camera_handle hCam)
Execute the trigger.
peak_status peak_IPL_AutoFocus_SearchAlgorithm_Get(peak_camera_handle hCam, peak_auto_focus_search_algorithm *searchAlgorithm)
Get the host auto focus search algorithm.
peak_status peak_IPL_AutoWhiteBalance_Mode_Get(peak_camera_handle hCam, peak_auto_feature_mode *autoWhiteBalanceMode)
Get the host auto white balance control mode.
peak_bool peak_Mirror_UpDown_IsEnabled(peak_camera_handle hCam)
Get the enabled status of the up-down mirroring.
Invalid io channel.
Definition: ids_peak_comfort_c.h:3371
peak_status peak_GFA_Register_Get(peak_camera_handle hCam, peak_gfa_module module, const char *registerFeatureName, uint8_t *registerValue, size_t *registerValueSize)
Get the register feature with the given name.
peak_status peak_AutoBrightness_Target_Get(peak_camera_handle hCam, uint32_t *autoBrightnessTarget)
Get the auto brightness target value.
peak Trigger mode
Definition: ids_peak_comfort_c.h:3776
BayerBG8.
Definition: ids_peak_comfort_c.h:2182
peak_status peak_Library_GetVersion(uint32_t *majorVersion, uint32_t *minorVersion, uint32_t *subminorVersion, uint32_t *patchVersion)
Query the library version.
peak_status peak_Frame_Type_Get(peak_frame_handle hFrame, peak_frame_type *frameType)
Query the type of a frame.
uint32_t width
Width.
Definition: ids_peak_comfort_c.h:604
uint8_t peak_bool
peak Boolean type
Definition: ids_peak_comfort_c.h:545
Auto feature mode Once.
Definition: ids_peak_comfort_c.h:5765
peak_status peak_Flash_Mode_Get(peak_camera_handle hCam, peak_flash_mode *flashMode)
Get the flash mode.
Level controlled exposure.
Definition: ids_peak_comfort_c.h:3751
peak_status peak_IPL_HotpixelCorrection_SetList(peak_camera_handle hCam, peak_position *hotpixelList, size_t hotpixelCount)
Set the list of host hotpixel positions.
GPIO 1 pin.
Definition: ids_peak_comfort_c.h:3401
peak_gain_channel
peak Gain channel
Definition: ids_peak_comfort_c.h:5220
peak_access_status peak_CameraSettings_ParameterSet_Startup_GetAccessStatus(peak_camera_handle hCam)
Query the startup parameter set access status.
peak_status peak_Decimation_FactorY_GetList(peak_camera_handle hCam, uint32_t *decimationFactorYList, size_t *decimationFactorYCount)
Get the list of currently selectable factors for the decimation in y direction.
BGRa10.
Definition: ids_peak_comfort_c.h:2230
peak_status peak_IOChannel_NoiseFilter_Duration_Get(peak_camera_handle hCam, peak_io_channel ioChannel, double *noiseFilterDuration_us)
Get the io channel noise filter duration.
peak_focus_roi_weight weight
The ROI weight.
Definition: ids_peak_comfort_c.h:9253
uint32_t numSignificantBitsPerChannel
Significant bits per channel.
Definition: ids_peak_comfort_c.h:2370
peak_access_status peak_Flash_EndDelay_GetAccessStatus(peak_camera_handle hCam)
Query the flash end delay property access status.
peak_status peak_Gain_GetRange(peak_camera_handle hCam, peak_gain_type gainType, peak_gain_channel gainChannel, double *minGain, double *maxGain, double *incGain)
Get the current range of valid gain values for the specified gain type and gain channel.
peak_status peak_IPL_HotpixelCorrection_ResetList(peak_camera_handle hCam)
Reset the list of host hotpixel positions.
peak_status peak_Frame_GetInfo(peak_frame_handle hFrame, peak_frame_info *frameInfo)
Query the frame info.
peak_bool peak_IPL_ColorCorrection_IsEnabled(peak_camera_handle hCam)
Get the enabled status of the host color correction.
peak_status peak_Camera_GetDescriptor(peak_camera_id cameraID, peak_camera_descriptor *cameraDescriptor)
Query the camera descriptor.
peak_access_status peak_Trigger_Edge_GetAccessStatus(peak_camera_handle hCam)
Query the trigger edge property access status.
peak_access_status peak_GFA_EnumerationEntry_GetAccessStatus(peak_camera_handle hCam, peak_gfa_module module, const char *enumerationFeatureName, const peak_gfa_enumeration_entry *enumerationEntry)
Query the access status of the enumeration entry.
peak_status peak_GFA_Float_GetList(peak_camera_handle hCam, peak_gfa_module module, const char *floatFeatureName, double *floatList, size_t *floatCount)
Get the list of currently selectable values for the float feature with the given name.
peak_access_status peak_Binning_GetAccessStatus(peak_camera_handle hCam)
Query the binning access status.
Invalid parameter set.
Definition: ids_peak_comfort_c.h:2722
peak_status peak_Trigger_Burst_Get(peak_camera_handle hCam, uint32_t *triggerBurst)
Get the trigger burst.
peak_status peak_AutoBrightness_ROI_Size_GetRange(peak_camera_handle hCam, peak_size *minAutoBrightnessROISize, peak_size *maxAutoBrightnessROISize, peak_size *incAutoBrightnessROISize)
Get the current range of valid auto brightness ROI sizes.
peak_bool peak_IOChannel_Level_IsHigh(peak_camera_handle hCam, peak_io_channel ioChannel)
Get the level of the io channel.
peak_size size
ROI size.
Definition: ids_peak_comfort_c.h:643
peak_status peak_IPL_AutoBrightness_Target_GetRange(peak_camera_handle hCam, uint32_t *minAutoBrightnessTarget, uint32_t *maxAutoBrightnessTarget, uint32_t *incAutoBrightnessTarget)
Get the current range of valid host auto brightness target values.
peak_status peak_Acquisition_Buffer_RevokeAll(peak_camera_handle hCam)
Revoke all image buffers.
peak_status peak_Acquisition_Stop(peak_camera_handle hCam)
Stops an acquisition.
peak_status peak_Binning_FactorY_GetList(peak_camera_handle hCam, uint32_t *binningFactorYList, size_t *binningFactorYCount)
Get the list of currently selectable factors for the binning in y direction.
peak_status peak_IPL_HotpixelCorrection_GetList(peak_camera_handle hCam, peak_position *hotpixelList, size_t *hotpixelCount)
Get the list of detected host hotpixel correction positions/pixels.
peak_status peak_IPL_AutoBrightness_TargetPercentile_Get(peak_camera_handle hCam, double *autoBrightnessTargetPercentile)
Get the host auto brightness target percentile value.
uEye+ GigE Vision camera
Definition: ids_peak_comfort_c.h:1043
peak_trigger_edge
peak Trigger edge
Definition: ids_peak_comfort_c.h:4016
peak_status peak_ColorCorrection_Matrix_GetRange(peak_camera_handle hCam, double *minMatrixElementValue, double *maxMatrixElementValue, double *incMatrixElementValue)
Get the current range of valid color correction matrix element values.
peak_status peak_FrameRate_Get(peak_camera_handle hCam, double *frameRate_fps)
Get the frame rate.
peak_status peak_IPL_AutoFocus_Hysteresis_Set(peak_camera_handle hCam, uint8_t hysteresis)
Set the host auto focus hysteresis.
peak_status peak_IPL_AutoFocus_SearchAlgorithm_Set(peak_camera_handle hCam, peak_auto_focus_search_algorithm searchAlgorithm)
Set the host auto focus search algorithm.
peak_buffer buffer
The memory buffer that stores the frame contents.
Definition: ids_peak_comfort_c.h:2459
peak_status peak_IPL_AutoBrightness_Exposure_Mode_Set(peak_camera_handle hCam, peak_auto_feature_mode autoExposureMode)
Set the host auto exposure control mode.
Read only access.
Definition: ids_peak_comfort_c.h:875
BayerGR8.
Definition: ids_peak_comfort_c.h:2155
uint32_t maxValuePerChannel
Maximum value per channel.
Definition: ids_peak_comfort_c.h:2376
peak_bool peak_GFA_Float_HasRange(peak_camera_handle hCam, peak_gfa_module module, const char *floatFeatureName)
Check whether the valid values for the float feature with the given name are organized as a range...
peak_status peak_Focus_GetRange(peak_camera_handle hCam, uint32_t *minFocus, uint32_t *maxFocus, uint32_t *incFocus)
Get the current range of valid focus values.
peak_sharpness_algorithm
The peak sharpness measurement algorithm.
Definition: ids_peak_comfort_c.h:9463
uEye+ USB3 Vision camera
Definition: ids_peak_comfort_c.h:1040
peak_status peak_CameraMemory_Area_Data_Write(peak_camera_handle hCam, peak_camera_memory_area cameraMemoryArea, const uint8_t *data, size_t dataSize)
Write to a camera memory area.
uint64_t timestamp_ns
The timestamp in nanoseconds.
Definition: ids_peak_comfort_c.h:2474
uint64_t frameID
The frame id.
Definition: ids_peak_comfort_c.h:2468
Master channel.
Definition: ids_peak_comfort_c.h:5238
BayerBG grouped 40.
Definition: ids_peak_comfort_c.h:2293
Invalid frame type.
Definition: ids_peak_comfort_c.h:2435
peak Flash mode
Definition: ids_peak_comfort_c.h:4500
peak_status peak_VideoWriter_Container_Option_Get(peak_video_handle hVideo, peak_video_container_option containerOption, void *value, size_t count, size_t *outCount)
Get container options.
peak_status peak_CameraMemory_Area_Size_Get(peak_camera_handle hCam, peak_camera_memory_area cameraMemoryArea, size_t *cameraMemoryAreaSize)
Get the size of a camera memory area.
peak_status peak_AutoBrightness_ROI_Set(peak_camera_handle hCam, peak_roi autoBrightnessROI)
Set the auto brightness ROI.
peak_mac_address hostMAC
The mac address of the host.
Definition: ids_peak_comfort_c.h:1597
peak Acquisition info
Definition: ids_peak_comfort_c.h:1843
peak_status peak_Trigger_Edge_Set(peak_camera_handle hCam, peak_trigger_edge triggerEdge)
Set the trigger edge.
struct peak_frame * peak_frame_handle
peak Frame handle
Definition: ids_peak_comfort_c.h:1833
peak_status peak_Decimation_Set(peak_camera_handle hCam, uint32_t decimationFactorX, uint32_t decimationFactorY)
Set the decimation factors.
peak_status peak_VideoWriter_Container_Option_Set(peak_video_handle hVideo, peak_video_container_option containerOption, const void *value, size_t count)
Set additional container options.
peak_status peak_AutoWhiteBalance_ROI_Mode_Set(peak_camera_handle hCam, peak_auto_feature_roi_mode autoWhiteBalanceROIMode)
Set the auto white balance ROI mode.
BayerGR10.
Definition: ids_peak_comfort_c.h:2158
Exposure active.
Definition: ids_peak_comfort_c.h:4462
peak_status peak_Trigger_Divider_Get(peak_camera_handle hCam, uint32_t *triggerDivider)
Get the trigger divider.
peak GFA enumeration entry
Definition: ids_peak_comfort_c.h:7926
Invalid container.
Definition: ids_peak_comfort_c.h:9997
peak_status peak_Trigger_Edge_Get(peak_camera_handle hCam, peak_trigger_edge *triggerEdge)
Get the trigger edge.
peak_status peak_GFA_Boolean_Set(peak_camera_handle hCam, peak_gfa_module module, const char *booleanFeatureName, peak_bool booleanValue)
Set the boolean feature with the given name.
peak_bool peak_PixelClock_HasRange(peak_camera_handle hCam)
Check whether the valid values for the pixel clock feature are organized as a range.
Sharpness algorithm Sobel.
Definition: ids_peak_comfort_c.h:9493
peak_status peak_CameraList_Update(size_t *cameraCount)
Update the camera list.
peak_status peak_Gain_Set(peak_camera_handle hCam, peak_gain_type gainType, peak_gain_channel gainChannel, double gain)
Set the gain for the specified gain type and gain channel.
The handle is invalid.
Definition: ids_peak_comfort_c.h:761
peak_status peak_Trigger_Delay_Set(peak_camera_handle hCam, double triggerDelay_us)
Set the trigger delay.
peak_status peak_GFA_Data_Read(peak_camera_handle hCam, peak_gfa_module module, uint64_t address, uint8_t *data, size_t dataSize)
Read data from the specified register address.
peak_ethernet_status cameraEthernetStatus
The current ethernet status of the camera.
Definition: ids_peak_comfort_c.h:1589
peak_status peak_Acquisition_Buffer_GetRequiredCount(peak_camera_handle hCam, size_t *requiredBufferCount)
Query the required image buffer count.
hotpixel correction sensitivity level 4
Definition: ids_peak_comfort_c.h:9676
peak_status peak_Library_Exit()
Exit the peak comfortC library.
peak_status peak_Focus_Get(peak_camera_handle hCam, uint32_t *focus)
Get the focus value.
peak_status peak_ROI_Size_GetRange(peak_camera_handle hCam, peak_size *minROISize, peak_size *maxROISize, peak_size *incROISize)
Get the current range of valid ROI sizes.
Search algorithm Hill Climbing.
Definition: ids_peak_comfort_c.h:9399
peak_status peak_Gamma_GetRange(peak_camera_handle hCam, double *minGamma, double *maxGamma, double *incGamma)
Get the current range of valid gamma values.
Falling edge.
Definition: ids_peak_comfort_c.h:4034
peak_status peak_Flash_Duration_GetRange(peak_camera_handle hCam, double *minFlashDuration_us, double *maxFlashDuration_us, double *incFlashDuration_us)
Get the current range of valid flash duration values.
peak_access_status
peak Access status codes
Definition: ids_peak_comfort_c.h:839
peak_bool peak_Acquisition_IsStarted(peak_camera_handle hCam)
Check whether the acquisition is currently started or not.
peak_access_status peak_IOChannel_GetAccessStatus(peak_camera_handle hCam, peak_io_channel ioChannel)
Query the io channel access status.
peak_status peak_ColorCorrection_Mode_Get(peak_camera_handle hCam, peak_color_correction_mode *colorCorrectionMode)
Get the color correction mode.
peak_color_correction_mode
peak Color correction mode
Definition: ids_peak_comfort_c.h:5483
peak_status peak_IPL_AutoBrightness_TargetTolerance_Get(peak_camera_handle hCam, uint32_t *autoBrightnessTargetTolerance)
Get the host auto brightness target tolerance value.
peak_status peak_Trigger_Delay_Get(peak_camera_handle hCam, double *triggerDelay_us)
Get the trigger delay.
peak_status peak_Flash_Duration_Set(peak_camera_handle hCam, double flashDuration_us)
Set the flash duration.
uint32_t height
Height.
Definition: ids_peak_comfort_c.h:607
peak_access_status peak_Camera_GetAccessStatus(peak_camera_id cameraID)
Query the camera access status.
peak_status peak_AutoBrightness_Target_Set(peak_camera_handle hCam, uint32_t autoBrightnessTarget)
Set the auto brightness target value.
uint32_t addr
The IP address in little-endian word representation.
Definition: ids_peak_comfort_c.h:1492
Default set.
Definition: ids_peak_comfort_c.h:2728
peak_status peak_Frame_ProcessingTime_Get(peak_frame_handle hFrame, uint32_t *processingTime_ms)
Query the processing time of a frame.
Invalid gain type.
Definition: ids_peak_comfort_c.h:5201
peak Pixel format info
Definition: ids_peak_comfort_c.h:2340
peak_status peak_PixelClock_Set(peak_camera_handle hCam, double pixelClock_MHz)
Set the pixel clock.
uint32_t processingTime_ms
The host side processing time.
Definition: ids_peak_comfort_c.h:2508
peak_status peak_PixelClock_GetRange(peak_camera_handle hCam, double *minPixelClock_MHz, double *maxPixelClock_MHz, double *incPixelClock_MHz)
Get the current range of valid pixel clock values.
peak_bool peak_IPL_HotpixelCorrection_IsEnabled(peak_camera_handle hCam)
Get the enabled status of the host hotpixel correction.
peak_status peak_Flash_EndDelay_Set(peak_camera_handle hCam, double flashEndDelay_us)
Set the flash end delay.
BayerBG10 packed.
Definition: ids_peak_comfort_c.h:2254
peak_status peak_Flash_EndDelay_Get(peak_camera_handle hCam, double *flashEndDelay_us)
Get the flash end delay.
Invalid access status code.
Definition: ids_peak_comfort_c.h:848
peak MAC-48 address
Definition: ids_peak_comfort_c.h:1261
peak_position offset
ROI offset.
Definition: ids_peak_comfort_c.h:640
peak_status peak_IPL_AutoFocus_Hysteresis_GetRange(peak_camera_handle hCam, uint8_t *minHysteresis, uint8_t *maxHysteresis, uint8_t *incHysteresis)
Get the current range of valid auto focus hysteresis values.
peak_status peak_IPL_ProcessFrame(peak_camera_handle hCam, peak_frame_handle hFrame, peak_frame_handle *hResultFrame)
Process a frame with the host image processing pipeline and store the result in a new frame...
peak_status peak_Binning_Get(peak_camera_handle hCam, uint32_t *binningFactorX, uint32_t *binningFactorY)
Get the binning factors.
peak_status peak_ROI_Get(peak_camera_handle hCam, peak_roi *roi)
Get the ROI.
peak_frame_type type
The type and format of the contents of the frame.
Definition: ids_peak_comfort_c.h:2456
peak_status peak_IPL_AutoBrightness_ROI_Set(peak_camera_handle hCam, peak_roi autoBrightnessROI)
Set the host auto brightness ROI.
BayerRG10.
Definition: ids_peak_comfort_c.h:2167
peak_video_encoder
peak Encoder types
Definition: ids_peak_comfort_c.h:9972
peak_status peak_PixelFormat_Set(peak_camera_handle hCam, peak_pixel_format pixelFormat)
Set the pixel format.
Mono10.
Definition: ids_peak_comfort_c.h:2194
struct peak_camera * peak_camera_handle
peak Camera handle
Definition: ids_peak_comfort_c.h:1058
Framerate container option.
Definition: ids_peak_comfort_c.h:10211
peak_status peak_ExposureTime_Set(peak_camera_handle hCam, double exposureTime_us)
Set the exposure time.
BayerGB12.
Definition: ids_peak_comfort_c.h:2179
peak_status peak_Trigger_Burst_GetRange(peak_camera_handle hCam, uint32_t *minTriggerBurst, uint32_t *maxTriggerBurst, uint32_t *incTriggerBurst)
Get the current range of valid trigger burst values.
double element_12
Element 12.
Definition: ids_peak_comfort_c.h:685
peak_status peak_AutoBrightness_Exposure_Mode_Set(peak_camera_handle hCam, peak_auto_feature_mode autoExposureMode)
Set the auto exposure control mode.
peak_status peak_AutoBrightness_ROI_Offset_GetRange(peak_camera_handle hCam, peak_position *minAutoBrightnessROIOffset, peak_position *maxAutoBrightnessROIOffset, peak_position *incAutoBrightnessROIOffset)
Get the current range of valid auto brightness ROI offsets.
Invalid camera type.
Definition: ids_peak_comfort_c.h:1031
peak_status peak_AutoBrightness_ROI_Get(peak_camera_handle hCam, peak_roi *autoBrightnessROI)
Get the auto brightness ROI.
Auto feature ROI mode Manual.
Definition: ids_peak_comfort_c.h:5805
peak_status peak_Frame_ROI_Get(peak_frame_handle hFrame, peak_roi *roi)
Query the size parameters of a frame.
RGB10 packed 32.
Definition: ids_peak_comfort_c.h:2266
peak_status peak_AutoBrightness_TargetTolerance_GetRange(peak_camera_handle hCam, uint32_t *minAutoBrightnessTargetTolerance, uint32_t *maxAutoBrightnessTargetTolerance, uint32_t *incAutoBrightnessTargetTolerance)
Get the current range of valid auto brightness target tolerance values.
Invalid focus ROI weight.
Definition: ids_peak_comfort_c.h:9228
peak_bool peak_IOChannel_Inverter_IsEnabled(peak_camera_handle hCam, peak_io_channel ioChannel)
Get the enabled status of the io channel inverter property.
peak_status peak_IPL_Gain_Set(peak_camera_handle hCam, peak_gain_channel gainChannel, double gain)
Set the host gain for the specified gain channel.
peak_camera_id cameraID
The camera id.
Definition: ids_peak_comfort_c.h:1096
uint32_t y
Y-Position.
Definition: ids_peak_comfort_c.h:627
peak_status peak_Flash_Duration_Get(peak_camera_handle hCam, double *flashDuration_us)
Get the flash duration.
size_t bytesExpected
The number of bytes expected for a complete image.
Definition: ids_peak_comfort_c.h:2493
No access.
Definition: ids_peak_comfort_c.h:869
peak_status peak_EthernetConfig_DHCP_Enable(peak_camera_id cameraID, peak_bool enabled)
Enable/Disable dhcp.
peak_status peak_Camera_Open(peak_camera_id cameraID, peak_camera_handle *hCam)
Open the camera by the Camera id.
peak Size (2D)
Definition: ids_peak_comfort_c.h:601
peak_status peak_GFA_Enumeration_GetList(peak_camera_handle hCam, peak_gfa_module module, const char *enumerationFeatureName, peak_gfa_enumeration_entry *enumerationEntryList, size_t *enumerationEntryCount)
Get the list of currently selectable enumeration entries.
Not supported.
Definition: ids_peak_comfort_c.h:856
peak_io_channel ioChannel
IO channel.
Definition: ids_peak_comfort_c.h:4512
peak_access_status peak_ExposureTime_GetAccessStatus(peak_camera_handle hCam)
Query the exposure time access status.
peak_status peak_CameraMemory_Area_Data_Read(peak_camera_handle hCam, peak_camera_memory_area cameraMemoryArea, uint8_t *data, size_t dataSize)
Read from the specified camera memory area.
peak_status peak_Camera_Close(peak_camera_handle hCam)
Close the camera.
peak_bool peak_Trigger_IsEnabled(peak_camera_handle hCam)
Get the enabled status of the trigger.
Red channel.
Definition: ids_peak_comfort_c.h:5229
RGBa10.
Definition: ids_peak_comfort_c.h:2221
peak_camera_type
peak Camera types
Definition: ids_peak_comfort_c.h:1025
peak_ip_config hostIP
The current subnet mask of the host.
Definition: ids_peak_comfort_c.h:1594
peak_status peak_ExposureTime_Get(peak_camera_handle hCam, double *exposureTime_us)
Get the exposure time.
Invalid search algorithm type.
Definition: ids_peak_comfort_c.h:9386
peak_status peak_Frame_PixelFormat_Get(peak_frame_handle hFrame, peak_pixel_format *pixelFormat)
Query the pixel format of a frame.
peak_video_encoder_option
peak container options
Definition: ids_peak_comfort_c.h:10221
peak_ip_address subnetMask
The subnet mask.
Definition: ids_peak_comfort_c.h:1513
BGR10.
Definition: ids_peak_comfort_c.h:2212
peak_status peak_ColorCorrection_Mode_Set(peak_camera_handle hCam, peak_color_correction_mode colorCorrectionMode)
Set the color correction mode.
peak_status peak_IPL_AutoBrightness_Gain_Mode_Get(peak_camera_handle hCam, peak_auto_feature_mode *autoGainMode)
Get the host auto gain control mode.
peak_status peak_IOChannel_NoiseFilter_Enable(peak_camera_handle hCam, peak_io_channel ioChannel, peak_bool enabled)
Enable/Disable the io channel noise filter property.
peak_status peak_IPL_AutoWhiteBalance_ROI_Offset_GetRange(peak_camera_handle hCam, peak_position *minAutoWhiteBalanceROIOffset, peak_position *maxAutoWhiteBalanceROIOffset, peak_position *incAutoWhiteBalanceROIOffset)
Get the current range of valid host auto white balance ROI offsets.
BayerBG12.
Definition: ids_peak_comfort_c.h:2188
BayerRG10 grouped 40.
Definition: ids_peak_comfort_c.h:2281
peak_status peak_IPL_Mirror_UpDown_Enable(peak_camera_handle hCam, peak_bool enabled)
Enable/Disable the up-down host mirroring.
peak_access_status peak_Focus_GetAccessStatus(peak_camera_handle hCam)
Query the focus access status.
peak_status peak_AutoBrightness_TargetTolerance_Set(peak_camera_handle hCam, uint32_t autoBrightnessTargetTolerance)
Set the auto brightness target tolerance value.
BayerGB10 grouped 40.
Definition: ids_peak_comfort_c.h:2287
peak_hotpixel_correction_sensitivity
peak hotpixel correction sensitivity level
Definition: ids_peak_comfort_c.h:9651
Flash output pin.
Definition: ids_peak_comfort_c.h:3395
Mono10 grouped 40.
Definition: ids_peak_comfort_c.h:2323
peak_status peak_IPL_AutoWhiteBalance_Mode_Set(peak_camera_handle hCam, peak_auto_feature_mode autoWhiteBalanceMode)
Set the host auto white balance control mode.
peak_camera_id peak_Camera_ID_FromHandle(peak_camera_handle hCam)
Query the camera id by the camera handle.
GPIO 2 pin.
Definition: ids_peak_comfort_c.h:3407
peak_status peak_PixelClock_Get(peak_camera_handle hCam, double *pixelClock_MHz)
Get the pixel clock.
peak_status peak_Trigger_Edge_GetList(peak_camera_handle hCam, peak_trigger_edge *triggerEdgeList, size_t *triggerEdgeCount)
Get the list of currently selectable trigger edges.
uint32_t numUnderrun
Number of buffer underruns.
Definition: ids_peak_comfort_c.h:1851
peak_status peak_Acquisition_Buffer_Revoke(peak_camera_handle hCam, uint8_t *memoryAddress)
Revoke an image buffer.
The library is not initialized.
Definition: ids_peak_comfort_c.h:746
peak Camera descriptor
Definition: ids_peak_comfort_c.h:1093
There is no such camera.
Definition: ids_peak_comfort_c.h:755
peak_status peak_IOChannel_NoiseFilter_Duration_GetRange(peak_camera_handle hCam, peak_io_channel ioChannel, double *minNoiseFilterDuration_us, double *maxNoiseFilterDuration_us, double *incNoiseFilterDuration_us)
Get the current range of valid io channel noise filter duration values.
Digital gain is used.
Definition: ids_peak_comfort_c.h:5207
peak_status peak_IPL_AutoWhiteBalance_ROI_Set(peak_camera_handle hCam, peak_roi autoWhiteBalanceROI)
Set the host auto white balance ROI.
peak_status peak_VideoWriter_GetInfo(peak_video_handle hVideo, peak_video_info *videoInfo)
Get information from the video stream.
Rising edge.
Definition: ids_peak_comfort_c.h:4028
Motion JPEG.
Definition: ids_peak_comfort_c.h:9981
Success.
Definition: ids_peak_comfort_c.h:723
peak_status peak_IPL_PixelFormat_Set(peak_camera_handle hCam, peak_pixel_format pixelFormat)
Set the output pixel format for host processing.
uint32_t numChannels
Number of channels.
Definition: ids_peak_comfort_c.h:2358
peak_access_status peak_GFA_Feature_GetAccessStatus(peak_camera_handle hCam, peak_gfa_module module, const char *featureName)
Query the access status of the feature with the given name.
peak_status peak_IOChannel_Inverter_Enable(peak_camera_handle hCam, peak_io_channel ioChannel, peak_bool enabled)
Enable/Disable the io channel inverter property.
peak_status peak_VideoWriter_Encoder_GetPixelFormatList(peak_video_encoder encoder, peak_pixel_format *pixelFormatList, size_t *pixelFormatCount)
Get the list of currently selectable pixel formats.
peak_status peak_GFA_Enumeration_Set(peak_camera_handle hCam, peak_gfa_module module, const char *enumerationFeatureName, const peak_gfa_enumeration_entry *enumerationEntry)
Set the enumeration feature with the given name.
peak_status peak_IPL_AutoFocus_ROI_Get(peak_camera_handle hCam, peak_focus_roi *autoFocusROIList, size_t *autoFocusROICount)
Get the list of host auto focus regions of interest.
The access to the requested feature was denied due to the current system status.
Definition: ids_peak_comfort_c.h:752
peak IPv4 address
Definition: ids_peak_comfort_c.h:1489
peak_status peak_IPL_AutoBrightness_TargetPercentile_GetRange(peak_camera_handle hCam, double *minAutoBrightnessTargetPercentile, double *maxAutoBrightnessTargetPercentile, double *incAutoBrightnessTargetPercentile)
Get the current range of valid host auto brightness target percentile values.
BayerGR12 grouped 24.
Definition: ids_peak_comfort_c.h:2299
peak_status peak_FrameRate_GetRange(peak_camera_handle hCam, double *minFrameRate_fps, double *maxFrameRate_fps, double *incFrameRate_fps)
Get the current range of valid frame rate values.
The operation was aborted.
Definition: ids_peak_comfort_c.h:779
peak_status peak_VideoWriter_Encoder_Option_Get(peak_video_handle hVideo, peak_video_encoder_option encoderOption, void *value, size_t count, size_t *outCount)
Get encoder options.
peak_status peak_ColorCorrection_Enable(peak_camera_handle hCam, peak_bool enabled)
Enable/Disable the color correction.
peak Position (2D)
Definition: ids_peak_comfort_c.h:621
RGBa12.
Definition: ids_peak_comfort_c.h:2224
BayerRG8.
Definition: ids_peak_comfort_c.h:2164
peak_status peak_PixelFormat_GetList(peak_camera_handle hCam, peak_pixel_format *pixelFormatList, size_t *pixelFormatCount)
Get the list of currently selectable pixel formats.
One or more parameters are invalid.
Definition: ids_peak_comfort_c.h:764
peak_status peak_CameraSettings_ParameterSet_Startup_Get(peak_camera_handle hCam, peak_parameter_set *parameterSet)
Get the startup parameter set.
peak_status peak_Trigger_Divider_GetRange(peak_camera_handle hCam, uint32_t *minTriggerDivider, uint32_t *maxTriggerDivider, uint32_t *incTriggerDivider)
Get the current range of valid trigger divider values.
peak_mac_address cameraMAC
The mac address of the camera.
Definition: ids_peak_comfort_c.h:1577
peak_status peak_IPL_ColorCorrection_Enable(peak_camera_handle hCam, peak_bool enabled)
Enable/Disable the host color correction.
peak_status peak_IPL_AutoFocus_SharpnessAlgorithm_Get(peak_camera_handle hCam, peak_sharpness_algorithm *sharpnessAlgorithm)
Get the focus sharpness algorithm.
peak_status peak_IPL_AutoWhiteBalance_ROI_Get(peak_camera_handle hCam, peak_roi *autoWhiteBalanceROI)
Get the host auto white balance ROI.
User set 1.
Definition: ids_peak_comfort_c.h:2747
peak_access_status peak_AutoBrightness_GetAccessStatus(peak_camera_handle hCam)
Query the auto brightness access status.
The peak focus ROI (2D) with weight.
Definition: ids_peak_comfort_c.h:9247
video info structure
Definition: ids_peak_comfort_c.h:10163
peak_bool peak_Frame_IsComplete(peak_frame_handle hFrame)
Check whether the frame is complete.
peak_status peak_AutoBrightness_TargetPercentile_GetRange(peak_camera_handle hCam, double *minAutoBrightnessTargetPercentile, double *maxAutoBrightnessTargetPercentile, double *incAutoBrightnessTargetPercentile)
Get the current range of valid auto brightness target percentile values.
peak_status peak_Frame_BytesWritten_Get(peak_frame_handle hFrame, size_t *bytesWritten)
Query the bytes written to the buffer of a frame.
peak_camera_type cameraType
The camera type.
Definition: ids_peak_comfort_c.h:1099
peak_status peak_EthernetConfig_PersistentIP_Get(peak_camera_id cameraID, peak_ip_config *persistentIP)
Get the persistent ip.
peak_status peak_GFA_Integer_GetRange(peak_camera_handle hCam, peak_gfa_module module, const char *integerFeatureName, int64_t *minIntegerValue, int64_t *maxIntegerValue, int64_t *incIntegerValue)
Get the current range of valid values for the integer feature with the given name.
peak_status peak_IPL_Gamma_Set(peak_camera_handle hCam, double gamma)
Set the host gamma value.
peak_status peak_Gain_Get(peak_camera_handle hCam, peak_gain_type gainType, peak_gain_channel gainChannel, double *gain)
Get the gain value for the specified gain type and gain channel.
peak_status peak_EthernetConfig_PersistentIP_Set(peak_camera_id cameraID, peak_ip_config persistentIP)
Set the persistent ip.
peak_status peak_Frame_Buffer_Get(peak_frame_handle hFrame, peak_buffer *buffer)
Query the buffer of a frame.
BayerRG10 packed.
Definition: ids_peak_comfort_c.h:2242
peak_status peak_IPL_AutoFocus_SharpnessAlgorithm_Set(peak_camera_handle hCam, peak_sharpness_algorithm sharpnessAlgorithm)
Set the host auto focus sharpness algorithm.
peak_status peak_AutoWhiteBalance_ROI_Mode_Get(peak_camera_handle hCam, peak_auto_feature_roi_mode *autoWhiteBalanceROIMode)
Get the auto white balance ROI mode.
peak_access_status peak_IOChannel_NoiseFilter_GetAccessStatus(peak_camera_handle hCam, peak_io_channel ioChannel)
Query the io channel noise filter property access status.
peak_status peak_GFA_Command_Execute(peak_camera_handle hCam, peak_gfa_module module, const char *commandFeatureName)
Execute the command feature with the given name.
peak IP configuration
Definition: ids_peak_comfort_c.h:1507
peak_status peak_Camera_UserDefinedName_Set(peak_camera_handle hCam, const char *userDefinedName)
Set the user defined name.
peak_status peak_IPL_AutoBrightness_Exposure_Mode_Get(peak_camera_handle hCam, peak_auto_feature_mode *autoExposureMode)
Get the host auto exposure control mode.
peak_camera_id peak_Camera_ID_FromUserDefinedName(const char *userDefinedName)
Query the camera id by the user defined name.
uEye Eth camera
Definition: ids_peak_comfort_c.h:1037
peak_ip_address address
The ip address.
Definition: ids_peak_comfort_c.h:1510
peak_status peak_VideoWriter_Encoder_GetContainerList(peak_video_encoder encoder, peak_video_container *containerList, size_t *containerCount)
Get the list of currently usable containers.
peak_access_status peak_ROI_GetAccessStatus(peak_camera_handle hCam)
Query the ROI access status.
Mono12 packed.
Definition: ids_peak_comfort_c.h:2263
peak_status peak_Frame_Release(peak_camera_handle hCam, peak_frame_handle hFrame)
Release a frame.
peak_access_status peak_Flash_StartDelay_GetAccessStatus(peak_camera_handle hCam)
Query the flash start delay property access status.
Cameras User Data 2 memory.
Definition: ids_peak_comfort_c.h:7080
BayerRG12.
Definition: ids_peak_comfort_c.h:2170
RGB10.
Definition: ids_peak_comfort_c.h:2203
peak_status peak_Camera_ResetToDefaultSettings(peak_camera_handle hCam)
Reset the camera configuration.
BayerGR10 grouped 40.
Definition: ids_peak_comfort_c.h:2275
peak_bool peak_IPL_Mirror_UpDown_IsEnabled(peak_camera_handle hCam)
Get the enabled status of the up-down host mirroring.
peak_status peak_IPL_ColorCorrection_Saturation_GetRange(peak_camera_handle hCam, double *minSaturation, double *maxSaturation, double *incSaturation)
Get the current range of valid saturation values.
Invalid sharpness algorithm type.
Definition: ids_peak_comfort_c.h:9469
peak_access_status peak_AutoBrightness_Exposure_GetAccessStatus(peak_camera_handle hCam)
Query the auto exposure control access status.
Invalid encoder option.
Definition: ids_peak_comfort_c.h:10227
peak_bool peak_GFA_Integer_HasRange(peak_camera_handle hCam, peak_gfa_module module, const char *integerFeatureName)
Check whether the valid values for the integer feature with the given name are organized as a range...
peak_status peak_GFA_Float_Set(peak_camera_handle hCam, peak_gfa_module module, const char *floatFeatureName, double floatValue)
Set the float feature with the given name.
None.
Definition: ids_peak_comfort_c.h:3377
peak_pixel_format pixelFormat
The pixel format.
Definition: ids_peak_comfort_c.h:2480
The peak 3x3 Matrix.
Definition: ids_peak_comfort_c.h:664
peak_status peak_AutoWhiteBalance_Mode_Set(peak_camera_handle hCam, peak_auto_feature_mode autoWhiteBalanceMode)
Set the auto white balance control mode.
peak_status peak_Flash_StartDelay_Get(peak_camera_handle hCam, double *flashStartDelay_us)
Get the flash start delay.
Mono8.
Definition: ids_peak_comfort_c.h:2191
double element_10
Element 10.
Definition: ids_peak_comfort_c.h:679
peak_status peak_Frame_Timestamp_Get(peak_frame_handle hFrame, uint64_t *timestamp_ns)
Query the timestamp of a frame.
peak_status peak_AutoWhiteBalance_Mode_Get(peak_camera_handle hCam, peak_auto_feature_mode *autoWhiteBalanceMode)
Get the auto white balance control mode.
peak_bool peak_EthernetConfig_DHCP_IsEnabled(peak_camera_id cameraID)
Get the enabled status of dhcp.
peak_status peak_IPL_AutoBrightness_TargetTolerance_GetRange(peak_camera_handle hCam, uint32_t *minAutoBrightnessTargetTolerance, uint32_t *maxAutoBrightnessTargetTolerance, uint32_t *incAutoBrightnessTargetTolerance)
Get the current range of valid host auto brightness target tolerance values.
peak_access_status peak_Mirror_LeftRight_GetAccessStatus(peak_camera_handle hCam)
Query the left-right mirroring access status.
uint32_t x
X-Position.
Definition: ids_peak_comfort_c.h:624
peak_status
peak Status codes
Definition: ids_peak_comfort_c.h:720
peak_status peak_Flash_StartDelay_Set(peak_camera_handle hCam, double flashStartDelay_us)
Set the flash start delay.
Analog gain is used.
Definition: ids_peak_comfort_c.h:5204
hotpixel correction sensitivity level 5
Definition: ids_peak_comfort_c.h:9682
peak_status peak_AutoBrightness_TargetPercentile_Get(peak_camera_handle hCam, double *autoBrightnessTargetPercentile)
Get the auto brightness target percentile value.
peak_status peak_Camera_OpenFirstAvailable(peak_camera_handle *hCam)
Open the first available camera.
peak_status peak_VideoWriter_Open(peak_video_handle *hVideo, const char *fileName, peak_video_container container, peak_video_encoder encoder)
Opens a video file with the given file name.
peak_ip_config cameraIP
The current ip address of the camera.
Definition: ids_peak_comfort_c.h:1580
size_t memorySize
The size of allocated buffer memory.
Definition: ids_peak_comfort_c.h:578
uEye USB camera
Definition: ids_peak_comfort_c.h:1034
peak_bool peak_Trigger_IsExecutable(peak_camera_handle hCam)
Check whether the trigger is executable or not.
peak_status peak_CameraSettings_DiskFile_Store(peak_camera_handle hCam, const char *file)
Store the current camera configuration to a disk file.
Invalid color correction.
Definition: ids_peak_comfort_c.h:5489
hotpixel correction sensitivity level 2
Definition: ids_peak_comfort_c.h:9667
Trigger input pin.
Definition: ids_peak_comfort_c.h:3389
The camera IP is not applicable.
Definition: ids_peak_comfort_c.h:1561
The GFA module for the access of the GenICam GenTL Interface module.
Definition: ids_peak_comfort_c.h:7346
peak_status peak_IPL_AutoBrightness_Gain_Mode_Set(peak_camera_handle hCam, peak_auto_feature_mode autoGainMode)
Set the host auto gain control mode.
Invalid hotpixel correction sensitivity level.
Definition: ids_peak_comfort_c.h:9657
Search algorithm Full Scan.
Definition: ids_peak_comfort_c.h:9405
struct peak_video * peak_video_handle
peak Video handle
Definition: ids_peak_comfort_c.h:9964
peak_status peak_ColorCorrection_Matrix_Set(peak_camera_handle hCam, peak_matrix colorCorrectionMatrix)
Sets the color correction matrix for the current selected color correction.
peak_camera_id peak_Camera_ID_FromMAC(peak_mac_address macAddress)
Query the camera id by the mac address.
peak_status peak_Trigger_Burst_Set(peak_camera_handle hCam, uint32_t triggerBurst)
Set the trigger burst.
peak_camera_id peak_Camera_ID_FromSerialNumber(const char *serialNumber)
Query the camera id by the serial number.
peak_status peak_VideoWriter_Container_GetEncoderList(peak_video_container container, peak_video_encoder *encoderList, size_t *encoderCount)
Get the list of currently usable encoders.
Linescan set.
Definition: ids_peak_comfort_c.h:2734
peak_status peak_IPL_AutoBrightness_ROI_Mode_Set(peak_camera_handle hCam, peak_auto_feature_roi_mode autoBrightnessROIMode)
Set the host auto brightness ROI mode.
peak_status peak_Decimation_FactorX_GetList(peak_camera_handle hCam, uint32_t *decimationFactorXList, size_t *decimationFactorXCount)
Get the list of currently selectable factors for the decimation in x direction.
peak_access_status peak_AutoBrightness_Gain_GetAccessStatus(peak_camera_handle hCam)
Query the auto gain control access status.
peak_access_status peak_Trigger_Delay_GetAccessStatus(peak_camera_handle hCam)
Query the trigger delay property access status.
peak_status peak_AutoBrightness_Exposure_Mode_Get(peak_camera_handle hCam, peak_auto_feature_mode *autoExposureMode)
Get the auto exposure control mode.
peak_access_status peak_CameraMemory_Area_GetAccessStatus(peak_camera_handle hCam, peak_camera_memory_area cameraMemoryArea)
Query the camera memory area access status.
The specified camera is not available.
Definition: ids_peak_comfort_c.h:758
double element_22
Element 22.
Definition: ids_peak_comfort_c.h:694
peak_status peak_Acquisition_GetInfo(peak_camera_handle hCam, peak_acquisition_info *acquisitionInfo)
Query the acquisition info.
Long exposure set.
Definition: ids_peak_comfort_c.h:2740
The cameras ethernet status is not ok.
Definition: ids_peak_comfort_c.h:1544
No access.
Definition: ids_peak_comfort_c.h:862
Unspecified error.
Definition: ids_peak_comfort_c.h:740
BGRa12.
Definition: ids_peak_comfort_c.h:2233
peak_status peak_IPL_AutoWhiteBalance_ROI_Mode_Set(peak_camera_handle hCam, peak_auto_feature_roi_mode autoWhiteBalanceROIMode)
Set the host auto white balance ROI mode.
peak_status peak_IPL_Gain_Get(peak_camera_handle hCam, peak_gain_channel gainChannel, double *gain)
Get the host gain value for the specified gain channel.
hotpixel correction sensitivity level 3
Definition: ids_peak_comfort_c.h:9673
The peak installation is corrupted.
Definition: ids_peak_comfort_c.h:785
peak_bool peak_IOChannel_NoiseFilter_IsEnabled(peak_camera_handle hCam, peak_io_channel ioChannel)
Get the enabled status of the io channel noise filter property.
Invalid encoder.
Definition: ids_peak_comfort_c.h:9978
peak_status peak_Acquisition_WaitForFrame(peak_camera_handle hCam, uint32_t timeout_ms, peak_frame_handle *hFrame)
Wait for an acquired frame.
peak_access_status peak_Flash_Duration_GetAccessStatus(peak_camera_handle hCam)
Query the flash duration property access status.
peak_status peak_IPL_ColorCorrection_Matrix_Get(peak_camera_handle hCam, peak_matrix *colorCorrectionMatrix)
Get the host color correction matrix.
peak_status peak_IPL_AutoBrightness_TargetPercentile_Set(peak_camera_handle hCam, double autoBrightnessTargetPercentile)
Set the host auto brightness target percentile value.
uint32_t numBitsPerChannel
Bits per channel.
Definition: ids_peak_comfort_c.h:2364
peak_status peak_ColorCorrection_Mode_GetList(peak_camera_handle hCam, peak_color_correction_mode *colorCorrectionModeList, size_t *colorCorrectionModeCount)
Get the list of currently selectable color correction modes.
The GFA module for the access of the GenICam GenTL Local Device module.
Definition: ids_peak_comfort_c.h:7349
uint32_t numSignificantBitsPerPixel
Significant bits per pixel.
Definition: ids_peak_comfort_c.h:2352
The GFA module for the access of the GenICam Remote Device module.
Definition: ids_peak_comfort_c.h:7352
hotpixel correction sensitivity level 1
Definition: ids_peak_comfort_c.h:9664
peak_status peak_Flash_StartDelay_GetRange(peak_camera_handle hCam, double *minFlashStartDelay_us, double *maxFlashStartDelay_us, double *incFlashStartDelay_us)
Get the current range of valid flash start delay values.
peak_status peak_VideoWriter_Close(peak_video_handle hVideo)
Closes a video file.
peak_bool peak_Mirror_LeftRight_IsEnabled(peak_camera_handle hCam)
Get the enabled status of the left-right mirroring.
peak_status peak_GFA_Data_Write(peak_camera_handle hCam, peak_gfa_module module, uint64_t address, const uint8_t *data, size_t dataSize)
Write data to the specified register address.
peak_bool peak_Flash_IsEnabled(peak_camera_handle hCam)
Get the enabled status of the flash.
Sharpness algorithm Sobel.
Definition: ids_peak_comfort_c.h:9481
peak_bool isComplete
&#39;Complete&#39; flag
Definition: ids_peak_comfort_c.h:2486
peak_status peak_GFA_Integer_Set(peak_camera_handle hCam, peak_gfa_module module, const char *integerFeatureName, int64_t integerValue)
Set the integer feature with the given name.
peak_access_status peak_AutoWhiteBalance_GetAccessStatus(peak_camera_handle hCam)
Query the auto white balance access status.
The cameras ethernet status is ok.
Definition: ids_peak_comfort_c.h:1538
Focus ROI weight medium.
Definition: ids_peak_comfort_c.h:9234
peak_status peak_IOChannel_NoiseFilter_Duration_Set(peak_camera_handle hCam, peak_io_channel ioChannel, double noiseFilterDuration_us)
Set the io channel noise filter duration.
peak_status peak_Trigger_Divider_Set(peak_camera_handle hCam, uint32_t triggerDivider)
Set the trigger divider.
BayerGB12 packed.
Definition: ids_peak_comfort_c.h:2251
peak_status peak_IPL_HotpixelCorrection_Sensitivity_Get(peak_camera_handle hCam, peak_hotpixel_correction_sensitivity *hotpixelCorrectionSensitivity)
Get the host hotpixel correction sensitivity level.
Combined gain is used.
Definition: ids_peak_comfort_c.h:5210
peak_status peak_AutoBrightness_Target_GetRange(peak_camera_handle hCam, uint32_t *minAutoBrightnessTarget, uint32_t *maxAutoBrightnessTarget, uint32_t *incAutoBrightnessTarget)
Get the current range of valid auto brightness target values.
peak_status peak_CameraMemory_Area_GetList(peak_camera_handle hCam, peak_camera_memory_area *cameraMemoryAreaList, size_t *cameraMemoryAreaCount)
Get the list of currently usable camera memory areas.
peak_bool cameraDHCPEnabled
The current DHCP enabled status of the camera.
Definition: ids_peak_comfort_c.h:1583
peak_status peak_Trigger_Enable(peak_camera_handle hCam, peak_bool enabled)
Enable/Disable the trigger.
Cameras User Data 1 memory.
Definition: ids_peak_comfort_c.h:7074
Invalid trigger target.
Definition: ids_peak_comfort_c.h:3739
Invalid memory area.
Definition: ids_peak_comfort_c.h:7068
peak_access_status peak_EthernetConfig_PersistentIP_GetAccessStatus(peak_camera_id cameraID)
Query the persistent ip access status.
The buffer is too small to take the complete data.
Definition: ids_peak_comfort_c.h:770
BayerGB8.
Definition: ids_peak_comfort_c.h:2173
peak_status peak_IOChannel_GetList(peak_camera_handle hCam, peak_io_channel *ioChannelList, size_t *ioChannelCount)
Get the list of supported io channels.
peak_status peak_Gamma_Set(peak_camera_handle hCam, double gamma)
Set the gamma value.
peak_roi roi
The ROI of the frame.
Definition: ids_peak_comfort_c.h:2477
peak_status peak_GFA_Enumeration_Get(peak_camera_handle hCam, peak_gfa_module module, const char *enumerationFeatureName, peak_gfa_enumeration_entry *enumerationEntry)
Get the enumeration feature with the given name.
Auto feature ROI mode Full Image.
Definition: ids_peak_comfort_c.h:5796
double fps
Measured framerate.
Definition: ids_peak_comfort_c.h:1875
peak_status peak_IPL_AutoBrightness_TargetTolerance_Set(peak_camera_handle hCam, uint32_t autoBrightnessTargetTolerance)
Set the host auto brightness target tolerance value.
peak_status peak_CameraSettings_ParameterSet_Startup_Set(peak_camera_handle hCam, peak_parameter_set parameterSet)
Set the startup parameter set.
peak_status peak_IPL_ColorCorrection_Saturation_Set(peak_camera_handle hCam, double saturation)
Sets the saturation value.
peak_gain_type
peak Gain type
Definition: ids_peak_comfort_c.h:5195
uint32_t numBitsPerPixel
Bits per pixel.
Definition: ids_peak_comfort_c.h:2346
peak_status peak_VideoWriter_AddFrame(peak_video_handle hVideo, peak_frame_handle hFrame)
Writes a image frame into the video file.
peak_status peak_IPL_Gamma_Get(peak_camera_handle hCam, double *gamma)
Get the host gamma value.
peak_access_status peak_CameraSettings_DiskFile_GetAccessStatus(peak_camera_handle hCam)
Query the disk file settings access status.
peak_access_status peak_Trigger_GetAccessStatus(peak_camera_handle hCam)
Query the trigger feature access status.
peak_gfa_module
peak GFA modules
Definition: ids_peak_comfort_c.h:7334
peak_status peak_ExposureTime_GetRange(peak_camera_handle hCam, double *minExposureTime_us, double *maxExposureTime_us, double *incExposureTime_us)
Get the current range of valid exposure time values.
peak_status peak_AutoWhiteBalance_ROI_Size_GetRange(peak_camera_handle hCam, peak_size *minAutoWhiteBalanceROISize, peak_size *maxAutoWhiteBalanceROISize, peak_size *incAutoWhiteBalanceROISize)
Get the current range of valid auto white balance ROI sizes.
Sharpness algorithm Tenengrad.
Definition: ids_peak_comfort_c.h:9475
Invalid gain channel.
Definition: ids_peak_comfort_c.h:5226
The function is not implemented.
Definition: ids_peak_comfort_c.h:749
The GFA module for the access of the GenICam GenTL Data Stream module.
Definition: ids_peak_comfort_c.h:7355
peak_status peak_IPL_ProcessFrameInplace(peak_camera_handle hCam, peak_frame_handle hFrame)
Process a frame with the host image processing pipeline and replace the original frame.
Green channel.
Definition: ids_peak_comfort_c.h:5232
Invalid container option.
Definition: ids_peak_comfort_c.h:10205
BGRa8.
Definition: ids_peak_comfort_c.h:2227
peak_status peak_GFA_Enumeration_SetByIntegerValue(peak_camera_handle hCam, peak_gfa_module module, const char *enumerationFeatureName, int64_t enumerationEntryIntegerValue)
Set the enumeration feature with the given name by the entries integer value.
peak_status peak_Camera_UserDefinedName_Get(peak_camera_handle hCam, char *userDefinedName, size_t *userDefinedNameSize)
Get the user defined name.
peak_status peak_GFA_Command_WaitForDone(peak_camera_handle hCam, peak_gfa_module module, const char *commandFeatureName, uint32_t timeout_ms)
Wait for the execution of the command feature with the given name to be done.
uint32_t low_part
Lower 4 bytes of the MAC address.
Definition: ids_peak_comfort_c.h:1273
peak_access_status peak_GFA_EnumerationEntry_GetAccessStatusByIntegerValue(peak_camera_handle hCam, peak_gfa_module module, const char *enumerationFeatureName, int64_t enumerationEntryIntegerValue)
Query the access status of the enumeration entry by its integer value.