IDS peak genericC++ v1.17.0
Loading...
Searching...
No Matches
peak_backend.h
Go to the documentation of this file.
1
7
8#pragma once
9
10
13
14#if __cplusplus >= 201703L || (defined(_MSVC_LANG) && (_MSVC_LANG >= 201703L))
15# define PEAK_NO_DISCARD [[nodiscard]]
16# define PEAK_MAYBE_UNUSED [[maybe_unused]]
17#else
18# ifdef _MSC_VER
19# define PEAK_NO_DISCARD _Check_return_
20# define PEAK_MAYBE_UNUSED
21# elif defined(__clang__) || defined(__GNUC__) || defined(__GNUG__)
22# define PEAK_NO_DISCARD __attribute__((warn_unused_result))
23# define PEAK_MAYBE_UNUSED __attribute__((unused))
24# else
25# define PEAK_NO_DISCARD
26# define PEAK_MAYBE_UNUSED
27# endif
28#endif
29
30
31#ifdef __cplusplus
32# include <cstddef>
33# include <cstdint>
34
35extern "C" {
36#else
37# include <stddef.h>
38# include <stdint.h>
39#endif
40
41typedef int8_t PEAK_BOOL8;
42
51
61
78typedef int32_t PEAK_BUFFER_PART_TYPE;
79
98
106
119
133
144
162
170typedef int32_t PEAK_ENDIANNESS;
171
183typedef int32_t PEAK_EVENT_TYPE;
184
192
205
213
224
233
241
250
259
266typedef int32_t PEAK_NODE_NAMESPACE;
267
280
294typedef int32_t PEAK_NODE_TYPE;
295
304typedef int32_t PEAK_NODE_VISIBILITY;
305
317
327typedef int32_t PEAK_PORT_URL_SCHEME;
328
353typedef int32_t PEAK_RETURN_CODE;
354
356static const uint64_t PEAK_INFINITE_NUMBER = 0xFFFFFFFFFFFFFFFFULL;
357
359static const uint64_t PEAK_INFINITE_TIMEOUT = 0xFFFFFFFFFFFFFFFFULL;
360
361struct PEAK_PRODUCER_LIBRARY;
363typedef struct PEAK_PRODUCER_LIBRARY* PEAK_PRODUCER_LIBRARY_HANDLE;
364
365struct PEAK_SYSTEM_DESCRIPTOR;
367typedef struct PEAK_SYSTEM_DESCRIPTOR* PEAK_SYSTEM_DESCRIPTOR_HANDLE;
368
369struct PEAK_SYSTEM;
371typedef struct PEAK_SYSTEM* PEAK_SYSTEM_HANDLE;
372
373struct PEAK_INTERFACE_DESCRIPTOR;
375typedef struct PEAK_INTERFACE_DESCRIPTOR* PEAK_INTERFACE_DESCRIPTOR_HANDLE;
376
377struct PEAK_INTERFACE;
379typedef struct PEAK_INTERFACE* PEAK_INTERFACE_HANDLE;
380
381struct PEAK_DEVICE_DESCRIPTOR;
383typedef struct PEAK_DEVICE_DESCRIPTOR* PEAK_DEVICE_DESCRIPTOR_HANDLE;
384
385struct PEAK_DEVICE;
387typedef struct PEAK_DEVICE* PEAK_DEVICE_HANDLE;
388
389struct PEAK_REMOTE_DEVICE;
391typedef struct PEAK_REMOTE_DEVICE* PEAK_REMOTE_DEVICE_HANDLE;
392
393struct PEAK_DATA_STREAM_DESCRIPTOR;
395typedef struct PEAK_DATA_STREAM_DESCRIPTOR* PEAK_DATA_STREAM_DESCRIPTOR_HANDLE;
396
397struct PEAK_DATA_STREAM;
399typedef struct PEAK_DATA_STREAM* PEAK_DATA_STREAM_HANDLE;
400
401struct PEAK_BUFFER;
403typedef struct PEAK_BUFFER* PEAK_BUFFER_HANDLE;
404
405struct PEAK_BUFFER_CHUNK;
407typedef struct PEAK_BUFFER_CHUNK* PEAK_BUFFER_CHUNK_HANDLE;
408
409struct PEAK_BUFFER_PART;
411typedef struct PEAK_BUFFER_PART* PEAK_BUFFER_PART_HANDLE;
412
413struct PEAK_MODULE_DESCRIPTOR;
415typedef struct PEAK_MODULE_DESCRIPTOR* PEAK_MODULE_DESCRIPTOR_HANDLE;
416
417struct PEAK_MODULE;
419typedef struct PEAK_MODULE* PEAK_MODULE_HANDLE;
420
421struct PEAK_NODE_MAP;
423typedef struct PEAK_NODE_MAP* PEAK_NODE_MAP_HANDLE;
424
425struct PEAK_NODE;
427typedef struct PEAK_NODE* PEAK_NODE_HANDLE;
428
429struct PEAK_INTEGER_NODE;
431typedef struct PEAK_INTEGER_NODE* PEAK_INTEGER_NODE_HANDLE;
432
433struct PEAK_BOOLEAN_NODE;
435typedef struct PEAK_BOOLEAN_NODE* PEAK_BOOLEAN_NODE_HANDLE;
436
437struct PEAK_COMMAND_NODE;
439typedef struct PEAK_COMMAND_NODE* PEAK_COMMAND_NODE_HANDLE;
440
441struct PEAK_FLOAT_NODE;
443typedef struct PEAK_FLOAT_NODE* PEAK_FLOAT_NODE_HANDLE;
444
445struct PEAK_STRING_NODE;
447typedef struct PEAK_STRING_NODE* PEAK_STRING_NODE_HANDLE;
448
449struct PEAK_REGISTER_NODE;
451typedef struct PEAK_REGISTER_NODE* PEAK_REGISTER_NODE_HANDLE;
452
453struct PEAK_CATEGORY_NODE;
455typedef struct PEAK_CATEGORY_NODE* PEAK_CATEGORY_NODE_HANDLE;
456
457struct PEAK_ENUMERATION_NODE;
459typedef struct PEAK_ENUMERATION_NODE* PEAK_ENUMERATION_NODE_HANDLE;
460
461struct PEAK_ENUMERATION_ENTRY_NODE;
463typedef struct PEAK_ENUMERATION_ENTRY_NODE* PEAK_ENUMERATION_ENTRY_NODE_HANDLE;
464
465struct PEAK_PORT;
467typedef struct PEAK_PORT* PEAK_PORT_HANDLE;
468
469struct PEAK_PORT_URL;
471typedef struct PEAK_PORT_URL* PEAK_PORT_URL_HANDLE;
472
473struct PEAK_EVENT_SUPPORTING_MODULE;
475typedef struct PEAK_EVENT_SUPPORTING_MODULE* PEAK_EVENT_SUPPORTING_MODULE_HANDLE;
476
477struct PEAK_EVENT_CONTROLLER;
479typedef struct PEAK_EVENT_CONTROLLER* PEAK_EVENT_CONTROLLER_HANDLE;
480
481struct PEAK_EVENT;
483typedef struct PEAK_EVENT* PEAK_EVENT_HANDLE;
484
485struct PEAK_FILE_ADAPTER;
487typedef struct PEAK_FILE_ADAPTER* PEAK_FILE_ADAPTER_HANDLE;
488
489struct PEAK_FIRMWARE_UPDATER;
491typedef struct PEAK_FIRMWARE_UPDATER* PEAK_FIRMWARE_UPDATER_HANDLE;
492
493struct PEAK_FIRMWARE_UPDATE_INFORMATION;
495typedef struct PEAK_FIRMWARE_UPDATE_INFORMATION* PEAK_FIRMWARE_UPDATE_INFORMATION_HANDLE;
496
497struct PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER;
499typedef struct PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER* PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER_HANDLE;
500
501
503typedef void(PEAK_CALL_CONV* PEAK_INTERFACE_FOUND_CALLBACK)(
504 PEAK_INTERFACE_DESCRIPTOR_HANDLE foundInterface, void* context);
506typedef void(PEAK_CALL_CONV* PEAK_INTERFACE_LOST_CALLBACK)(
507 const char* lostInterfaceId, size_t lostInterfaceIdSize, void* context);
509typedef void(PEAK_CALL_CONV* PEAK_INTERFACE_LIST_CHANGED_CALLBACK)(void* context);
516
531
548
550typedef void(PEAK_CALL_CONV* PEAK_DEVICE_FOUND_CALLBACK)(
551 PEAK_DEVICE_DESCRIPTOR_HANDLE foundDevice, void* context);
553typedef void(PEAK_CALL_CONV* PEAK_DEVICE_RECONNECTED_CALLBACK)(PEAK_DEVICE_DESCRIPTOR_HANDLE reconnectedDevice,
554 PEAK_DEVICE_RECONNECT_INFORMATION reconnectInformation, void* context);
556typedef void(PEAK_CALL_CONV* PEAK_DEVICE_LOST_CALLBACK)(
557 const char* lostDeviceId, size_t lostDeviceIdSize, void* context);
559typedef void(PEAK_CALL_CONV* PEAK_DEVICE_DISCONNETED_CALLBACK)(
560 PEAK_DEVICE_DESCRIPTOR_HANDLE disconnectedDevice, void* context);
562typedef void(PEAK_CALL_CONV* PEAK_DEVICE_LIST_CHANGED_CALLBACK)(void* context);
573
575typedef void(PEAK_CALL_CONV* PEAK_BUFFER_REVOCATION_CALLBACK)(void* buffer, void* userPtr, void* context);
576
578typedef void(PEAK_CALL_CONV* PEAK_NODE_CHANGED_CALLBACK)(PEAK_NODE_HANDLE changedNode, void* context);
581
584 const PEAK_DEVICE_INFORMATION_ROLE* changedRoles, size_t changedRolesSize, void* context);
588
590typedef void(PEAK_CALL_CONV* PEAK_FIRMWARE_UPDATE_STARTED_CALLBACK)(
591 PEAK_FIRMWARE_UPDATE_INFORMATION_HANDLE firmwareUpdateInformationHandle, uint32_t estimatedDuration_ms,
592 void* context);
597 uint32_t estimatedDuration_ms, const char* description, size_t descriptionSize, void* context);
602 PEAK_FIRMWARE_UPDATE_STEP updateStep, double progressPercentage, void* context);
608 PEAK_FIRMWARE_UPDATE_STEP updateStep, void* context);
612typedef void(PEAK_CALL_CONV* PEAK_FIRMWARE_UPDATE_FINISHED_CALLBACK)(void* context);
616typedef void(PEAK_CALL_CONV* PEAK_FIRMWARE_UPDATE_FAILED_CALLBACK)(
617 const char* errorDescription, size_t errorDescriptionSize, void* context);
620
621
622#define PEAK_C_API PEAK_PUBLIC PEAK_RETURN_CODE PEAK_CALL_CONV
623
624#ifndef PEAK_DYNAMIC_LOADING
672PEAK_C_API PEAK_Library_GetVersionMajor(uint32_t* libraryVersionMajor);
683PEAK_C_API PEAK_Library_GetVersionMinor(uint32_t* libraryVersionMinor);
684
688PEAK_COMMON_DEPRECATED_MSG("Deprecated due to SemVer 2.0 migration. Use PEAK_Library_GetVersionPatch() instead.")
689PEAK_C_API PEAK_Library_GetVersionSubminor(uint32_t* libraryVersionSubminor);
690
701PEAK_C_API PEAK_Library_GetVersionPatch(uint32_t* libraryVersionPatch);
735 PEAK_RETURN_CODE* lastErrorCode, char* lastErrorDescription, size_t* lastErrorDescriptionSize);
736
778PEAK_C_API PEAK_EnvironmentInspector_GetCTIPath(size_t index, char* ctiPath, size_t* ctiPathSize);
779
795 const char* ctiPath, size_t ctiPathSize, PEAK_PRODUCER_LIBRARY_HANDLE* producerLibraryHandle);
812 PEAK_PRODUCER_LIBRARY_HANDLE producerLibraryHandle, char* key, size_t* keySize);
827 PEAK_PRODUCER_LIBRARY_HANDLE producerLibraryHandle, PEAK_SYSTEM_DESCRIPTOR_HANDLE* systemDescriptorHandle);
840
855 PEAK_SYSTEM_DESCRIPTOR_HANDLE systemDescriptorHandle, PEAK_MODULE_DESCRIPTOR_HANDLE* moduleDescriptorHandle);
872 PEAK_SYSTEM_DESCRIPTOR_HANDLE systemDescriptorHandle, char* key, size_t* keySize);
891 int32_t infoCommand, int32_t* infoDataType, uint8_t* info, size_t* infoSize);
908 PEAK_SYSTEM_DESCRIPTOR_HANDLE systemDescriptorHandle, char* displayName, size_t* displayNameSize);
925 PEAK_SYSTEM_DESCRIPTOR_HANDLE systemDescriptorHandle, char* vendorName, size_t* vendorNameSize);
942 PEAK_SYSTEM_DESCRIPTOR_HANDLE systemDescriptorHandle, char* modelName, size_t* modelNameSize);
959 PEAK_SYSTEM_DESCRIPTOR_HANDLE systemDescriptorHandle, char* version, size_t* versionSize);
976 PEAK_SYSTEM_DESCRIPTOR_HANDLE systemDescriptorHandle, char* tlType, size_t* tlTypeSize);
993 PEAK_SYSTEM_DESCRIPTOR_HANDLE systemDescriptorHandle, char* ctiFileName, size_t* ctiFileNameSize);
1010 PEAK_SYSTEM_DESCRIPTOR_HANDLE systemDescriptorHandle, char* ctiFullPath, size_t* ctiFullPathSize);
1025 PEAK_SYSTEM_DESCRIPTOR_HANDLE systemDescriptorHandle, uint32_t* gentlVersionMajor);
1040 PEAK_SYSTEM_DESCRIPTOR_HANDLE systemDescriptorHandle, uint32_t* gentlVersionMinor);
1055 PEAK_SYSTEM_DESCRIPTOR_HANDLE systemDescriptorHandle, PEAK_CHARACTER_ENCODING* characterEncoding);
1070 PEAK_SYSTEM_DESCRIPTOR_HANDLE systemDescriptorHandle, PEAK_PRODUCER_LIBRARY_HANDLE* producerLibraryHandle);
1085 PEAK_SYSTEM_DESCRIPTOR_HANDLE systemDescriptorHandle, PEAK_SYSTEM_HANDLE* systemHandle);
1086
1115 PEAK_SYSTEM_HANDLE systemHandle, PEAK_EVENT_SUPPORTING_MODULE_HANDLE* eventSupportingModuleHandle);
1131PEAK_C_API PEAK_System_GetKey(PEAK_SYSTEM_HANDLE systemHandle, char* key, size_t* keySize);
1150 PEAK_SYSTEM_HANDLE systemHandle, int32_t infoCommand, int32_t* infoDataType, uint8_t* info, size_t* infoSize);
1166PEAK_C_API PEAK_System_GetID(PEAK_SYSTEM_HANDLE systemHandle, char* id, size_t* idSize);
1183 PEAK_SYSTEM_HANDLE systemHandle, char* displayName, size_t* displayNameSize);
1200 PEAK_SYSTEM_HANDLE systemHandle, char* vendorName, size_t* vendorNameSize);
1216PEAK_C_API PEAK_System_GetModelName(PEAK_SYSTEM_HANDLE systemHandle, char* modelName, size_t* modelNameSize);
1232PEAK_C_API PEAK_System_GetVersion(PEAK_SYSTEM_HANDLE systemHandle, char* version, size_t* versionSize);
1248PEAK_C_API PEAK_System_GetTLType(PEAK_SYSTEM_HANDLE systemHandle, char* tlType, size_t* tlTypeSize);
1265 PEAK_SYSTEM_HANDLE systemHandle, char* ctiFileName, size_t* ctiFileNameSize);
1282 PEAK_SYSTEM_HANDLE systemHandle, char* ctiFullPath, size_t* ctiFullPathSize);
1296PEAK_C_API PEAK_System_GetGenTLVersionMajor(PEAK_SYSTEM_HANDLE systemHandle, uint32_t* gentlVersionMajor);
1310PEAK_C_API PEAK_System_GetGenTLVersionMinor(PEAK_SYSTEM_HANDLE systemHandle, uint32_t* gentlVersionMinor);
1325 PEAK_SYSTEM_HANDLE systemHandle, PEAK_CHARACTER_ENCODING* characterEncoding);
1340 PEAK_SYSTEM_HANDLE systemHandle, PEAK_PRODUCER_LIBRARY_HANDLE* producerLibraryHandle);
1384 PEAK_SYSTEM_HANDLE systemHandle, size_t index, PEAK_INTERFACE_DESCRIPTOR_HANDLE* interfaceDescriptorHandle);
1401 PEAK_INTERFACE_FOUND_CALLBACK callback, void* callbackContext,
1402 PEAK_INTERFACE_FOUND_CALLBACK_HANDLE* callbackHandle);
1416 PEAK_SYSTEM_HANDLE systemHandle, PEAK_INTERFACE_FOUND_CALLBACK_HANDLE callbackHandle);
1433 PEAK_INTERFACE_LOST_CALLBACK callback, void* callbackContext,
1434 PEAK_INTERFACE_LOST_CALLBACK_HANDLE* callbackHandle);
1448 PEAK_SYSTEM_HANDLE systemHandle, PEAK_INTERFACE_LOST_CALLBACK_HANDLE callbackHandle);
1461
1476 PEAK_INTERFACE_DESCRIPTOR_HANDLE interfaceDescriptorHandle,
1477 PEAK_MODULE_DESCRIPTOR_HANDLE* moduleDescriptorHandle);
1494 PEAK_INTERFACE_DESCRIPTOR_HANDLE interfaceDescriptorHandle, char* key, size_t* keySize);
1513 int32_t infoCommand, int32_t* infoDataType, uint8_t* info, size_t* infoSize);
1530 PEAK_INTERFACE_DESCRIPTOR_HANDLE interfaceDescriptorHandle, char* displayName, size_t* displayNameSize);
1547 PEAK_INTERFACE_DESCRIPTOR_HANDLE interfaceDescriptorHandle, char* tlType, size_t* tlTypeSize);
1562 PEAK_INTERFACE_DESCRIPTOR_HANDLE interfaceDescriptorHandle, PEAK_SYSTEM_HANDLE* systemHandle);
1577 PEAK_INTERFACE_DESCRIPTOR_HANDLE interfaceDescriptorHandle, PEAK_INTERFACE_HANDLE* interfaceHandle);
1578
1607 PEAK_INTERFACE_HANDLE interfaceHandle, PEAK_EVENT_SUPPORTING_MODULE_HANDLE* eventSupportingModuleHandle);
1623PEAK_C_API PEAK_Interface_GetKey(PEAK_INTERFACE_HANDLE interfaceHandle, char* key, size_t* keySize);
1641PEAK_C_API PEAK_Interface_GetInfo(PEAK_INTERFACE_HANDLE interfaceHandle, int32_t infoCommand,
1642 int32_t* infoDataType, uint8_t* info, size_t* infoSize);
1658PEAK_C_API PEAK_Interface_GetID(PEAK_INTERFACE_HANDLE interfaceHandle, char* id, size_t* idSize);
1675 PEAK_INTERFACE_HANDLE interfaceHandle, char* displayName, size_t* displayNameSize);
1691PEAK_C_API PEAK_Interface_GetTLType(PEAK_INTERFACE_HANDLE interfaceHandle, char* tlType, size_t* tlTypeSize);
1706 PEAK_INTERFACE_HANDLE interfaceHandle, PEAK_SYSTEM_HANDLE* systemHandle);
1750 PEAK_INTERFACE_HANDLE interfaceHandle, size_t index, PEAK_DEVICE_DESCRIPTOR_HANDLE* deviceDescriptorHandle);
1767 PEAK_DEVICE_FOUND_CALLBACK callback, void* callbackContext,
1768 PEAK_DEVICE_FOUND_CALLBACK_HANDLE* callbackHandle);
1782 PEAK_INTERFACE_HANDLE interfaceHandle, PEAK_DEVICE_FOUND_CALLBACK_HANDLE callbackHandle);
1783
1801 PEAK_DEVICE_RECONNECTED_CALLBACK callback, void* callbackContext,
1816 PEAK_INTERFACE_HANDLE interfaceHandle, PEAK_DEVICE_RECONNECTED_CALLBACK_HANDLE callbackHandle);
1834 PEAK_DEVICE_DISCONNETED_CALLBACK callback, void* callbackContext,
1849 PEAK_INTERFACE_HANDLE interfaceHandle, PEAK_DEVICE_DISCONNECTED_CALLBACK_HANDLE callbackHandle);
1850
1867 PEAK_DEVICE_LOST_CALLBACK callback, void* callbackContext, PEAK_DEVICE_LOST_CALLBACK_HANDLE* callbackHandle);
1881 PEAK_INTERFACE_HANDLE interfaceHandle, PEAK_DEVICE_LOST_CALLBACK_HANDLE callbackHandle);
1882
1899 PEAK_DEVICE_LIST_CHANGED_CALLBACK callback, void* callbackContext,
1914 PEAK_INTERFACE_HANDLE interfaceHandle, PEAK_DEVICE_LIST_CHANGED_CALLBACK_HANDLE callbackHandle);
1915
1928
1943 PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle, PEAK_MODULE_DESCRIPTOR_HANDLE* moduleDescriptorHandle);
1960 PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle, char* key, size_t* keySize);
1979 int32_t infoCommand, int32_t* infoDataType, uint8_t* info, size_t* infoSize);
1996 PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle, char* displayName, size_t* displayNameSize);
2013 PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle, char* vendorName, size_t* vendorNameSize);
2030 PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle, char* modelName, size_t* modelNameSize);
2047 PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle, char* version, size_t* versionSize);
2064 PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle, char* tlType, size_t* tlTypeSize);
2081 PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle, char* userDefinedName, size_t* userDefinedNameSize);
2098 PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle, char* serialNumber, size_t* serialNumberSize);
2113 PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle, PEAK_DEVICE_ACCESS_STATUS* accessStatus);
2128 PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle, uint64_t* timestampTickFrequency);
2143 PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle, PEAK_BOOL8* isOpenable);
2161 PEAK_DEVICE_ACCESS_TYPE accessType, PEAK_BOOL8* isOpenable);
2177 PEAK_DEVICE_ACCESS_TYPE accessType, PEAK_DEVICE_HANDLE* deviceHandle);
2192 PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle, PEAK_INTERFACE_HANDLE* interfaceHandle);
2207 PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle, uint64_t* monitoringUpdateInterval_ms);
2221 PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle, uint64_t monitoringUpdateInterval_ms);
2237 PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle, PEAK_DEVICE_INFORMATION_ROLE informationRole,
2238 PEAK_BOOL8* isInformationRoleMonitored);
2252 PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle, PEAK_DEVICE_INFORMATION_ROLE informationRole);
2266 PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle, PEAK_DEVICE_INFORMATION_ROLE informationRole);
2283 PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle,
2284 PEAK_DEVICE_DESCRIPTOR_INFORMATION_CHANGED_CALLBACK callback, void* callbackContext,
2299 PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle,
2301
2330 PEAK_DEVICE_HANDLE deviceHandle, PEAK_EVENT_SUPPORTING_MODULE_HANDLE* eventSupportingModuleHandle);
2346PEAK_C_API PEAK_Device_GetKey(PEAK_DEVICE_HANDLE deviceHandle, char* key, size_t* keySize);
2365 PEAK_DEVICE_HANDLE deviceHandle, int32_t infoCommand, int32_t* infoDataType, uint8_t* info, size_t* infoSize);
2381PEAK_C_API PEAK_Device_GetID(PEAK_DEVICE_HANDLE deviceHandle, char* id, size_t* idSize);
2398 PEAK_DEVICE_HANDLE deviceHandle, char* displayName, size_t* displayNameSize);
2415 PEAK_DEVICE_HANDLE deviceHandle, char* vendorName, size_t* vendorNameSize);
2431PEAK_C_API PEAK_Device_GetModelName(PEAK_DEVICE_HANDLE deviceHandle, char* modelName, size_t* modelNameSize);
2447PEAK_C_API PEAK_Device_GetVersion(PEAK_DEVICE_HANDLE deviceHandle, char* version, size_t* versionSize);
2463PEAK_C_API PEAK_Device_GetTLType(PEAK_DEVICE_HANDLE deviceHandle, char* tlType, size_t* tlTypeSize);
2480 PEAK_DEVICE_HANDLE deviceHandle, char* userDefinedName, size_t* userDefinedNameSize);
2497 PEAK_DEVICE_HANDLE deviceHandle, char* serialNumber, size_t* serialNumberSize);
2512 PEAK_DEVICE_HANDLE deviceHandle, PEAK_DEVICE_ACCESS_STATUS* accessStatus);
2527 PEAK_DEVICE_HANDLE deviceHandle, uint64_t* timestampTickFrequency);
2542 PEAK_DEVICE_HANDLE deviceHandle, PEAK_INTERFACE_HANDLE* interfaceHandle);
2557 PEAK_DEVICE_HANDLE deviceHandle, PEAK_REMOTE_DEVICE_HANDLE* remoteDeviceHandle);
2588 PEAK_DATA_STREAM_DESCRIPTOR_HANDLE* dataStreamDescriptorHandle);
2601
2616 PEAK_REMOTE_DEVICE_HANDLE remoteDeviceHandle, PEAK_MODULE_HANDLE* moduleHandle);
2631 PEAK_REMOTE_DEVICE_HANDLE remoteDeviceHandle, PEAK_DEVICE_HANDLE* deviceHandle);
2632
2647 PEAK_DATA_STREAM_DESCRIPTOR_HANDLE dataStreamDescriptorHandle,
2648 PEAK_MODULE_DESCRIPTOR_HANDLE* moduleDescriptorHandle);
2665 PEAK_DATA_STREAM_DESCRIPTOR_HANDLE dataStreamDescriptorHandle, char* key, size_t* keySize);
2680 PEAK_DATA_STREAM_DESCRIPTOR_HANDLE dataStreamDescriptorHandle, PEAK_DEVICE_HANDLE* deviceHandle);
2695 PEAK_DATA_STREAM_DESCRIPTOR_HANDLE dataStreamDescriptorHandle, PEAK_DATA_STREAM_HANDLE* dataStreamHandle);
2696
2711 PEAK_DATA_STREAM_HANDLE dataStreamHandle, PEAK_MODULE_HANDLE* moduleHandle);
2726 PEAK_DATA_STREAM_HANDLE dataStreamHandle, PEAK_EVENT_SUPPORTING_MODULE_HANDLE* eventSupportingModuleHandle);
2742PEAK_C_API PEAK_DataStream_GetKey(PEAK_DATA_STREAM_HANDLE dataStreamHandle, char* key, size_t* keySize);
2760PEAK_C_API PEAK_DataStream_GetInfo(PEAK_DATA_STREAM_HANDLE dataStreamHandle, int32_t infoCommand,
2761 int32_t* infoDataType, uint8_t* info, size_t* infoSize);
2777PEAK_C_API PEAK_DataStream_GetID(PEAK_DATA_STREAM_HANDLE dataStreamHandle, char* id, size_t* idSize);
2794 PEAK_DATA_STREAM_HANDLE dataStreamHandle, char* tlType, size_t* tlTypeSize);
2809 PEAK_DATA_STREAM_HANDLE dataStreamHandle, size_t* numBuffersAnnouncedMinRequired);
2824 PEAK_DATA_STREAM_HANDLE dataStreamHandle, size_t* numBuffersAnnounced);
2839 PEAK_DATA_STREAM_HANDLE dataStreamHandle, size_t* numBuffersQueued);
2854 PEAK_DATA_STREAM_HANDLE dataStreamHandle, size_t* numBuffersAwaitDelivery);
2869 PEAK_DATA_STREAM_HANDLE dataStreamHandle, uint64_t* numBuffersDelivered);
2884 PEAK_DATA_STREAM_HANDLE dataStreamHandle, uint64_t* numBuffersStarted);
2913 PEAK_DATA_STREAM_HANDLE dataStreamHandle, size_t* numChunksPerBufferMax);
2928 PEAK_DATA_STREAM_HANDLE dataStreamHandle, size_t* bufferAlignment);
2957 PEAK_DATA_STREAM_HANDLE dataStreamHandle, PEAK_BOOL8* definesPayloadSize);
2986 PEAK_DATA_STREAM_HANDLE dataStreamHandle, PEAK_DEVICE_HANDLE* deviceHandle);
3016 size_t bufferSize, void* userPtr, PEAK_BUFFER_REVOCATION_CALLBACK revocationCallback, void* callbackContext,
3017 PEAK_BUFFER_HANDLE* bufferHandle);
3042 PEAK_DATA_STREAM_HANDLE dataStreamHandle, size_t bufferSize, void* userPtr, PEAK_BUFFER_HANDLE* bufferHandle);
3059 PEAK_DATA_STREAM_HANDLE dataStreamHandle, PEAK_BUFFER_HANDLE bufferHandle);
3073 PEAK_DATA_STREAM_HANDLE dataStreamHandle, PEAK_BUFFER_HANDLE bufferHandle);
3108 PEAK_DATA_STREAM_HANDLE dataStreamHandle, uint64_t timeout_ms, PEAK_BUFFER_HANDLE* bufferHandle);
3167 PEAK_DATA_STREAM_HANDLE dataStreamHandle, PEAK_DATA_STREAM_FLUSH_MODE flushMode);
3190 PEAK_DATA_STREAM_HANDLE dataStreamHandle, PEAK_ACQUISITION_START_MODE startMode);
3217 PEAK_DATA_STREAM_HANDLE dataStreamHandle, PEAK_ACQUISITION_START_MODE startMode, uint64_t numToAcquire);
3231 PEAK_DATA_STREAM_HANDLE dataStreamHandle, PEAK_ACQUISITION_STOP_MODE stopMode);
3244
3273 PEAK_BUFFER_HANDLE bufferHandle, PEAK_EVENT_SUPPORTING_MODULE_HANDLE* eventSupportingModuleHandle);
3292 PEAK_BUFFER_HANDLE bufferHandle, int32_t infoCommand, int32_t* infoDataType, uint8_t* info, size_t* infoSize);
3308PEAK_C_API PEAK_Buffer_GetTLType(PEAK_BUFFER_HANDLE bufferHandle, char* tlType, size_t* tlTypeSize);
3365 PEAK_BUFFER_HANDLE bufferHandle, PEAK_BUFFER_PAYLOAD_TYPE* payloadType);
3379PEAK_C_API PEAK_Buffer_GetPixelFormat(PEAK_BUFFER_HANDLE bufferHandle, uint64_t* pixelFormat);
3394 PEAK_BUFFER_HANDLE bufferHandle, PEAK_PIXEL_FORMAT_NAMESPACE* pixelFormatNamespace);
3409 PEAK_BUFFER_HANDLE bufferHandle, PEAK_ENDIANNESS* pixelEndianness);
3423PEAK_C_API PEAK_Buffer_GetExpectedDataSize(PEAK_BUFFER_HANDLE bufferHandle, size_t* expectedDataSize);
3437PEAK_C_API PEAK_Buffer_GetDeliveredDataSize(PEAK_BUFFER_HANDLE bufferHandle, size_t* deliveredDataSize);
3479PEAK_C_API PEAK_Buffer_GetDeliveredImageHeight(PEAK_BUFFER_HANDLE bufferHandle, size_t* deliveredImageHeight);
3494 PEAK_BUFFER_HANDLE bufferHandle, size_t* deliveredChunkPayloadSize);
3508PEAK_C_API PEAK_Buffer_GetChunkLayoutID(PEAK_BUFFER_HANDLE bufferHandle, uint64_t* chunkLayoutId);
3524PEAK_C_API PEAK_Buffer_GetFileName(PEAK_BUFFER_HANDLE bufferHandle, char* fileName, size_t* fileNameSize);
3622PEAK_C_API PEAK_Buffer_GetTimestamp_ticks(PEAK_BUFFER_HANDLE bufferHandle, uint64_t* timestamp_ticks);
3636PEAK_C_API PEAK_Buffer_GetTimestamp_ns(PEAK_BUFFER_HANDLE bufferHandle, uint64_t* timestamp_ns);
3748PEAK_C_API PEAK_Buffer_GetSystemTimestamp_ns(PEAK_BUFFER_HANDLE bufferHandle, uint64_t* systemTimestamp_ns);
3791 PEAK_BUFFER_HANDLE bufferHandle, size_t index, PEAK_BUFFER_CHUNK_HANDLE* bufferChunkHandle);
3834 PEAK_BUFFER_HANDLE bufferHandle, size_t index, PEAK_BUFFER_PART_HANDLE* bufferPartHandle);
3835
3892 PEAK_BUFFER_CHUNK_HANDLE bufferChunkHandle, PEAK_BUFFER_HANDLE* bufferHandle);
3893
3906
3924PEAK_C_API PEAK_BufferPart_GetInfo(PEAK_BUFFER_PART_HANDLE bufferPartHandle, int32_t infoCommand,
3925 int32_t* infoDataType, uint8_t* info, size_t* infoSize);
4010 PEAK_BUFFER_PART_HANDLE bufferPartHandle, uint64_t* formatNamespace);
4095 PEAK_BUFFER_PART_HANDLE bufferPartHandle, size_t* deliveredImageHeight);
4110 PEAK_BUFFER_PART_HANDLE bufferPartHandle, PEAK_BUFFER_HANDLE* bufferHandle);
4111
4124
4141 PEAK_MODULE_DESCRIPTOR_HANDLE moduleDescriptorHandle, char* id, size_t* idSize);
4142
4173 PEAK_MODULE_HANDLE moduleHandle, size_t index, PEAK_NODE_MAP_HANDLE* nodeMapHandle);
4188
4205 PEAK_NODE_MAP_HANDLE nodeMapHandle, const char* nodeName, size_t nodeNameSize, PEAK_BOOL8* hasNode);
4223 PEAK_NODE_MAP_HANDLE nodeMapHandle, const char* nodeName, size_t nodeNameSize, PEAK_NODE_HANDLE* nodeHandle);
4240 PEAK_NODE_MAP_HANDLE nodeMapHandle, const char* nodeName, size_t nodeNameSize, PEAK_NODE_HANDLE* nodeHandle);
4265PEAK_C_API PEAK_NodeMap_PollNodes(PEAK_NODE_MAP_HANDLE nodeMapHandle, int64_t elapsedTime_ms);
4296 PEAK_NODE_MAP_HANDLE nodeMapHandle, size_t index, PEAK_NODE_HANDLE* nodeHandle);
4312 PEAK_NODE_MAP_HANDLE nodeMapHandle, PEAK_BUFFER_HANDLE bufferHandle, PEAK_BOOL8* hasSupportedChunks);
4329 PEAK_NODE_MAP_HANDLE nodeMapHandle, PEAK_BUFFER_HANDLE bufferHandle);
4345 PEAK_NODE_MAP_HANDLE nodeMapHandle, PEAK_EVENT_HANDLE eventHandle, PEAK_BOOL8* hasSupportedData);
4383 PEAK_NODE_MAP_HANDLE nodeMapHandle, const char* filePath, size_t filePathSize);
4404 PEAK_NODE_MAP_HANDLE nodeMapHandle, const char* filePath, size_t filePathSize);
4426
4452
4480 PEAK_NODE_HANDLE nodeHandle, PEAK_INTEGER_NODE_HANDLE* integerNodeHandle);
4496 PEAK_NODE_HANDLE nodeHandle, PEAK_BOOLEAN_NODE_HANDLE* booleanNodeHandle);
4512 PEAK_NODE_HANDLE nodeHandle, PEAK_COMMAND_NODE_HANDLE* commandNodeHandle);
4558 PEAK_NODE_HANDLE nodeHandle, PEAK_REGISTER_NODE_HANDLE* registerNodeHandle);
4574 PEAK_NODE_HANDLE nodeHandle, PEAK_CATEGORY_NODE_HANDLE* categoryNodeHandle);
4590 PEAK_NODE_HANDLE nodeHandle, PEAK_ENUMERATION_NODE_HANDLE* enumerationNodeHandle);
4606 PEAK_NODE_HANDLE nodeHandle, PEAK_ENUMERATION_ENTRY_NODE_HANDLE* enumerationEntryNodeHandle);
4622PEAK_C_API PEAK_Node_GetName(PEAK_NODE_HANDLE nodeHandle, char* name, size_t* nameSize);
4638PEAK_C_API PEAK_Node_GetDisplayName(PEAK_NODE_HANDLE nodeHandle, char* displayName, size_t* displayNameSize);
4710 PEAK_NODE_HANDLE nodeHandle, PEAK_BOOL8* isAccessStatusCacheable);
4781PEAK_C_API PEAK_Node_GetPollingTime(PEAK_NODE_HANDLE nodeHandle, int64_t* pollingTime_ms);
4797PEAK_C_API PEAK_Node_GetToolTip(PEAK_NODE_HANDLE nodeHandle, char* toolTip, size_t* toolTipSize);
4813PEAK_C_API PEAK_Node_GetDescription(PEAK_NODE_HANDLE nodeHandle, char* description, size_t* descriptionSize);
4859 PEAK_NODE_HANDLE nodeHandle, const char* name, size_t nameSize, PEAK_NODE_HANDLE* invalidatedNodeHandle);
4873PEAK_C_API PEAK_Node_GetNumInvalidatedNodes(PEAK_NODE_HANDLE nodeHandle, size_t* numInvalidatedNodes);
4890 PEAK_NODE_HANDLE nodeHandle, size_t index, PEAK_NODE_HANDLE* invalidatedNodeHandle);
4908 PEAK_NODE_HANDLE nodeHandle, const char* name, size_t nameSize, PEAK_NODE_HANDLE* invalidatingNodeHandle);
4922PEAK_C_API PEAK_Node_GetNumInvalidatingNodes(PEAK_NODE_HANDLE nodeHandle, size_t* numInvalidatingNodes);
4939 PEAK_NODE_HANDLE nodeHandle, size_t index, PEAK_NODE_HANDLE* invalidatingNodeHandle);
4957 PEAK_NODE_HANDLE nodeHandle, const char* name, size_t nameSize, PEAK_NODE_HANDLE* selectedNodeHandle);
4971PEAK_C_API PEAK_Node_GetNumSelectedNodes(PEAK_NODE_HANDLE nodeHandle, size_t* numSelectedNodes);
4988 PEAK_NODE_HANDLE nodeHandle, size_t index, PEAK_NODE_HANDLE* selectedNodeHandle);
5006 PEAK_NODE_HANDLE nodeHandle, const char* name, size_t nameSize, PEAK_NODE_HANDLE* selectingNodeHandle);
5020PEAK_C_API PEAK_Node_GetNumSelectingNodes(PEAK_NODE_HANDLE nodeHandle, size_t* numSelectingNodes);
5037 PEAK_NODE_HANDLE nodeHandle, size_t index, PEAK_NODE_HANDLE* selectingNodeHandle);
5054 PEAK_NODE_CHANGED_CALLBACK callback, void* callbackContext,
5055 PEAK_NODE_CHANGED_CALLBACK_HANDLE* callbackHandle);
5069 PEAK_NODE_HANDLE nodeHandle, PEAK_NODE_CHANGED_CALLBACK_HANDLE callbackHandle);
5070
5085 PEAK_INTEGER_NODE_HANDLE integerNodeHandle, PEAK_NODE_HANDLE* nodeHandle);
5145 PEAK_INTEGER_NODE_HANDLE integerNodeHandle, PEAK_NODE_INCREMENT_TYPE* incrementType);
5162 PEAK_INTEGER_NODE_HANDLE integerNodeHandle, int64_t* validValues, size_t* validValuesSize);
5177 PEAK_INTEGER_NODE_HANDLE integerNodeHandle, PEAK_NODE_REPRESENTATION* representation);
5192PEAK_C_API PEAK_IntegerNode_GetUnit(PEAK_INTEGER_NODE_HANDLE integerNodeHandle, char* unit, size_t* unitSize);
5209 PEAK_INTEGER_NODE_HANDLE integerNodeHandle, PEAK_NODE_CACHE_USE_POLICY cacheUsePolicy, int64_t* value);
5224
5239 PEAK_BOOLEAN_NODE_HANDLE booleanNodeHandle, PEAK_NODE_HANDLE* nodeHandle);
5256 PEAK_BOOLEAN_NODE_HANDLE booleanNodeHandle, PEAK_NODE_CACHE_USE_POLICY cacheUsePolicy, PEAK_BOOL8* value);
5271
5286 PEAK_COMMAND_NODE_HANDLE commandNodeHandle, PEAK_NODE_HANDLE* nodeHandle);
5302
5344PEAK_C_API PEAK_CommandNode_WaitUntilDone(PEAK_COMMAND_NODE_HANDLE commandNodeHandle, uint64_t waitTimeout_ms);
5345
5419 PEAK_FLOAT_NODE_HANDLE floatNodeHandle, PEAK_NODE_INCREMENT_TYPE* incrementType);
5436 PEAK_FLOAT_NODE_HANDLE floatNodeHandle, double* validValues, size_t* validValuesSize);
5451 PEAK_FLOAT_NODE_HANDLE floatNodeHandle, PEAK_NODE_REPRESENTATION* representation);
5466PEAK_C_API PEAK_FloatNode_GetUnit(PEAK_FLOAT_NODE_HANDLE floatNodeHandle, char* unit, size_t* unitSize);
5481 PEAK_FLOAT_NODE_HANDLE floatNodeHandle, PEAK_NODE_DISPLAY_NOTATION* displayNotation);
5496 PEAK_FLOAT_NODE_HANDLE floatNodeHandle, int64_t* displayPrecision);
5511 PEAK_FLOAT_NODE_HANDLE floatNodeHandle, PEAK_BOOL8* hasConstantIncrement);
5528 PEAK_FLOAT_NODE_HANDLE floatNodeHandle, PEAK_NODE_CACHE_USE_POLICY cacheUsePolicy, double* value);
5543
5589 PEAK_NODE_CACHE_USE_POLICY cacheUsePolicy, char* value, size_t* valueSize);
5605 PEAK_STRING_NODE_HANDLE stringNodeHandle, const char* value, size_t valueSize);
5606
5621 PEAK_REGISTER_NODE_HANDLE registerNodeHandle, PEAK_NODE_HANDLE* nodeHandle);
5667 PEAK_NODE_CACHE_USE_POLICY cacheUsePolicy, uint8_t* bytesToRead, size_t bytesToReadSize);
5684 PEAK_REGISTER_NODE_HANDLE registerNodeHandle, const uint8_t* bytesToWrite, size_t bytesToWriteSize);
5685
5700 PEAK_CATEGORY_NODE_HANDLE categoryNodeHandle, PEAK_NODE_HANDLE* nodeHandle);
5731 PEAK_CATEGORY_NODE_HANDLE categoryNodeHandle, size_t index, PEAK_NODE_HANDLE* nodeHandle);
5732
5747 PEAK_ENUMERATION_NODE_HANDLE enumerationNodeHandle, PEAK_NODE_HANDLE* nodeHandle);
5764 PEAK_NODE_CACHE_USE_POLICY cacheUsePolicy, PEAK_ENUMERATION_ENTRY_NODE_HANDLE* enumerationEntryNodeHandle);
5780 PEAK_ENUMERATION_ENTRY_NODE_HANDLE enumerationEntryNodeHandle);
5798 PEAK_ENUMERATION_NODE_HANDLE enumerationNodeHandle, const char* symbolicValue, size_t symbolicValueSize);
5814 PEAK_ENUMERATION_NODE_HANDLE enumerationNodeHandle, int64_t value);
5815
5833 const char* symbolicValue, size_t symbolicValueSize, PEAK_BOOL8* hasEntry);
5834
5851 PEAK_ENUMERATION_NODE_HANDLE enumerationNodeHandle, int64_t value, PEAK_BOOL8* hasEntry);
5852
5870 const char* symbolicValue, size_t symbolicValueSize,
5871 PEAK_ENUMERATION_ENTRY_NODE_HANDLE* enumerationEntryNodeHandle);
5872
5889 int64_t value, PEAK_ENUMERATION_ENTRY_NODE_HANDLE* enumerationEntryNodeHandle);
5890
5907 const char* symbolicValue, size_t symbolicValueSize,
5908 PEAK_ENUMERATION_ENTRY_NODE_HANDLE* enumerationEntryNodeHandle);
5909
5925 int64_t value, PEAK_ENUMERATION_ENTRY_NODE_HANDLE* enumerationEntryNodeHandle);
5926
5941 PEAK_ENUMERATION_NODE_HANDLE enumerationNodeHandle, size_t* numEntries);
5942
5959 PEAK_ENUMERATION_ENTRY_NODE_HANDLE* enumerationEntryNodeHandle);
5960
5975 PEAK_ENUMERATION_ENTRY_NODE_HANDLE enumerationEntryNodeHandle, PEAK_NODE_HANDLE* nodeHandle);
5976
5991 PEAK_ENUMERATION_ENTRY_NODE_HANDLE enumerationEntryNodeHandle, PEAK_BOOL8* isSelfClearing);
5992
6009 PEAK_ENUMERATION_ENTRY_NODE_HANDLE enumerationEntryNodeHandle, char* symbolicValue, size_t* symbolicValueSize);
6010
6025 PEAK_ENUMERATION_ENTRY_NODE_HANDLE enumerationEntryNodeHandle, int64_t* value);
6026
6046 PEAK_PORT_HANDLE portHandle, int32_t infoCommand, int32_t* infoDataType, uint8_t* info, size_t* infoSize);
6047
6063PEAK_C_API PEAK_Port_GetID(PEAK_PORT_HANDLE portHandle, char* id, size_t* idSize);
6064
6080PEAK_C_API PEAK_Port_GetName(PEAK_PORT_HANDLE portHandle, char* name, size_t* nameSize);
6081
6097PEAK_C_API PEAK_Port_GetVendorName(PEAK_PORT_HANDLE portHandle, char* vendorName, size_t* vendorNameSize);
6098
6114PEAK_C_API PEAK_Port_GetModelName(PEAK_PORT_HANDLE portHandle, char* modelName, size_t* modelNameSize);
6115
6131PEAK_C_API PEAK_Port_GetVersion(PEAK_PORT_HANDLE portHandle, char* version, size_t* versionSize);
6132
6148PEAK_C_API PEAK_Port_GetTLType(PEAK_PORT_HANDLE portHandle, char* tlType, size_t* tlTypeSize);
6149
6165PEAK_C_API PEAK_Port_GetModuleName(PEAK_PORT_HANDLE portHandle, char* moduleName, size_t* moduleNameSize);
6254 PEAK_PORT_HANDLE portHandle, uint64_t address, uint8_t* bytesToRead, size_t bytesToReadSize);
6274 PEAK_PORT_HANDLE portHandle, uint64_t address, const uint8_t* bytesToWrite, size_t bytesToWriteSize);
6306PEAK_C_API PEAK_Port_GetURL(PEAK_PORT_HANDLE portHandle, size_t index, PEAK_PORT_URL_HANDLE* portUrlHandle);
6307
6326 PEAK_PORT_URL_HANDLE portUrlHandle, int32_t infoCommand, int32_t* infoDataType, uint8_t* info, size_t* infoSize);
6342PEAK_C_API PEAK_PortURL_GetURL(PEAK_PORT_URL_HANDLE portUrlHandle, char* url, size_t* urlSize);
6372PEAK_C_API PEAK_PortURL_GetFileName(PEAK_PORT_URL_HANDLE portUrlHandle, char* fileName, size_t* fileNameSize);
6387 PEAK_PORT_URL_HANDLE portUrlHandle, uint64_t* fileRegisterAddress);
6417 PEAK_PORT_URL_HANDLE portUrlHandle, uint8_t* fileSha1Hash, size_t* fileSha1HashSize);
6431PEAK_C_API PEAK_PortURL_GetFileVersionMajor(PEAK_PORT_URL_HANDLE portUrlHandle, int32_t* fileVersionMajor);
6445PEAK_C_API PEAK_PortURL_GetFileVersionMinor(PEAK_PORT_URL_HANDLE portUrlHandle, int32_t* fileVersionMinor);
6460 PEAK_PORT_URL_HANDLE portUrlHandle, int32_t* fileVersionSubminor);
6475 PEAK_PORT_URL_HANDLE portUrlHandle, int32_t* fileSchemaVersionMajor);
6490 PEAK_PORT_URL_HANDLE portUrlHandle, int32_t* fileSchemaVersionMinor);
6505
6521 PEAK_EVENT_SUPPORTING_MODULE_HANDLE eventSupportingModuleHandle, PEAK_EVENT_TYPE eventType,
6522 PEAK_EVENT_CONTROLLER_HANDLE* eventControllerHandle);
6523
6542 int32_t infoCommand, int32_t* infoDataType, uint8_t* info, size_t* infoSize);
6557 PEAK_EVENT_CONTROLLER_HANDLE eventControllerHandle, size_t* numEventsInQueue);
6572 PEAK_EVENT_CONTROLLER_HANDLE eventControllerHandle, uint64_t* numEventsFired);
6587 PEAK_EVENT_CONTROLLER_HANDLE eventControllerHandle, size_t* eventMaxSize);
6602 PEAK_EVENT_CONTROLLER_HANDLE eventControllerHandle, size_t* eventDataMaxSize);
6617 PEAK_EVENT_CONTROLLER_HANDLE eventControllerHandle, PEAK_EVENT_TYPE* controlledEventType);
6635 PEAK_EVENT_CONTROLLER_HANDLE eventControllerHandle, uint64_t timeout_ms, PEAK_EVENT_HANDLE* eventHandle);
6636
6702
6721 PEAK_EVENT_HANDLE eventHandle, int32_t infoCommand, int32_t* infoDataType, uint8_t* info, size_t* infoSize);
6753PEAK_C_API PEAK_Event_GetData(PEAK_EVENT_HANDLE eventHandle, uint8_t* data, size_t* dataSize);
6788PEAK_C_API PEAK_Event_GetRawData(PEAK_EVENT_HANDLE eventHandle, uint8_t* rawData, size_t* rawDataSize);
6801
6829 PEAK_FIRMWARE_UPDATER_HANDLE firmwareUpdaterHandle, const char* gufPath, size_t gufPathSize);
6847 PEAK_FIRMWARE_UPDATER_HANDLE firmwareUpdaterHandle, const char* gufPath, size_t gufPathSize,
6848 PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle);
6863 PEAK_FIRMWARE_UPDATER_HANDLE firmwareUpdaterHandle, size_t* numFirmwareUpdateInformation);
6880 PEAK_FIRMWARE_UPDATER_HANDLE firmwareUpdaterHandle, size_t index,
6881 PEAK_FIRMWARE_UPDATE_INFORMATION_HANDLE* firmwareUpdateInformationHandle);
6900 PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle,
6901 PEAK_FIRMWARE_UPDATE_INFORMATION_HANDLE firmwareUpdateInformationHandle,
6902 PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER_HANDLE firmwareUpdateProgressObserverHandle);
6922 PEAK_FIRMWARE_UPDATER_HANDLE firmwareUpdaterHandle, PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle,
6923 PEAK_FIRMWARE_UPDATE_INFORMATION_HANDLE firmwareUpdateInformationHandle,
6924 PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER_HANDLE firmwareUpdateProgressObserverHandle,
6925 uint64_t deviceResetDiscoveryTimeout_ms);
6938
6953 PEAK_FIRMWARE_UPDATE_INFORMATION_HANDLE firmwareUpdateInformationHandle, PEAK_BOOL8* isValid);
6970 PEAK_FIRMWARE_UPDATE_INFORMATION_HANDLE firmwareUpdateInformationHandle, char* fileName, size_t* fileNameSize);
6987 PEAK_FIRMWARE_UPDATE_INFORMATION_HANDLE firmwareUpdateInformationHandle, char* description,
6988 size_t* descriptionSize);
7005 PEAK_FIRMWARE_UPDATE_INFORMATION_HANDLE firmwareUpdateInformationHandle, char* version, size_t* versionSize);
7022 PEAK_FIRMWARE_UPDATE_INFORMATION_HANDLE firmwareUpdateInformationHandle, char* versionExtractionPattern,
7023 size_t* versionExtractionPatternSize);
7038 PEAK_FIRMWARE_UPDATE_INFORMATION_HANDLE firmwareUpdateInformationHandle,
7056 PEAK_FIRMWARE_UPDATE_INFORMATION_HANDLE firmwareUpdateInformationHandle, char* releaseNotes,
7057 size_t* releaseNotesSize);
7074 PEAK_FIRMWARE_UPDATE_INFORMATION_HANDLE firmwareUpdateInformationHandle, char* releaseNotesUrl,
7075 size_t* releaseNotesUrlSize);
7090 PEAK_FIRMWARE_UPDATE_INFORMATION_HANDLE firmwareUpdateInformationHandle,
7091 PEAK_FIRMWARE_UPDATE_PERSISTENCE* userSetPersistence);
7106 PEAK_FIRMWARE_UPDATE_INFORMATION_HANDLE firmwareUpdateInformationHandle,
7107 PEAK_FIRMWARE_UPDATE_PERSISTENCE* sequencerSetPersistence);
7108
7121 PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER_HANDLE* firmwareUpdateProgressObserverHandle);
7138 PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER_HANDLE firmwareUpdateProgressObserverHandle,
7139 PEAK_FIRMWARE_UPDATE_STARTED_CALLBACK callback, void* callbackContext,
7155 PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER_HANDLE firmwareUpdateProgressObserverHandle,
7173 PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER_HANDLE firmwareUpdateProgressObserverHandle,
7174 PEAK_FIRMWARE_UPDATE_STEP_STARTED_CALLBACK callback, void* callbackContext,
7190 PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER_HANDLE firmwareUpdateProgressObserverHandle,
7209 PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER_HANDLE firmwareUpdateProgressObserverHandle,
7210 PEAK_FIRMWARE_UPDATE_STEP_PROGRESS_CHANGED_CALLBACK callback, void* callbackContext,
7226 PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER_HANDLE firmwareUpdateProgressObserverHandle,
7244 PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER_HANDLE firmwareUpdateProgressObserverHandle,
7245 PEAK_FIRMWARE_UPDATE_STEP_FINISHED_CALLBACK callback, void* callbackContext,
7261 PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER_HANDLE firmwareUpdateProgressObserverHandle,
7279 PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER_HANDLE firmwareUpdateProgressObserverHandle,
7280 PEAK_FIRMWARE_UPDATE_FINISHED_CALLBACK callback, void* callbackContext,
7296 PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER_HANDLE firmwareUpdateProgressObserverHandle,
7314 PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER_HANDLE firmwareUpdateProgressObserverHandle,
7315 PEAK_FIRMWARE_UPDATE_FAILED_CALLBACK callback, void* callbackContext,
7331 PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER_HANDLE firmwareUpdateProgressObserverHandle,
7345 PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER_HANDLE firmwareUpdateProgressObserverHandle);
7346
7363 PEAK_NODE_MAP_HANDLE nodeMapHandle, const char* fileName, PEAK_FILE_ADAPTER_HANDLE* fileAdapterHandle);
7364
7377
7395 PEAK_FILE_ADAPTER_HANDLE fileAdapterHandle, uint64_t size, uint64_t offset, uint8_t* data, uint64_t* dataSize);
7396
7413 PEAK_FILE_ADAPTER_HANDLE fileAdapterHandle, const uint8_t* data, uint64_t size, uint64_t offset);
7414
7427
7441
7442
7456
7457# ifdef __cplusplus
7458} // extern "C"
7459# endif
7460
7461#else
7462# ifdef __cplusplus
7463} // extern "C"
7464# endif
7465
7466# include <peak/backend/peak_dynamic_loader.h>
7467#endif // !PEAK_DYNAMIC_LOADING
PEAK_C_API PEAK_InterfaceDescriptor_OpenInterface(PEAK_INTERFACE_DESCRIPTOR_HANDLE interfaceDescriptorHandle, PEAK_INTERFACE_HANDLE *interfaceHandle)
Opens the interface being associated with the given interface descriptor.
PEAK_C_API PEAK_FirmwareUpdateProgressObserver_RegisterUpdateFinishedCallback(PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER_HANDLE firmwareUpdateProgressObserverHandle, PEAK_FIRMWARE_UPDATE_FINISHED_CALLBACK callback, void *callbackContext, PEAK_FIRMWARE_UPDATE_FINISHED_CALLBACK_HANDLE *callbackHandle)
Registers a callback signaling a finished update at the given firmware update progress observer.
struct PEAK_DATA_STREAM * PEAK_DATA_STREAM_HANDLE
Definition peak_backend.h:399
PEAK_C_API PEAK_Port_GetDataEndianness(PEAK_PORT_HANDLE portHandle, PEAK_ENDIANNESS *dataEndianness)
Asks the given port for its data endianness.
PEAK_C_API PEAK_Node_GetParentNodeMap(PEAK_NODE_HANDLE nodeHandle, PEAK_NODE_MAP_HANDLE *nodeMapHandle)
Asks the given node for its parent node map.
static const uint64_t PEAK_INFINITE_TIMEOUT
Definition peak_backend.h:359
PEAK_C_API PEAK_Buffer_GetHasParts(PEAK_BUFFER_HANDLE bufferHandle, PEAK_BOOL8 *hasParts)
Asks the given buffer whether it has parts.
void(PEAK_CALL_CONV * PEAK_DEVICE_DISCONNETED_CALLBACK)(PEAK_DEVICE_DESCRIPTOR_HANDLE disconnectedDevice, void *context)
Definition peak_backend.h:559
PEAK_C_API PEAK_EnumerationNode_FindEntryByValue(PEAK_ENUMERATION_NODE_HANDLE enumerationNodeHandle, int64_t value, PEAK_ENUMERATION_ENTRY_NODE_HANDLE *enumerationEntryNodeHandle)
Tells the given enumeration node to find an entry with the given value.
PEAK_C_API PEAK_Buffer_GetPart(PEAK_BUFFER_HANDLE bufferHandle, size_t index, PEAK_BUFFER_PART_HANDLE *bufferPartHandle)
Asks the given buffer for the part with the given index.
PEAK_C_API PEAK_DeviceDescriptor_GetAccessStatus(PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle, PEAK_DEVICE_ACCESS_STATUS *accessStatus)
Asks the given device descriptor for its access status.
PEAK_DEVICE_RECONNECT_ERROR_t
Definition peak_backend.h:518
@ PEAK_DEVICE_RECONNECT_OPERATION_REMOTE_DEVICE_CONFIGURATION_RESTORE_ERROR
Definition peak_backend.h:528
@ PEAK_DEVICE_RECONNECT_OPERATION_NO_ERROR
Definition peak_backend.h:520
@ PEAK_DEVICE_RECONNECT_OPERATION_REMOTE_DEVICE_ACQUISITION_RESTART_ERROR
Definition peak_backend.h:522
@ PEAK_DEVICE_RECONNECT_OPERATION_REMOTE_DEVICE_ACQUISITION_RESTART_PAYLOAD_SIZE_LARGER_THAN_BUFFERS
Definition peak_backend.h:526
PEAK_C_API PEAK_Buffer_GetHasChunks(PEAK_BUFFER_HANDLE bufferHandle, PEAK_BOOL8 *hasChunks)
Asks the given buffer whether it has chunks.
PEAK_C_API PEAK_IntegerNode_GetRepresentation(PEAK_INTEGER_NODE_HANDLE integerNodeHandle, PEAK_NODE_REPRESENTATION *representation)
Asks the given integer node for its representation.
PEAK_C_API PEAK_FirmwareUpdater_UpdateDeviceWithResetTimeout(PEAK_FIRMWARE_UPDATER_HANDLE firmwareUpdaterHandle, PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle, PEAK_FIRMWARE_UPDATE_INFORMATION_HANDLE firmwareUpdateInformationHandle, PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER_HANDLE firmwareUpdateProgressObserverHandle, uint64_t deviceResetDiscoveryTimeout_ms)
Tells the given firmware updater to update the given device with the given update information.
PEAK_C_API PEAK_DataStream_KillWait(PEAK_DATA_STREAM_HANDLE dataStreamHandle)
Tells the data stream to kill one call to PEAK_DataStream_WaitForFinishedBuffer.
PEAK_C_API PEAK_EventSupportingModule_EnableEvents(PEAK_EVENT_SUPPORTING_MODULE_HANDLE eventSupportingModuleHandle, PEAK_EVENT_TYPE eventType, PEAK_EVENT_CONTROLLER_HANDLE *eventControllerHandle)
Tells the given event-supporting module to enable events of the given type.
PEAK_C_API PEAK_PortURL_GetScheme(PEAK_PORT_URL_HANDLE portUrlHandle, PEAK_PORT_URL_SCHEME *scheme)
Asks the given port URL for its scheme.
PEAK_C_API PEAK_EnumerationNode_GetHasEntryByValue(PEAK_ENUMERATION_NODE_HANDLE enumerationNodeHandle, int64_t value, PEAK_BOOL8 *hasEntry)
Asks the given enumeration node whether it has an entry with the given value.
PEAK_C_API PEAK_Node_ToEnumerationEntryNode(PEAK_NODE_HANDLE nodeHandle, PEAK_ENUMERATION_ENTRY_NODE_HANDLE *enumerationEntryNodeHandle)
Casts the given node to an enumeration entry node.
PEAK_C_API PEAK_Device_ToModule(PEAK_DEVICE_HANDLE deviceHandle, PEAK_MODULE_HANDLE *moduleHandle)
Casts the given device to a module.
PEAK_C_API PEAK_Port_Read(PEAK_PORT_HANDLE portHandle, uint64_t address, uint8_t *bytesToRead, size_t bytesToReadSize)
Tells the given port to read the given amount of bytes at the given address.
PEAK_C_API PEAK_SystemDescriptor_GetKey(PEAK_SYSTEM_DESCRIPTOR_HANDLE systemDescriptorHandle, char *key, size_t *keySize)
Asks the given system descriptor for its key.
PEAK_C_API PEAK_System_GetGenTLVersionMinor(PEAK_SYSTEM_HANDLE systemHandle, uint32_t *gentlVersionMinor)
Asks the given system for the minor component of its GenTL version.
PEAK_C_API PEAK_Port_GetName(PEAK_PORT_HANDLE portHandle, char *name, size_t *nameSize)
Asks the given port for its name.
PEAK_C_API PEAK_BufferPart_GetParentBuffer(PEAK_BUFFER_PART_HANDLE bufferPartHandle, PEAK_BUFFER_HANDLE *bufferHandle)
Asks the given buffer part for its parent buffer.
PEAK_C_API PEAK_EventController_FlushEvents(PEAK_EVENT_CONTROLLER_HANDLE eventControllerHandle)
Tells the given event controller to flush all events in queue.
PEAK_C_API PEAK_Node_GetIsFeature(PEAK_NODE_HANDLE nodeHandle, PEAK_BOOL8 *isFeature)
Asks the given node whether it is a feature, i.e. it can be reached via category nodes from a categor...
PEAK_INTERFACE_LOST_CALLBACK * PEAK_INTERFACE_LOST_CALLBACK_HANDLE
Definition peak_backend.h:513
PEAK_C_API PEAK_Port_GetID(PEAK_PORT_HANDLE portHandle, char *id, size_t *idSize)
Asks the given port for its ID.
struct PEAK_PORT_URL * PEAK_PORT_URL_HANDLE
Definition peak_backend.h:471
PEAK_C_API PEAK_BooleanNode_ToNode(PEAK_BOOLEAN_NODE_HANDLE booleanNodeHandle, PEAK_NODE_HANDLE *nodeHandle)
Casts the given boolean node to a node.
PEAK_C_API PEAK_Buffer_GetChunk(PEAK_BUFFER_HANDLE bufferHandle, size_t index, PEAK_BUFFER_CHUNK_HANDLE *bufferChunkHandle)
Asks the given buffer for the chunk with the given index.
PEAK_C_API PEAK_System_GetGenTLVersionMajor(PEAK_SYSTEM_HANDLE systemHandle, uint32_t *gentlVersionMajor)
Asks the given system for the major component of its GenTL version.
PEAK_C_API PEAK_EnumerationNode_SetCurrentEntryByValue(PEAK_ENUMERATION_NODE_HANDLE enumerationNodeHandle, int64_t value)
Tells the given enumeration node to set its current entry by the given value.
PEAK_C_API PEAK_BufferPart_GetSize(PEAK_BUFFER_PART_HANDLE bufferPartHandle, size_t *size)
Asks the given buffer part for its size.
struct PEAK_SYSTEM_DESCRIPTOR * PEAK_SYSTEM_DESCRIPTOR_HANDLE
Definition peak_backend.h:367
PEAK_C_API PEAK_Buffer_GetYPadding(PEAK_BUFFER_HANDLE bufferHandle, size_t *yPadding)
Asks the given buffer for its Y padding.
PEAK_C_API PEAK_EnumerationNode_ToNode(PEAK_ENUMERATION_NODE_HANDLE enumerationNodeHandle, PEAK_NODE_HANDLE *nodeHandle)
Casts the given enumeration node to a node.
struct PEAK_MODULE_DESCRIPTOR * PEAK_MODULE_DESCRIPTOR_HANDLE
Definition peak_backend.h:415
struct PEAK_EVENT * PEAK_EVENT_HANDLE
Definition peak_backend.h:483
PEAK_C_API PEAK_EnvironmentInspector_GetCTIPath(size_t index, char *ctiPath, size_t *ctiPathSize)
Asks for the CTI path with the given index.
PEAK_C_API PEAK_Port_GetVersion(PEAK_PORT_HANDLE portHandle, char *version, size_t *versionSize)
Asks the given port for its version.
PEAK_C_API PEAK_FileAdapter_GetMaxSize(PEAK_FILE_ADAPTER_HANDLE fileAdapterHandle, uint64_t *maxSize)
Queries the maximum size of the given file.
PEAK_C_API PEAK_DeviceDescriptor_UnregisterInformationChangedCallback(PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle, PEAK_DEVICE_DESCRIPTOR_INFORMATION_CHANGED_CALLBACK_HANDLE callbackHandle)
Unregisters the information changed callback with the given handle from the given device descriptor.
PEAK_C_API PEAK_System_ToEventSupportingModule(PEAK_SYSTEM_HANDLE systemHandle, PEAK_EVENT_SUPPORTING_MODULE_HANDLE *eventSupportingModuleHandle)
Casts the given system to an event-supporting module.
PEAK_C_API PEAK_FirmwareUpdateProgressObserver_RegisterUpdateStepFinishedCallback(PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER_HANDLE firmwareUpdateProgressObserverHandle, PEAK_FIRMWARE_UPDATE_STEP_FINISHED_CALLBACK callback, void *callbackContext, PEAK_FIRMWARE_UPDATE_STEP_FINISHED_CALLBACK_HANDLE *callbackHandle)
Registers a callback signaling a finished update step at the given firmware update progress observer.
PEAK_C_API PEAK_Buffer_GetFrameID(PEAK_BUFFER_HANDLE bufferHandle, uint64_t *frameId)
Asks the given buffer for its frame ID.
PEAK_C_API PEAK_FirmwareUpdateInformation_GetDescription(PEAK_FIRMWARE_UPDATE_INFORMATION_HANDLE firmwareUpdateInformationHandle, char *description, size_t *descriptionSize)
Asks the given firmware update information for its description.
PEAK_C_API PEAK_DeviceDescriptor_GetDisplayName(PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle, char *displayName, size_t *displayNameSize)
Asks the given device descriptor for its display name.
PEAK_C_API PEAK_System_GetInfo(PEAK_SYSTEM_HANDLE systemHandle, int32_t infoCommand, int32_t *infoDataType, uint8_t *info, size_t *infoSize)
Asks the given system for an information based on a specific command.
PEAK_C_API PEAK_Event_GetType(PEAK_EVENT_HANDLE eventHandle, PEAK_EVENT_TYPE *type)
Asks the given event for its type.
PEAK_C_API PEAK_Port_GetIsAvailable(PEAK_PORT_HANDLE portHandle, PEAK_BOOL8 *isAvailable)
Asks the given port whether it is available.
PEAK_C_API PEAK_DeviceDescriptor_GetKey(PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle, char *key, size_t *keySize)
Asks the given device descriptor for its key.
PEAK_C_API PEAK_DataStream_GetNumBuffersAnnouncedMinRequired(PEAK_DATA_STREAM_HANDLE dataStreamHandle, size_t *numBuffersAnnouncedMinRequired)
Asks the given data stream for its minimum required number of announced buffers.
PEAK_C_API PEAK_PortURL_GetFileSchemaVersionMajor(PEAK_PORT_URL_HANDLE portUrlHandle, int32_t *fileSchemaVersionMajor)
Asks the given port URL for the major component of its file schema version.
PEAK_C_API PEAK_Event_GetInfo(PEAK_EVENT_HANDLE eventHandle, int32_t infoCommand, int32_t *infoDataType, uint8_t *info, size_t *infoSize)
Asks the given event for an information based on a specific command.
PEAK_C_API PEAK_Device_GetKey(PEAK_DEVICE_HANDLE deviceHandle, char *key, size_t *keySize)
Asks the given device for its key.
PEAK_C_API PEAK_CommandNode_ToNode(PEAK_COMMAND_NODE_HANDLE commandNodeHandle, PEAK_NODE_HANDLE *nodeHandle)
Casts the given command node to a node.
PEAK_C_API PEAK_FirmwareUpdateInformation_GetVersion(PEAK_FIRMWARE_UPDATE_INFORMATION_HANDLE firmwareUpdateInformationHandle, char *version, size_t *versionSize)
Asks the given firmware update information for its version.
PEAK_C_API PEAK_SystemDescriptor_GetCTIFullPath(PEAK_SYSTEM_DESCRIPTOR_HANDLE systemDescriptorHandle, char *ctiFullPath, size_t *ctiFullPathSize)
Asks the given system descriptor for its parent CTI's full path.
PEAK_C_API PEAK_BufferPart_GetXOffset(PEAK_BUFFER_PART_HANDLE bufferPartHandle, size_t *xOffset)
Asks the given buffer part for its X offset.
struct PEAK_MODULE * PEAK_MODULE_HANDLE
Definition peak_backend.h:419
PEAK_C_API PEAK_Node_FindSelectedNode(PEAK_NODE_HANDLE nodeHandle, const char *name, size_t nameSize, PEAK_NODE_HANDLE *selectedNodeHandle)
Tells the given node to find a selected node with the given name.
PEAK_C_API PEAK_Device_GetVendorName(PEAK_DEVICE_HANDLE deviceHandle, char *vendorName, size_t *vendorNameSize)
Asks the given device for its vendor name.
PEAK_C_API PEAK_FileAdapter_Read(PEAK_FILE_ADAPTER_HANDLE fileAdapterHandle, uint64_t size, uint64_t offset, uint8_t *data, uint64_t *dataSize)
Reads from the given file.
PEAK_NODE_VISIBILITY_t
Definition peak_backend.h:298
@ PEAK_NODE_VISIBILITY_GURU
Definition peak_backend.h:301
@ PEAK_NODE_VISIBILITY_EXPERT
Definition peak_backend.h:300
@ PEAK_NODE_VISIBILITY_BEGINNER
Definition peak_backend.h:299
@ PEAK_NODE_VISIBILITY_INVISIBLE
Definition peak_backend.h:302
PEAK_C_API PEAK_FirmwareUpdateProgressObserver_UnregisterUpdateStartedCallback(PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER_HANDLE firmwareUpdateProgressObserverHandle, PEAK_FIRMWARE_UPDATE_STARTED_CALLBACK_HANDLE callbackHandle)
Unregisters the update started callback with the given handle from the given firmware update progress...
PEAK_NODE_TYPE_t
Definition peak_backend.h:283
@ PEAK_NODE_TYPE_BOOLEAN
Definition peak_backend.h:285
@ PEAK_NODE_TYPE_FLOAT
Definition peak_backend.h:287
@ PEAK_NODE_TYPE_COMMAND
Definition peak_backend.h:286
@ PEAK_NODE_TYPE_CATEGORY
Definition peak_backend.h:290
@ PEAK_NODE_TYPE_ENUMERATION_ENTRY
Definition peak_backend.h:292
@ PEAK_NODE_TYPE_ENUMERATION
Definition peak_backend.h:291
@ PEAK_NODE_TYPE_STRING
Definition peak_backend.h:288
@ PEAK_NODE_TYPE_INTEGER
Definition peak_backend.h:284
@ PEAK_NODE_TYPE_REGISTER
Definition peak_backend.h:289
PEAK_C_API PEAK_FirmwareUpdateProgressObserver_UnregisterUpdateFinishedCallback(PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER_HANDLE firmwareUpdateProgressObserverHandle, PEAK_FIRMWARE_UPDATE_FINISHED_CALLBACK_HANDLE callbackHandle)
Unregisters the update finished callback with the given handle from the given firmware update progres...
PEAK_C_API PEAK_FirmwareUpdateInformation_GetFileName(PEAK_FIRMWARE_UPDATE_INFORMATION_HANDLE firmwareUpdateInformationHandle, char *fileName, size_t *fileNameSize)
Asks the given firmware update information for its file name.
PEAK_C_API PEAK_NodeMap_GetNode(PEAK_NODE_MAP_HANDLE nodeMapHandle, size_t index, PEAK_NODE_HANDLE *nodeHandle)
Asks the given node map for the node with the given index.
PEAK_C_API PEAK_Node_GetToolTip(PEAK_NODE_HANDLE nodeHandle, char *toolTip, size_t *toolTipSize)
Asks the given node for its tooltip.
PEAK_C_API PEAK_System_GetKey(PEAK_SYSTEM_HANDLE systemHandle, char *key, size_t *keySize)
Asks the given system for its key.
PEAK_C_API PEAK_DataStream_GetParentDevice(PEAK_DATA_STREAM_HANDLE dataStreamHandle, PEAK_DEVICE_HANDLE *deviceHandle)
Asks the given data stream for its parent device.
PEAK_C_API PEAK_Node_ToRegisterNode(PEAK_NODE_HANDLE nodeHandle, PEAK_REGISTER_NODE_HANDLE *registerNodeHandle)
Casts the given node to a register node.
PEAK_C_API PEAK_Buffer_GetSystemTimestamp_ns(PEAK_BUFFER_HANDLE bufferHandle, uint64_t *systemTimestamp_ns)
Asks the given buffer for its system timestamp in nanoseconds.
PEAK_FIRMWARE_UPDATE_STARTED_CALLBACK * PEAK_FIRMWARE_UPDATE_STARTED_CALLBACK_HANDLE
Definition peak_backend.h:594
PEAK_PIXEL_FORMAT_NAMESPACE_t
Definition peak_backend.h:308
@ PEAK_PIXEL_FORMAT_NAMESPACE_PFNC_32_BIT
Definition peak_backend.h:312
@ PEAK_PIXEL_FORMAT_NAMESPACE_PFNC_16_BIT
Definition peak_backend.h:311
@ PEAK_PIXEL_FORMAT_NAMESPACE_GEV
Definition peak_backend.h:309
@ PEAK_PIXEL_FORMAT_NAMESPACE_CUSTOM
Definition peak_backend.h:314
@ PEAK_PIXEL_FORMAT_NAMESPACE_IIDC
Definition peak_backend.h:310
PEAK_C_API PEAK_PortURL_GetURL(PEAK_PORT_URL_HANDLE portUrlHandle, char *url, size_t *urlSize)
Asks the given port URL for its URL string.
PEAK_C_API PEAK_Node_GetCachingMode(PEAK_NODE_HANDLE nodeHandle, PEAK_NODE_CACHING_MODE *cachingMode)
Asks the given node for its caching mode.
void(PEAK_CALL_CONV * PEAK_DEVICE_DESCRIPTOR_INFORMATION_CHANGED_CALLBACK)(const PEAK_DEVICE_INFORMATION_ROLE *changedRoles, size_t changedRolesSize, void *context)
Definition peak_backend.h:583
PEAK_C_API PEAK_System_Destruct(PEAK_SYSTEM_HANDLE systemHandle)
Destroys the given system.
PEAK_C_API PEAK_InterfaceDescriptor_ToModuleDescriptor(PEAK_INTERFACE_DESCRIPTOR_HANDLE interfaceDescriptorHandle, PEAK_MODULE_DESCRIPTOR_HANDLE *moduleDescriptorHandle)
Casts the given interface descriptor to a module descriptor.
PEAK_C_API PEAK_FloatNode_GetIncrementType(PEAK_FLOAT_NODE_HANDLE floatNodeHandle, PEAK_NODE_INCREMENT_TYPE *incrementType)
Asks the given float node for its increment type.
PEAK_C_API PEAK_FirmwareUpdateInformation_GetIsValid(PEAK_FIRMWARE_UPDATE_INFORMATION_HANDLE firmwareUpdateInformationHandle, PEAK_BOOL8 *isValid)
Asks the given firmware update information whether it is valid.
PEAK_C_API PEAK_DataStream_ToModule(PEAK_DATA_STREAM_HANDLE dataStreamHandle, PEAK_MODULE_HANDLE *moduleHandle)
Casts the given data stream to a module.
struct PEAK_INTERFACE_DESCRIPTOR * PEAK_INTERFACE_DESCRIPTOR_HANDLE
Definition peak_backend.h:375
PEAK_C_API PEAK_BooleanNode_SetValue(PEAK_BOOLEAN_NODE_HANDLE booleanNodeHandle, PEAK_BOOL8 value)
Tells the given boolean node to set the given value.
PEAK_C_API PEAK_IntegerNode_GetMinimum(PEAK_INTEGER_NODE_HANDLE integerNodeHandle, int64_t *minimum)
Asks the given integer node for its minimum.
struct PEAK_DATA_STREAM_DESCRIPTOR * PEAK_DATA_STREAM_DESCRIPTOR_HANDLE
Definition peak_backend.h:395
PEAK_C_API PEAK_DataStream_Flush(PEAK_DATA_STREAM_HANDLE dataStreamHandle, PEAK_DATA_STREAM_FLUSH_MODE flushMode)
Tells the given data stream to flush its queues using the given mode.
PEAK_C_API PEAK_System_GetDisplayName(PEAK_SYSTEM_HANDLE systemHandle, char *displayName, size_t *displayNameSize)
Asks the given system for its display name.
void(PEAK_CALL_CONV * PEAK_FIRMWARE_UPDATE_FINISHED_CALLBACK)(void *context)
Definition peak_backend.h:612
PEAK_C_API PEAK_PortURL_GetFileVersionMinor(PEAK_PORT_URL_HANDLE portUrlHandle, int32_t *fileVersionMinor)
Asks the given port URL for the minor component of its file version.
PEAK_C_API PEAK_Interface_ToEventSupportingModule(PEAK_INTERFACE_HANDLE interfaceHandle, PEAK_EVENT_SUPPORTING_MODULE_HANDLE *eventSupportingModuleHandle)
Casts the given interface to an event-supporting module.
PEAK_C_API PEAK_Interface_GetParentSystem(PEAK_INTERFACE_HANDLE interfaceHandle, PEAK_SYSTEM_HANDLE *systemHandle)
Asks the given interface for its parent system.
PEAK_C_API PEAK_InterfaceDescriptor_GetKey(PEAK_INTERFACE_DESCRIPTOR_HANDLE interfaceDescriptorHandle, char *key, size_t *keySize)
Asks the given interface descriptor for its key.
PEAK_C_API PEAK_Buffer_GetIsIncomplete(PEAK_BUFFER_HANDLE bufferHandle, PEAK_BOOL8 *isIncomplete)
Asks the given buffer whether it is incomplete.
PEAK_C_API PEAK_Interface_GetInfo(PEAK_INTERFACE_HANDLE interfaceHandle, int32_t infoCommand, int32_t *infoDataType, uint8_t *info, size_t *infoSize)
Asks the given interface for an information based on a specific command.
PEAK_NODE_CHANGED_CALLBACK * PEAK_NODE_CHANGED_CALLBACK_HANDLE
Definition peak_backend.h:580
PEAK_C_API PEAK_DataStream_Destruct(PEAK_DATA_STREAM_HANDLE dataStreamHandle)
Destroys the given data stream.
struct PEAK_PORT * PEAK_PORT_HANDLE
Definition peak_backend.h:467
PEAK_C_API PEAK_FloatNode_GetDisplayNotation(PEAK_FLOAT_NODE_HANDLE floatNodeHandle, PEAK_NODE_DISPLAY_NOTATION *displayNotation)
Asks the given float node for its display notation.
PEAK_C_API PEAK_NodeMap_UpdateEventNodes(PEAK_NODE_MAP_HANDLE nodeMapHandle, PEAK_EVENT_HANDLE eventHandle)
Updates event information in the node map.
PEAK_C_API PEAK_Device_GetSerialNumber(PEAK_DEVICE_HANDLE deviceHandle, char *serialNumber, size_t *serialNumberSize)
Asks the given device for its serial number.
PEAK_C_API PEAK_NodeMap_Lock(PEAK_NODE_MAP_HANDLE nodeMapHandle)
Locks a recursive mutex on the NodeMap.
PEAK_C_API PEAK_CategoryNode_GetNumSubNodes(PEAK_CATEGORY_NODE_HANDLE categoryNodeHandle, size_t *numSubNodes)
Asks the given category node for its number of sub nodes.
int32_t PEAK_EVENT_TYPE
Definition peak_backend.h:183
struct PEAK_ENUMERATION_NODE * PEAK_ENUMERATION_NODE_HANDLE
Definition peak_backend.h:459
PEAK_C_API PEAK_Buffer_ToEventSupportingModule(PEAK_BUFFER_HANDLE bufferHandle, PEAK_EVENT_SUPPORTING_MODULE_HANDLE *eventSupportingModuleHandle)
Casts the given buffer to an event-supporting module.
PEAK_C_API PEAK_Buffer_GetSize(PEAK_BUFFER_HANDLE bufferHandle, size_t *size)
Asks the given buffer for its size.
PEAK_C_API PEAK_NodeMap_GetHasEventSupportedData(PEAK_NODE_MAP_HANDLE nodeMapHandle, PEAK_EVENT_HANDLE eventHandle, PEAK_BOOL8 *hasSupportedData)
Checks if the event contains data corresponding to the node map.
PEAK_C_API PEAK_EnumerationEntryNode_ToNode(PEAK_ENUMERATION_ENTRY_NODE_HANDLE enumerationEntryNodeHandle, PEAK_NODE_HANDLE *nodeHandle)
Casts the given enumeration entry node to a node.
PEAK_C_API PEAK_BufferChunk_GetParentBuffer(PEAK_BUFFER_CHUNK_HANDLE bufferChunkHandle, PEAK_BUFFER_HANDLE *bufferHandle)
Asks the given buffer chunk for its parent buffer.
PEAK_C_API PEAK_Node_GetNumSelectedNodes(PEAK_NODE_HANDLE nodeHandle, size_t *numSelectedNodes)
Asks the given node for its number of selected nodes.
PEAK_C_API PEAK_EventController_GetEventMaxSize(PEAK_EVENT_CONTROLLER_HANDLE eventControllerHandle, size_t *eventMaxSize)
Asks the event controller for the maximum size of an event.
PEAK_C_API PEAK_DataStream_GetNumUnderruns(PEAK_DATA_STREAM_HANDLE dataStreamHandle, uint64_t *numUnderruns)
Asks the given data stream for its number of underruns.
PEAK_C_API PEAK_FloatNode_GetIncrement(PEAK_FLOAT_NODE_HANDLE floatNodeHandle, double *increment)
Asks the given float node for its increment.
PEAK_C_API PEAK_Node_FindSelectingNode(PEAK_NODE_HANDLE nodeHandle, const char *name, size_t nameSize, PEAK_NODE_HANDLE *selectingNodeHandle)
Tells the given node to find a selecting node with the given name.
PEAK_DEVICE_ACCESS_STATUS_t
Definition peak_backend.h:122
@ PEAK_DEVICE_ACCESS_STATUS_CUSTOM
Definition peak_backend.h:130
@ PEAK_DEVICE_ACCESS_STATUS_READ_WRITE
Definition peak_backend.h:123
@ PEAK_DEVICE_ACCESS_STATUS_BUSY
Definition peak_backend.h:126
@ PEAK_DEVICE_ACCESS_STATUS_OPEN_READ_WRITE
Definition peak_backend.h:127
@ PEAK_DEVICE_ACCESS_STATUS_NO_ACCESS
Definition peak_backend.h:125
@ PEAK_DEVICE_ACCESS_STATUS_OPEN_READ_ONLY
Definition peak_backend.h:128
@ PEAK_DEVICE_ACCESS_STATUS_READ_ONLY
Definition peak_backend.h:124
struct PEAK_COMMAND_NODE * PEAK_COMMAND_NODE_HANDLE
Definition peak_backend.h:439
int32_t PEAK_NODE_INCREMENT_TYPE
Definition peak_backend.h:258
int32_t PEAK_BUFFER_PART_TYPE
Definition peak_backend.h:78
PEAK_C_API PEAK_Device_GetDisplayName(PEAK_DEVICE_HANDLE deviceHandle, char *displayName, size_t *displayNameSize)
Asks the given device for its display name.
PEAK_C_API PEAK_DataStream_GetBufferAlignment(PEAK_DATA_STREAM_HANDLE dataStreamHandle, size_t *bufferAlignment)
Asks the given data stream for its buffer alignment.
PEAK_C_API PEAK_BooleanNode_GetValue(PEAK_BOOLEAN_NODE_HANDLE booleanNodeHandle, PEAK_NODE_CACHE_USE_POLICY cacheUsePolicy, PEAK_BOOL8 *value)
Asks the given boolean node for its value.
struct PEAK_STRING_NODE * PEAK_STRING_NODE_HANDLE
Definition peak_backend.h:447
PEAK_C_API PEAK_FirmwareUpdateProgressObserver_RegisterUpdateFailedCallback(PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER_HANDLE firmwareUpdateProgressObserverHandle, PEAK_FIRMWARE_UPDATE_FAILED_CALLBACK callback, void *callbackContext, PEAK_FIRMWARE_UPDATE_FAILED_CALLBACK_HANDLE *callbackHandle)
Registers a callback signaling a failed update at the given firmware update progress observer.
PEAK_C_API PEAK_Node_ToBooleanNode(PEAK_NODE_HANDLE nodeHandle, PEAK_BOOLEAN_NODE_HANDLE *booleanNodeHandle)
Casts the given node to a boolean node.
PEAK_C_API PEAK_FloatNode_ToNode(PEAK_FLOAT_NODE_HANDLE floatNodeHandle, PEAK_NODE_HANDLE *nodeHandle)
Casts the given float node to a node.
PEAK_C_API PEAK_Interface_UnregisterDeviceFoundCallback(PEAK_INTERFACE_HANDLE interfaceHandle, PEAK_DEVICE_FOUND_CALLBACK_HANDLE callbackHandle)
Unregisters the device-found callback with the given handle from the given interface.
struct PEAK_NODE * PEAK_NODE_HANDLE
Definition peak_backend.h:427
PEAK_C_API PEAK_Device_GetModelName(PEAK_DEVICE_HANDLE deviceHandle, char *modelName, size_t *modelNameSize)
Asks the given device for its model name.
PEAK_C_API PEAK_Interface_ToModule(PEAK_INTERFACE_HANDLE interfaceHandle, PEAK_MODULE_HANDLE *moduleHandle)
Casts the given interface to a module.
PEAK_C_API PEAK_Device_GetTimestampTickFrequency(PEAK_DEVICE_HANDLE deviceHandle, uint64_t *timestampTickFrequency)
Asks the given device for its timestamp tick frequency.
PEAK_C_API PEAK_FirmwareUpdateInformation_GetVersionExtractionPattern(PEAK_FIRMWARE_UPDATE_INFORMATION_HANDLE firmwareUpdateInformationHandle, char *versionExtractionPattern, size_t *versionExtractionPatternSize)
Asks the given firmware update information for its version extraction pattern.
PEAK_C_API PEAK_Buffer_GetNumChunks(PEAK_BUFFER_HANDLE bufferHandle, size_t *numChunks)
Asks the given buffer for its number of chunks.
struct PEAK_BUFFER_CHUNK * PEAK_BUFFER_CHUNK_HANDLE
Definition peak_backend.h:407
PEAK_C_API PEAK_FileAdapter_GetSize(PEAK_FILE_ADAPTER_HANDLE fileAdapterHandle, uint64_t *size)
Queries the size of the given file.
PEAK_C_API PEAK_Buffer_GetUserPtr(PEAK_BUFFER_HANDLE bufferHandle, void **userPtr)
Asks the given buffer for its user pointer.
PEAK_C_API PEAK_NodeMap_TryLock(PEAK_NODE_MAP_HANDLE nodeMapHandle, PEAK_BOOL8 *locked)
Tries to Lock a recursive mutex on the NodeMap. Use this to synchronize NodeMap access from multiple ...
struct PEAK_INTERFACE * PEAK_INTERFACE_HANDLE
Definition peak_backend.h:379
uint32_t PEAK_DEVICE_RECONNECT_ERROR_FLAGS
Definition peak_backend.h:530
PEAK_C_API PEAK_Event_GetData(PEAK_EVENT_HANDLE eventHandle, uint8_t *data, size_t *dataSize)
Asks the given event for its data.
PEAK_C_API PEAK_DataStream_GetNumChunksPerBufferMax(PEAK_DATA_STREAM_HANDLE dataStreamHandle, size_t *numChunksPerBufferMax)
Asks the given data stream for its maximum number of chunks per buffer.
PEAK_DEVICE_ACCESS_TYPE_t
Definition peak_backend.h:136
@ PEAK_DEVICE_ACCESS_TYPE_EXCLUSIVE
Definition peak_backend.h:139
@ PEAK_DEVICE_ACCESS_TYPE_CUSTOM
Definition peak_backend.h:141
@ PEAK_DEVICE_ACCESS_TYPE_READ_ONLY
Definition peak_backend.h:137
@ PEAK_DEVICE_ACCESS_TYPE_CONTROL
Definition peak_backend.h:138
PEAK_C_API PEAK_FirmwareUpdater_GetFirmwareUpdateInformation(PEAK_FIRMWARE_UPDATER_HANDLE firmwareUpdaterHandle, size_t index, PEAK_FIRMWARE_UPDATE_INFORMATION_HANDLE *firmwareUpdateInformationHandle)
Asks the given firmware updater for the update information with the given index.
PEAK_C_API PEAK_BufferPart_GetWidth(PEAK_BUFFER_PART_HANDLE bufferPartHandle, size_t *width)
Asks the given buffer part for its width.
PEAK_C_API PEAK_DeviceDescriptor_SetMonitoringUpdateInterval(PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle, uint64_t monitoringUpdateInterval_ms)
Tells the given device descriptor to set the given monitoring update interval.
PEAK_NODE_NAMESPACE_t
Definition peak_backend.h:262
@ PEAK_NODE_NAMESPACE_STANDARD
Definition peak_backend.h:264
@ PEAK_NODE_NAMESPACE_CUSTOM
Definition peak_backend.h:263
PEAK_C_API PEAK_Node_GetInvalidatingNode(PEAK_NODE_HANDLE nodeHandle, size_t index, PEAK_NODE_HANDLE *invalidatingNodeHandle)
Asks the given node for the invalidating node with the given index.
PEAK_INTERFACE_LIST_CHANGED_CALLBACK * PEAK_INTERFACE_LIST_CHANGED_CALLBACK_HANDLE
Definition peak_backend.h:515
PEAK_C_API PEAK_System_UpdateInterfaces(PEAK_SYSTEM_HANDLE systemHandle, uint64_t timeout_ms)
Tells the given system to update its interfaces with the given timeout.
PEAK_C_API PEAK_Buffer_UpdateParts(PEAK_BUFFER_HANDLE bufferHandle)
Tells the given buffer to update its parts.
PEAK_C_API PEAK_DataStream_GetDefinesPayloadSize(PEAK_DATA_STREAM_HANDLE dataStreamHandle, PEAK_BOOL8 *definesPayloadSize)
Asks the given data stream whether it defines the payload size.
PEAK_C_API PEAK_DeviceDescriptor_GetMonitoringUpdateInterval(PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle, uint64_t *monitoringUpdateInterval_ms)
Asks the given device descriptor for its monitoring update interval.
PEAK_C_API PEAK_FloatNode_GetHasConstantIncrement(PEAK_FLOAT_NODE_HANDLE floatNodeHandle, PEAK_BOOL8 *hasConstantIncrement)
Asks the given float node whether it has a constant increment.
PEAK_DEVICE_DESCRIPTOR_INFORMATION_CHANGED_CALLBACK * PEAK_DEVICE_DESCRIPTOR_INFORMATION_CHANGED_CALLBACK_HANDLE
Definition peak_backend.h:587
PEAK_C_API PEAK_Node_GetNumSelectingNodes(PEAK_NODE_HANDLE nodeHandle, size_t *numSelectingNodes)
Asks the given node for its number of selecting nodes.
PEAK_C_API PEAK_Interface_GetTLType(PEAK_INTERFACE_HANDLE interfaceHandle, char *tlType, size_t *tlTypeSize)
Asks the given interface for its TL type.
PEAK_DEVICE_DISCONNETED_CALLBACK * PEAK_DEVICE_DISCONNECTED_CALLBACK_HANDLE
Definition peak_backend.h:568
PEAK_NODE_CACHING_MODE_t
Definition peak_backend.h:227
@ PEAK_NODE_CACHING_MODE_NO_CACHE
Definition peak_backend.h:228
@ PEAK_NODE_CACHING_MODE_WRITE_AROUND
Definition peak_backend.h:230
@ PEAK_NODE_CACHING_MODE_WRITE_THROUGH
Definition peak_backend.h:229
PEAK_C_API PEAK_BufferPart_GetHeight(PEAK_BUFFER_PART_HANDLE bufferPartHandle, size_t *height)
Asks the given buffer part for its height.
struct PEAK_PRODUCER_LIBRARY * PEAK_PRODUCER_LIBRARY_HANDLE
Definition peak_backend.h:363
PEAK_C_API PEAK_Buffer_GetTimestamp_ns(PEAK_BUFFER_HANDLE bufferHandle, uint64_t *timestamp_ns)
Asks the given buffer for its timestamp in nanoseconds.
struct PEAK_BUFFER * PEAK_BUFFER_HANDLE
Definition peak_backend.h:403
PEAK_C_API PEAK_FirmwareUpdateProgressObserver_RegisterUpdateStartedCallback(PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER_HANDLE firmwareUpdateProgressObserverHandle, PEAK_FIRMWARE_UPDATE_STARTED_CALLBACK callback, void *callbackContext, PEAK_FIRMWARE_UPDATE_STARTED_CALLBACK_HANDLE *callbackHandle)
Registers a callback signaling a started update at the given firmware update progress observer.
PEAK_FIRMWARE_UPDATE_FINISHED_CALLBACK * PEAK_FIRMWARE_UPDATE_FINISHED_CALLBACK_HANDLE
Definition peak_backend.h:614
PEAK_C_API PEAK_FirmwareUpdater_Construct(PEAK_FIRMWARE_UPDATER_HANDLE *firmwareUpdaterHandle)
Creates a firmware updater.
PEAK_C_API PEAK_EnumerationNode_GetCurrentEntry(PEAK_ENUMERATION_NODE_HANDLE enumerationNodeHandle, PEAK_NODE_CACHE_USE_POLICY cacheUsePolicy, PEAK_ENUMERATION_ENTRY_NODE_HANDLE *enumerationEntryNodeHandle)
Asks the given enumeration node for its current entry.
int32_t PEAK_NODE_REPRESENTATION
Definition peak_backend.h:279
PEAK_C_API PEAK_Node_GetSelectingNode(PEAK_NODE_HANDLE nodeHandle, size_t index, PEAK_NODE_HANDLE *selectingNodeHandle)
Asks the given node for the selecting node with the given index.
void(PEAK_CALL_CONV * PEAK_BUFFER_REVOCATION_CALLBACK)(void *buffer, void *userPtr, void *context)
Definition peak_backend.h:575
PEAK_C_API PEAK_CommandNode_Execute(PEAK_COMMAND_NODE_HANDLE commandNodeHandle)
Tells the given command node to execute its associated command.
PEAK_C_API PEAK_EnumerationEntryNode_GetValue(PEAK_ENUMERATION_ENTRY_NODE_HANDLE enumerationEntryNodeHandle, int64_t *value)
Asks the given enumeration entry node for its value.
PEAK_C_API PEAK_FirmwareUpdateInformation_GetSequencerSetPersistence(PEAK_FIRMWARE_UPDATE_INFORMATION_HANDLE firmwareUpdateInformationHandle, PEAK_FIRMWARE_UPDATE_PERSISTENCE *sequencerSetPersistence)
Asks the given firmware update information for its sequencer set persistence.
PEAK_C_API PEAK_Interface_UnregisterDeviceListChangedCallback(PEAK_INTERFACE_HANDLE interfaceHandle, PEAK_DEVICE_LIST_CHANGED_CALLBACK_HANDLE callbackHandle)
Unregisters the device-list-changed callback with the given handle from the given interface.
PEAK_C_API PEAK_FirmwareUpdater_GetNumFirmwareUpdateInformation(PEAK_FIRMWARE_UPDATER_HANDLE firmwareUpdaterHandle, size_t *numFirmwareUpdateInformation)
Asks the given firmware updater for its number of update information.
PEAK_C_API PEAK_Node_GetType(PEAK_NODE_HANDLE nodeHandle, PEAK_NODE_TYPE *type)
Asks the given node for its type.
PEAK_C_API PEAK_System_GetID(PEAK_SYSTEM_HANDLE systemHandle, char *id, size_t *idSize)
Asks the given system for its ID.
int32_t PEAK_NODE_ACCESS_STATUS
Definition peak_backend.h:223
PEAK_C_API PEAK_Port_GetIsImplemented(PEAK_PORT_HANDLE portHandle, PEAK_BOOL8 *isImplemented)
Asks the given port whether it is implemented.
struct PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER * PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER_HANDLE
Definition peak_backend.h:499
PEAK_PORT_URL_SCHEME_t
Definition peak_backend.h:320
@ PEAK_PORT_URL_SCHEME_LOCAL
Definition peak_backend.h:321
@ PEAK_PORT_URL_SCHEME_CUSTOM
Definition peak_backend.h:325
@ PEAK_PORT_URL_SCHEME_FILE
Definition peak_backend.h:323
@ PEAK_PORT_URL_SCHEME_HTTP
Definition peak_backend.h:322
int32_t PEAK_NODE_TYPE
Definition peak_backend.h:294
struct PEAK_EVENT_SUPPORTING_MODULE * PEAK_EVENT_SUPPORTING_MODULE_HANDLE
Definition peak_backend.h:475
PEAK_C_API PEAK_Node_FindInvalidatedNode(PEAK_NODE_HANDLE nodeHandle, const char *name, size_t nameSize, PEAK_NODE_HANDLE *invalidatedNodeHandle)
Tells the given node to find an invalidated node with the given name.
PEAK_C_API PEAK_Buffer_GetTimestamp_ticks(PEAK_BUFFER_HANDLE bufferHandle, uint64_t *timestamp_ticks)
Asks the given buffer for its timestamp in ticks.
PEAK_C_API PEAK_DeviceDescriptor_GetTLType(PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle, char *tlType, size_t *tlTypeSize)
Asks the given device descriptor for its TL type.
PEAK_C_API PEAK_Node_FindInvalidatingNode(PEAK_NODE_HANDLE nodeHandle, const char *name, size_t nameSize, PEAK_NODE_HANDLE *invalidatingNodeHandle)
Tells the given node to find an invalidating node with the given name.
PEAK_C_API PEAK_Buffer_GetBasePtr(PEAK_BUFFER_HANDLE bufferHandle, void **basePtr)
Asks the given buffer for its base pointer.
int32_t PEAK_FIRMWARE_UPDATE_PERSISTENCE
Definition peak_backend.h:191
PEAK_C_API PEAK_Interface_RegisterDeviceLostCallback(PEAK_INTERFACE_HANDLE interfaceHandle, PEAK_DEVICE_LOST_CALLBACK callback, void *callbackContext, PEAK_DEVICE_LOST_CALLBACK_HANDLE *callbackHandle)
Registers a callback signaling a lost device at the given interface.
PEAK_DEVICE_LOST_CALLBACK * PEAK_DEVICE_LOST_CALLBACK_HANDLE
Definition peak_backend.h:570
PEAK_C_API PEAK_Buffer_GetPixelEndianness(PEAK_BUFFER_HANDLE bufferHandle, PEAK_ENDIANNESS *pixelEndianness)
Asks the given buffer for its pixel endianness.
PEAK_NODE_CACHE_USE_POLICY_t
Definition peak_backend.h:236
@ PEAK_NODE_CACHE_USE_POLICY_USE_CACHE
Definition peak_backend.h:237
@ PEAK_NODE_CACHE_USE_POLICY_IGNORE_CACHE
Definition peak_backend.h:238
PEAK_C_API PEAK_SystemDescriptor_GetModelName(PEAK_SYSTEM_DESCRIPTOR_HANDLE systemDescriptorHandle, char *modelName, size_t *modelNameSize)
Asks the given system descriptor for its model name.
PEAK_C_API PEAK_PortURL_GetFileVersionMajor(PEAK_PORT_URL_HANDLE portUrlHandle, int32_t *fileVersionMajor)
Asks the given port URL for the major component of its file version.
PEAK_C_API PEAK_Buffer_GetImageOffset(PEAK_BUFFER_HANDLE bufferHandle, size_t *imageOffset)
Asks the given buffer for its image offset.
PEAK_C_API PEAK_DataStream_GetNumBuffersStarted(PEAK_DATA_STREAM_HANDLE dataStreamHandle, uint64_t *numBuffersStarted)
Asks the given data stream for its number of started buffers.
PEAK_C_API PEAK_IntegerNode_GetMaximum(PEAK_INTEGER_NODE_HANDLE integerNodeHandle, int64_t *maximum)
Asks the given integer node for its maximum.
PEAK_C_API PEAK_Node_GetVisibility(PEAK_NODE_HANDLE nodeHandle, PEAK_NODE_VISIBILITY *visibility)
Asks the given node for its visibility.
PEAK_C_API PEAK_Event_Destruct(PEAK_EVENT_HANDLE eventHandle)
Destroys the given event.
PEAK_DATA_STREAM_FLUSH_MODE_t
Definition peak_backend.h:109
@ PEAK_DATA_STREAM_FLUSH_MODE_UNQUEUED_TO_INPUT_POOL
Definition peak_backend.h:113
@ PEAK_DATA_STREAM_FLUSH_MODE_ALL_TO_INPUT_POOL
Definition peak_backend.h:112
@ PEAK_DATA_STREAM_FLUSH_MODE_CUSTOM
Definition peak_backend.h:116
@ PEAK_DATA_STREAM_FLUSH_MODE_INPUT_POOL_TO_OUTPUT_QUEUE
Definition peak_backend.h:110
@ PEAK_DATA_STREAM_FLUSH_MODE_DISCARD_OUTPUT_QUEUE
Definition peak_backend.h:111
@ PEAK_DATA_STREAM_FLUSH_MODE_DISCARD_ALL
Definition peak_backend.h:114
#define PEAK_C_API
Definition peak_backend.h:622
PEAK_C_API PEAK_BufferChunk_GetID(PEAK_BUFFER_CHUNK_HANDLE bufferChunkHandle, uint64_t *id)
Asks the given buffer chunk for its ID.
struct PEAK_EVENT_CONTROLLER * PEAK_EVENT_CONTROLLER_HANDLE
Definition peak_backend.h:479
PEAK_C_API PEAK_Node_ToFloatNode(PEAK_NODE_HANDLE nodeHandle, PEAK_FLOAT_NODE_HANDLE *floatNodeHandle)
Casts the given node to a float node.
struct PEAK_REMOTE_DEVICE * PEAK_REMOTE_DEVICE_HANDLE
Definition peak_backend.h:391
PEAK_C_API PEAK_FirmwareUpdater_Destruct(PEAK_FIRMWARE_UPDATER_HANDLE firmwareUpdaterHandle)
Destroys the given firmware updater.
PEAK_C_API PEAK_FirmwareUpdateProgressObserver_UnregisterUpdateStepProgressChangedCallback(PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER_HANDLE firmwareUpdateProgressObserverHandle, PEAK_FIRMWARE_UPDATE_STEP_PROGRESS_CHANGED_CALLBACK_HANDLE callbackHandle)
Unregisters the update step progress changed callback with the given handle from the given firmware u...
PEAK_C_API PEAK_DataStream_GetPayloadSize(PEAK_DATA_STREAM_HANDLE dataStreamHandle, size_t *payloadSize)
Asks the given data stream for its payload size.
PEAK_C_API PEAK_Library_Close()
Closes the IDS peak genericAPI library and cleans up any resources that are still in use.
PEAK_C_API PEAK_Buffer_GetPayloadType(PEAK_BUFFER_HANDLE bufferHandle, PEAK_BUFFER_PAYLOAD_TYPE *payloadType)
Asks the given buffer for its payload type.
PEAK_DEVICE_RECONNECTED_CALLBACK * PEAK_DEVICE_RECONNECTED_CALLBACK_HANDLE
Definition peak_backend.h:566
PEAK_C_API PEAK_NodeMap_GetHasNode(PEAK_NODE_MAP_HANDLE nodeMapHandle, const char *nodeName, size_t nodeNameSize, PEAK_BOOL8 *hasNode)
Checks whether the given node map contains a node with the given name.
PEAK_C_API PEAK_SystemDescriptor_GetTLType(PEAK_SYSTEM_DESCRIPTOR_HANDLE systemDescriptorHandle, char *tlType, size_t *tlTypeSize)
Asks the given system descriptor for its TL type.
PEAK_C_API PEAK_Interface_UnregisterDeviceDisconnectedCallback(PEAK_INTERFACE_HANDLE interfaceHandle, PEAK_DEVICE_DISCONNECTED_CALLBACK_HANDLE callbackHandle)
Unregisters the device disconnected callback with the given handle from the given interface.
PEAK_C_API PEAK_DeviceDescriptor_GetTimestampTickFrequency(PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle, uint64_t *timestampTickFrequency)
Asks the given device descriptor for its timestamp tick frequency.
PEAK_C_API PEAK_Buffer_GetWidth(PEAK_BUFFER_HANDLE bufferHandle, size_t *width)
Asks the given buffer for its width.
PEAK_C_API PEAK_System_UnregisterInterfaceLostCallback(PEAK_SYSTEM_HANDLE systemHandle, PEAK_INTERFACE_LOST_CALLBACK_HANDLE callbackHandle)
Unregisters the interface-lost callback with the given handle from the given system.
PEAK_C_API PEAK_DataStream_GetNumBuffersAnnounced(PEAK_DATA_STREAM_HANDLE dataStreamHandle, size_t *numBuffersAnnounced)
Asks the given data stream for its number of announced buffers.
PEAK_C_API PEAK_PortURL_GetFileName(PEAK_PORT_URL_HANDLE portUrlHandle, char *fileName, size_t *fileNameSize)
Asks the given port URL for its file name.
PEAK_C_API PEAK_BufferPart_GetFormat(PEAK_BUFFER_PART_HANDLE bufferPartHandle, uint64_t *format)
Asks the given buffer part for its format.
PEAK_C_API PEAK_FloatNode_GetValidValues(PEAK_FLOAT_NODE_HANDLE floatNodeHandle, double *validValues, size_t *validValuesSize)
Asks the given float node for its valid values.
PEAK_C_API PEAK_IntegerNode_GetValue(PEAK_INTEGER_NODE_HANDLE integerNodeHandle, PEAK_NODE_CACHE_USE_POLICY cacheUsePolicy, int64_t *value)
Asks the given integer node for its value.
PEAK_DEVICE_FOUND_CALLBACK * PEAK_DEVICE_FOUND_CALLBACK_HANDLE
Definition peak_backend.h:564
struct PEAK_BUFFER_PART * PEAK_BUFFER_PART_HANDLE
Definition peak_backend.h:411
struct PEAK_SYSTEM * PEAK_SYSTEM_HANDLE
Definition peak_backend.h:371
PEAK_C_API PEAK_Module_GetNodeMap(PEAK_MODULE_HANDLE moduleHandle, size_t index, PEAK_NODE_MAP_HANDLE *nodeMapHandle)
Asks the given module for the node map with the given index.
PEAK_ACQUISITION_START_MODE_t
Definition peak_backend.h:45
@ PEAK_ACQUISITION_START_MODE_CUSTOM
Definition peak_backend.h:48
@ PEAK_ACQUISITION_START_MODE_DEFAULT
Definition peak_backend.h:46
void(PEAK_CALL_CONV * PEAK_FIRMWARE_UPDATE_STEP_PROGRESS_CHANGED_CALLBACK)(PEAK_FIRMWARE_UPDATE_STEP updateStep, double progressPercentage, void *context)
Definition peak_backend.h:601
PEAK_C_API PEAK_System_GetCTIFileName(PEAK_SYSTEM_HANDLE systemHandle, char *ctiFileName, size_t *ctiFileNameSize)
Asks the given system for its parent CTI's file name.
PEAK_FIRMWARE_UPDATE_STEP_PROGRESS_CHANGED_CALLBACK * PEAK_FIRMWARE_UPDATE_STEP_PROGRESS_CHANGED_CALLBACK_HANDLE
Definition peak_backend.h:605
PEAK_C_API PEAK_Node_RegisterChangedCallback(PEAK_NODE_HANDLE nodeHandle, PEAK_NODE_CHANGED_CALLBACK callback, void *callbackContext, PEAK_NODE_CHANGED_CALLBACK_HANDLE *callbackHandle)
Registers a callback signaling a change at the given node.
PEAK_C_API PEAK_Buffer_GetXOffset(PEAK_BUFFER_HANDLE bufferHandle, size_t *xOffset)
Asks the given buffer for its X offset.
PEAK_EVENT_TYPE_t
Definition peak_backend.h:174
@ PEAK_EVENT_TYPE_FEATURE_CUSTOM
Definition peak_backend.h:181
@ PEAK_EVENT_TYPE_FEATURE_INVALIDATE
Definition peak_backend.h:176
@ PEAK_EVENT_TYPE_FEATURE_CHANGE
Definition peak_backend.h:177
@ PEAK_EVENT_TYPE_REMOTE_DEVICE
Definition peak_backend.h:178
@ PEAK_EVENT_TYPE_ERROR
Definition peak_backend.h:175
@ PEAK_EVENT_TYPE_MODULE
Definition peak_backend.h:179
PEAK_ACQUISITION_STOP_MODE_t
Definition peak_backend.h:54
@ PEAK_ACQUISITION_STOP_MODE_CUSTOM
Definition peak_backend.h:58
@ PEAK_ACQUISITION_STOP_MODE_KILL
Definition peak_backend.h:56
@ PEAK_ACQUISITION_STOP_MODE_DEFAULT
Definition peak_backend.h:55
PEAK_C_API PEAK_Library_GetVersionPatch(uint32_t *libraryVersionPatch)
Asks for the patch component of the library version.
PEAK_C_API PEAK_DeviceDescriptor_GetUserDefinedName(PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle, char *userDefinedName, size_t *userDefinedNameSize)
Asks the given device descriptor for its user-defined name.
PEAK_C_API PEAK_Node_ToIntegerNode(PEAK_NODE_HANDLE nodeHandle, PEAK_INTEGER_NODE_HANDLE *integerNodeHandle)
Casts the given node to an integer node.
PEAK_C_API PEAK_FileAdapter_Delete(PEAK_FILE_ADAPTER_HANDLE fileAdapterHandle)
Deletes the given file.
PEAK_C_API PEAK_DataStream_GetKey(PEAK_DATA_STREAM_HANDLE dataStreamHandle, char *key, size_t *keySize)
Asks the given data stream for its key.
PEAK_CHARACTER_ENCODING_t
Definition peak_backend.h:101
@ PEAK_CHARACTER_ENCODING_ASCII
Definition peak_backend.h:102
@ PEAK_CHARACTER_ENCODING_UTF8
Definition peak_backend.h:103
PEAK_C_API PEAK_Event_GetID(PEAK_EVENT_HANDLE eventHandle, uint64_t *id)
Asks the given event for its ID.
PEAK_C_API PEAK_NodeMap_PollNodes(PEAK_NODE_MAP_HANDLE nodeMapHandle, int64_t elapsedTime_ms)
Tells the given node map to poll its nodes.
PEAK_C_API PEAK_System_GetModelName(PEAK_SYSTEM_HANDLE systemHandle, char *modelName, size_t *modelNameSize)
Asks the given system for its model name.
PEAK_C_API PEAK_BufferPart_GetFormatNamespace(PEAK_BUFFER_PART_HANDLE bufferPartHandle, uint64_t *formatNamespace)
Asks the given buffer part for its format namespace.
PEAK_C_API PEAK_BufferPart_GetDeliveredImageHeight(PEAK_BUFFER_PART_HANDLE bufferPartHandle, size_t *deliveredImageHeight)
Asks the given buffer part for its delivered image height.
PEAK_C_API PEAK_ModuleDescriptor_GetID(PEAK_MODULE_DESCRIPTOR_HANDLE moduleDescriptorHandle, char *id, size_t *idSize)
Asks the given module descriptor for its ID.
PEAK_C_API PEAK_BufferPart_GetInfo(PEAK_BUFFER_PART_HANDLE bufferPartHandle, int32_t infoCommand, int32_t *infoDataType, uint8_t *info, size_t *infoSize)
Asks the given buffer part for an information based on a specific command.
PEAK_C_API PEAK_Buffer_UpdateChunks(PEAK_BUFFER_HANDLE bufferHandle)
Tells the given buffer to update its chunks.
PEAK_C_API PEAK_Device_GetRemoteDevice(PEAK_DEVICE_HANDLE deviceHandle, PEAK_REMOTE_DEVICE_HANDLE *remoteDeviceHandle)
Asks the given device for its remote device.
PEAK_C_API PEAK_FirmwareUpdateProgressObserver_Destruct(PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER_HANDLE firmwareUpdateProgressObserverHandle)
Destroys the given firmware update progress observer.
PEAK_C_API PEAK_IntegerNode_ToNode(PEAK_INTEGER_NODE_HANDLE integerNodeHandle, PEAK_NODE_HANDLE *nodeHandle)
Casts the given integer node to a node.
PEAK_C_API PEAK_StringNode_GetValue(PEAK_STRING_NODE_HANDLE stringNodeHandle, PEAK_NODE_CACHE_USE_POLICY cacheUsePolicy, char *value, size_t *valueSize)
Asks the given string node for its value.
PEAK_C_API PEAK_InterfaceDescriptor_GetInfo(PEAK_INTERFACE_DESCRIPTOR_HANDLE interfaceDescriptorHandle, int32_t infoCommand, int32_t *infoDataType, uint8_t *info, size_t *infoSize)
Asks the given interface descriptor for an information based on a specific command.
PEAK_C_API PEAK_Port_GetNumURLs(PEAK_PORT_HANDLE portHandle, size_t *numUrls)
Asks the given port for its number of URLs.
PEAK_C_API PEAK_EventController_GetEventDataMaxSize(PEAK_EVENT_CONTROLLER_HANDLE eventControllerHandle, size_t *eventDataMaxSize)
Asks the event controller for the maximum size of an event's data.
void(PEAK_CALL_CONV * PEAK_NODE_CHANGED_CALLBACK)(PEAK_NODE_HANDLE changedNode, void *context)
Definition peak_backend.h:578
PEAK_C_API PEAK_System_GetCharacterEncoding(PEAK_SYSTEM_HANDLE systemHandle, PEAK_CHARACTER_ENCODING *characterEncoding)
Asks the given system for its character encoding.
struct PEAK_FIRMWARE_UPDATE_INFORMATION * PEAK_FIRMWARE_UPDATE_INFORMATION_HANDLE
Definition peak_backend.h:495
PEAK_C_API PEAK_FloatNode_GetUnit(PEAK_FLOAT_NODE_HANDLE floatNodeHandle, char *unit, size_t *unitSize)
Asks the given float node for its unit.
PEAK_C_API PEAK_Node_GetName(PEAK_NODE_HANDLE nodeHandle, char *name, size_t *nameSize)
Asks the given node for its name.
PEAK_C_API PEAK_PortURL_GetFileSchemaVersionMinor(PEAK_PORT_URL_HANDLE portUrlHandle, int32_t *fileSchemaVersionMinor)
Asks the given port URL for the minor component of its file schema version.
PEAK_C_API PEAK_Node_GetNamespace(PEAK_NODE_HANDLE nodeHandle, PEAK_NODE_NAMESPACE *_namespace)
Asks the given node for its namespace.
PEAK_C_API PEAK_NodeMap_StoreToFile(PEAK_NODE_MAP_HANDLE nodeMapHandle, const char *filePath, size_t filePathSize)
Tells the given node map to store the values of its streamable nodes to a file at the given file path...
PEAK_C_API PEAK_FirmwareUpdateProgressObserver_Construct(PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER_HANDLE *firmwareUpdateProgressObserverHandle)
Creates a firmware update progress observer.
PEAK_C_API PEAK_EventController_GetInfo(PEAK_EVENT_CONTROLLER_HANDLE eventControllerHandle, int32_t infoCommand, int32_t *infoDataType, uint8_t *info, size_t *infoSize)
Asks the given event controller for an information based on a specific command.
PEAK_C_API PEAK_StringNode_ToNode(PEAK_STRING_NODE_HANDLE stringNodeHandle, PEAK_NODE_HANDLE *nodeHandle)
Casts the given string node to a node.
struct PEAK_FLOAT_NODE * PEAK_FLOAT_NODE_HANDLE
Definition peak_backend.h:443
PEAK_C_API PEAK_System_GetVendorName(PEAK_SYSTEM_HANDLE systemHandle, char *vendorName, size_t *vendorNameSize)
Asks the given system for its vendor name.
PEAK_C_API PEAK_BufferChunk_GetBasePtr(PEAK_BUFFER_CHUNK_HANDLE bufferChunkHandle, void **basePtr)
Asks the given buffer chunk for its base pointer.
PEAK_C_API PEAK_Node_GetSelectedNode(PEAK_NODE_HANDLE nodeHandle, size_t index, PEAK_NODE_HANDLE *selectedNodeHandle)
Asks the given node for the selected node with the given index.
PEAK_C_API PEAK_DataStream_AnnounceBuffer(PEAK_DATA_STREAM_HANDLE dataStreamHandle, void *buffer, size_t bufferSize, void *userPtr, PEAK_BUFFER_REVOCATION_CALLBACK revocationCallback, void *callbackContext, PEAK_BUFFER_HANDLE *bufferHandle)
Announces the given buffer at the given data stream.
PEAK_C_API PEAK_FloatNode_GetMinimum(PEAK_FLOAT_NODE_HANDLE floatNodeHandle, double *minimum)
Asks the given float node for its minimum.
PEAK_DEVICE_LIST_CHANGED_CALLBACK * PEAK_DEVICE_LIST_CHANGED_CALLBACK_HANDLE
Definition peak_backend.h:572
PEAK_C_API PEAK_DataStream_GetNumBuffersQueued(PEAK_DATA_STREAM_HANDLE dataStreamHandle, size_t *numBuffersQueued)
Asks the given data stream for its number of queued buffers.
PEAK_C_API PEAK_DataStream_FlushPendingKillWaits(PEAK_DATA_STREAM_HANDLE dataStreamHandle)
Flushes the KillWait queue.
int32_t PEAK_NODE_CACHE_USE_POLICY
Definition peak_backend.h:240
PEAK_C_API PEAK_Node_ToEnumerationNode(PEAK_NODE_HANDLE nodeHandle, PEAK_ENUMERATION_NODE_HANDLE *enumerationNodeHandle)
Casts the given node to an enumeration node.
PEAK_C_API PEAK_RegisterNode_GetAddress(PEAK_REGISTER_NODE_HANDLE registerNodeHandle, uint64_t *address)
Asks the given register node for its address.
PEAK_C_API PEAK_Node_GetDescription(PEAK_NODE_HANDLE nodeHandle, char *description, size_t *descriptionSize)
Asks the given node for its description.
PEAK_C_API PEAK_CategoryNode_GetSubNode(PEAK_CATEGORY_NODE_HANDLE categoryNodeHandle, size_t index, PEAK_NODE_HANDLE *nodeHandle)
Asks the given category node for the sub node with the given index.
PEAK_C_API PEAK_Buffer_GetDeliveredDataSize(PEAK_BUFFER_HANDLE bufferHandle, size_t *deliveredDataSize)
Asks the given buffer for its delivered data size.
PEAK_C_API PEAK_Buffer_GetInfo(PEAK_BUFFER_HANDLE bufferHandle, int32_t infoCommand, int32_t *infoDataType, uint8_t *info, size_t *infoSize)
Asks the given buffer for an information based on a specific command.
PEAK_NODE_ACCESS_STATUS_t
Definition peak_backend.h:216
@ PEAK_NODE_ACCESS_STATUS_READ_WRITE
Definition peak_backend.h:221
@ PEAK_NODE_ACCESS_STATUS_NOT_IMPLEMENTED
Definition peak_backend.h:217
@ PEAK_NODE_ACCESS_STATUS_READ_ONLY
Definition peak_backend.h:220
@ PEAK_NODE_ACCESS_STATUS_NOT_AVAILABLE
Definition peak_backend.h:218
@ PEAK_NODE_ACCESS_STATUS_WRITE_ONLY
Definition peak_backend.h:219
PEAK_NODE_REPRESENTATION_t
Definition peak_backend.h:270
@ PEAK_NODE_REPRESENTATION_LINEAR
Definition peak_backend.h:271
@ PEAK_NODE_REPRESENTATION_IP4_ADDRESS
Definition peak_backend.h:276
@ PEAK_NODE_REPRESENTATION_MAC_ADDRESS
Definition peak_backend.h:277
@ PEAK_NODE_REPRESENTATION_HEX_NUMBER
Definition peak_backend.h:275
@ PEAK_NODE_REPRESENTATION_LOGARITHMIC
Definition peak_backend.h:272
@ PEAK_NODE_REPRESENTATION_BOOLEAN
Definition peak_backend.h:273
@ PEAK_NODE_REPRESENTATION_PURE_NUMBER
Definition peak_backend.h:274
PEAK_C_API PEAK_Port_GetTLType(PEAK_PORT_HANDLE portHandle, char *tlType, size_t *tlTypeSize)
Asks the given port for its TL type.
PEAK_DEVICE_INFORMATION_ROLE_t
Definition peak_backend.h:147
@ PEAK_DEVICE_INFORMATION_ROLE_CUSTOM
Definition peak_backend.h:159
@ PEAK_DEVICE_INFORMATION_ROLE_DISPLAY_NAME
Definition peak_backend.h:152
@ PEAK_DEVICE_INFORMATION_ROLE_ACCESS_STATUS
Definition peak_backend.h:153
@ PEAK_DEVICE_INFORMATION_ROLE_VENDOR_NAME
Definition peak_backend.h:149
@ PEAK_DEVICE_INFORMATION_ROLE_SERIAL_NUMBER
Definition peak_backend.h:155
@ PEAK_DEVICE_INFORMATION_ROLE_VERSION
Definition peak_backend.h:156
@ PEAK_DEVICE_INFORMATION_ROLE_TL_TYPE
Definition peak_backend.h:151
@ PEAK_DEVICE_INFORMATION_ROLE_MODEL_NAME
Definition peak_backend.h:150
@ PEAK_DEVICE_INFORMATION_ROLE_USER_DEFINED_NAME
Definition peak_backend.h:154
@ PEAK_DEVICE_INFORMATION_ROLE_ID
Definition peak_backend.h:148
@ PEAK_DEVICE_INFORMATION_ROLE_TIMESTAMP_TICK_FREQUENCY
Definition peak_backend.h:157
PEAK_NODE_DISPLAY_NOTATION_t
Definition peak_backend.h:244
@ PEAK_NODE_DISPLAY_NOTATION_FIXED
Definition peak_backend.h:246
@ PEAK_NODE_DISPLAY_NOTATION_SCIENTIFIC
Definition peak_backend.h:247
@ PEAK_NODE_DISPLAY_NOTATION_AUTOMATIC
Definition peak_backend.h:245
PEAK_C_API PEAK_Port_GetIsReadable(PEAK_PORT_HANDLE portHandle, PEAK_BOOL8 *isReadable)
Asks the given port whether it is readable.
PEAK_C_API PEAK_Device_GetNumDataStreams(PEAK_DEVICE_HANDLE deviceHandle, size_t *numDataStreams)
Asks the given device for its number of data streams.
PEAK_C_API PEAK_DeviceDescriptor_GetVersion(PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle, char *version, size_t *versionSize)
Asks the given device descriptor for its version.
PEAK_C_API PEAK_ProducerLibrary_GetSystem(PEAK_PRODUCER_LIBRARY_HANDLE producerLibraryHandle, PEAK_SYSTEM_DESCRIPTOR_HANDLE *systemDescriptorHandle)
Asks the given producer library for its system descriptor.
PEAK_C_API PEAK_Buffer_GetPixelFormatNamespace(PEAK_BUFFER_HANDLE bufferHandle, PEAK_PIXEL_FORMAT_NAMESPACE *pixelFormatNamespace)
Asks the given buffer for its pixel format namespace.
PEAK_C_API PEAK_NodeMap_GetNumNodes(PEAK_NODE_MAP_HANDLE nodeMapHandle, size_t *numNodes)
Asks the given node map for its number of nodes.
PEAK_C_API PEAK_DataStream_WaitForFinishedBuffer(PEAK_DATA_STREAM_HANDLE dataStreamHandle, uint64_t timeout_ms, PEAK_BUFFER_HANDLE *bufferHandle)
Blocking wait for a finished Buffer.
PEAK_C_API PEAK_FirmwareUpdateProgressObserver_UnregisterUpdateStepFinishedCallback(PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER_HANDLE firmwareUpdateProgressObserverHandle, PEAK_FIRMWARE_UPDATE_STEP_FINISHED_CALLBACK_HANDLE callbackHandle)
Unregisters the update step finished callback with the given handle from the given firmware update pr...
PEAK_C_API PEAK_SystemDescriptor_OpenSystem(PEAK_SYSTEM_DESCRIPTOR_HANDLE systemDescriptorHandle, PEAK_SYSTEM_HANDLE *systemHandle)
Opens the system being associated with the given system descriptor.
PEAK_C_API PEAK_FirmwareUpdateProgressObserver_RegisterUpdateStepStartedCallback(PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER_HANDLE firmwareUpdateProgressObserverHandle, PEAK_FIRMWARE_UPDATE_STEP_STARTED_CALLBACK callback, void *callbackContext, PEAK_FIRMWARE_UPDATE_STEP_STARTED_CALLBACK_HANDLE *callbackHandle)
Registers a callback signaling a started update step at the given firmware update progress observer.
PEAK_C_API PEAK_EventController_FlushPendingKillWaits(PEAK_EVENT_CONTROLLER_HANDLE eventControllerHandle)
Flushes the KillWait queue.
PEAK_C_API PEAK_DataStream_GetIsGrabbing(PEAK_DATA_STREAM_HANDLE dataStreamHandle, PEAK_BOOL8 *isGrabbing)
Asks the given data stream whether it is grabbing.
PEAK_C_API PEAK_EnumerationNode_TryFindEntryByValue(PEAK_ENUMERATION_NODE_HANDLE enumerationNodeHandle, int64_t value, PEAK_ENUMERATION_ENTRY_NODE_HANDLE *enumerationEntryNodeHandle)
Tells the given enumeration node to try to find an entry with the given value.
PEAK_C_API PEAK_Port_GetInfo(PEAK_PORT_HANDLE portHandle, int32_t infoCommand, int32_t *infoDataType, uint8_t *info, size_t *infoSize)
Asks the given port for an information based on a specific command.
PEAK_C_API PEAK_Node_GetNumInvalidatingNodes(PEAK_NODE_HANDLE nodeHandle, size_t *numInvalidatingNodes)
Asks the given node for its number of invalidating nodes.
PEAK_C_API PEAK_Port_GetModelName(PEAK_PORT_HANDLE portHandle, char *modelName, size_t *modelNameSize)
Asks the given port for its model name.
struct PEAK_FIRMWARE_UPDATER * PEAK_FIRMWARE_UPDATER_HANDLE
Definition peak_backend.h:491
PEAK_C_API PEAK_EnumerationNode_GetHasEntryBySymbolicValue(PEAK_ENUMERATION_NODE_HANDLE enumerationNodeHandle, const char *symbolicValue, size_t symbolicValueSize, PEAK_BOOL8 *hasEntry)
Asks the given enumeration node whether it has an entry with the given symbolic value.
PEAK_C_API PEAK_FirmwareUpdateInformation_GetVersionStyle(PEAK_FIRMWARE_UPDATE_INFORMATION_HANDLE firmwareUpdateInformationHandle, PEAK_FIRMWARE_UPDATE_VERSION_STYLE *versionStyle)
Asks the given firmware update information for its version style.
PEAK_C_API PEAK_DataStream_RevokeBuffer(PEAK_DATA_STREAM_HANDLE dataStreamHandle, PEAK_BUFFER_HANDLE bufferHandle)
Tells the given data stream to revoke the given buffer.
PEAK_C_API PEAK_NodeMap_FindNode(PEAK_NODE_MAP_HANDLE nodeMapHandle, const char *nodeName, size_t nodeNameSize, PEAK_NODE_HANDLE *nodeHandle)
Tells the given node map to find a node with the given name.
PEAK_C_API PEAK_Node_ToCategoryNode(PEAK_NODE_HANDLE nodeHandle, PEAK_CATEGORY_NODE_HANDLE *categoryNodeHandle)
Casts the given node to a category node.
int32_t PEAK_FIRMWARE_UPDATE_VERSION_STYLE
Definition peak_backend.h:212
PEAK_C_API PEAK_PortURL_GetParentPort(PEAK_PORT_URL_HANDLE portUrlHandle, PEAK_PORT_HANDLE *portHandle)
Asks the given port URL for its parent port.
PEAK_C_API PEAK_Buffer_GetHasNewData(PEAK_BUFFER_HANDLE bufferHandle, PEAK_BOOL8 *hasNewData)
Asks the given buffer whether it has new data since the last delivery.
PEAK_C_API PEAK_Buffer_GetDeliveredChunkPayloadSize(PEAK_BUFFER_HANDLE bufferHandle, size_t *deliveredChunkPayloadSize)
Asks the given buffer for its delivered chunk payload size.
PEAK_C_API PEAK_System_GetParentLibrary(PEAK_SYSTEM_HANDLE systemHandle, PEAK_PRODUCER_LIBRARY_HANDLE *producerLibraryHandle)
Asks the given system for its parent library.
int32_t PEAK_ACQUISITION_START_MODE
Definition peak_backend.h:50
PEAK_C_API PEAK_Interface_RegisterDeviceFoundCallback(PEAK_INTERFACE_HANDLE interfaceHandle, PEAK_DEVICE_FOUND_CALLBACK callback, void *callbackContext, PEAK_DEVICE_FOUND_CALLBACK_HANDLE *callbackHandle)
Registers a callback signaling a found device at the given interface.
PEAK_C_API PEAK_RegisterNode_ToNode(PEAK_REGISTER_NODE_HANDLE registerNodeHandle, PEAK_NODE_HANDLE *nodeHandle)
Casts the given register node to a node.
PEAK_C_API PEAK_DeviceDescriptor_GetParentInterface(PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle, PEAK_INTERFACE_HANDLE *interfaceHandle)
Asks the given device descriptor for its parent interface.
PEAK_C_API PEAK_NodeMap_GetHasBufferSupportedChunks(PEAK_NODE_MAP_HANDLE nodeMapHandle, PEAK_BUFFER_HANDLE bufferHandle, PEAK_BOOL8 *hasSupportedChunks)
Checks if the buffer contains chunks corresponding to the node map.
PEAK_C_API PEAK_EnumerationNode_SetCurrentEntry(PEAK_ENUMERATION_NODE_HANDLE enumerationNodeHandle, PEAK_ENUMERATION_ENTRY_NODE_HANDLE enumerationEntryNodeHandle)
Tells the given enumeration node to set its current entry to the given entry.
PEAK_C_API PEAK_SystemDescriptor_GetCharacterEncoding(PEAK_SYSTEM_DESCRIPTOR_HANDLE systemDescriptorHandle, PEAK_CHARACTER_ENCODING *characterEncoding)
Asks the given system descriptor for its character encoding.
int8_t PEAK_BOOL8
Definition peak_backend.h:41
PEAK_C_API PEAK_PortURL_GetFileRegisterAddress(PEAK_PORT_URL_HANDLE portUrlHandle, uint64_t *fileRegisterAddress)
Asks the given port URL for its file register address.
PEAK_C_API PEAK_DataStreamDescriptor_ToModuleDescriptor(PEAK_DATA_STREAM_DESCRIPTOR_HANDLE dataStreamDescriptorHandle, PEAK_MODULE_DESCRIPTOR_HANDLE *moduleDescriptorHandle)
Casts the given data stream descriptor to a module descriptor.
PEAK_FIRMWARE_UPDATE_FAILED_CALLBACK * PEAK_FIRMWARE_UPDATE_FAILED_CALLBACK_HANDLE
Definition peak_backend.h:619
PEAK_C_API PEAK_EnumerationNode_GetEntry(PEAK_ENUMERATION_NODE_HANDLE enumerationNodeHandle, size_t index, PEAK_ENUMERATION_ENTRY_NODE_HANDLE *enumerationEntryNodeHandle)
Asks the given enumeration node for the entry with the given index.
int32_t PEAK_ENDIANNESS
Definition peak_backend.h:170
int32_t PEAK_FIRMWARE_UPDATE_STEP
Definition peak_backend.h:204
PEAK_C_API PEAK_Device_Destruct(PEAK_DEVICE_HANDLE deviceHandle)
Delete the given device.
PEAK_C_API PEAK_FirmwareUpdater_CollectFirmwareUpdateInformation(PEAK_FIRMWARE_UPDATER_HANDLE firmwareUpdaterHandle, const char *gufPath, size_t gufPathSize, PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle)
Tells the given firmware updater to collect all update information fitting to the given device.
struct PEAK_NODE_MAP * PEAK_NODE_MAP_HANDLE
Definition peak_backend.h:423
PEAK_C_API PEAK_System_GetCTIFullPath(PEAK_SYSTEM_HANDLE systemHandle, char *ctiFullPath, size_t *ctiFullPathSize)
Asks the given system for its parent CTI's full path.
PEAK_C_API PEAK_FirmwareUpdateProgressObserver_UnregisterUpdateFailedCallback(PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER_HANDLE firmwareUpdateProgressObserverHandle, PEAK_FIRMWARE_UPDATE_FAILED_CALLBACK_HANDLE callbackHandle)
Unregisters the update failed callback with the given handle from the given firmware update progress ...
PEAK_C_API PEAK_DeviceDescriptor_RemoveInformationRoleFromMonitoring(PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle, PEAK_DEVICE_INFORMATION_ROLE informationRole)
Tells the given device descriptor to remove the given information role from the monitoring.
int32_t PEAK_RETURN_CODE
Definition peak_backend.h:353
int32_t PEAK_NODE_CACHING_MODE
Definition peak_backend.h:232
PEAK_C_API PEAK_Port_GetVendorName(PEAK_PORT_HANDLE portHandle, char *vendorName, size_t *vendorNameSize)
Asks the given port for its vendor name.
PEAK_C_API PEAK_Device_GetParentInterface(PEAK_DEVICE_HANDLE deviceHandle, PEAK_INTERFACE_HANDLE *interfaceHandle)
Asks the given device for its parent interface.
PEAK_C_API PEAK_EnumerationEntryNode_GetSymbolicValue(PEAK_ENUMERATION_ENTRY_NODE_HANDLE enumerationEntryNodeHandle, char *symbolicValue, size_t *symbolicValueSize)
Asks the given enumeration entry node for its symbolic value.
PEAK_C_API PEAK_DeviceDescriptor_GetInfo(PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle, int32_t infoCommand, int32_t *infoDataType, uint8_t *info, size_t *infoSize)
Asks the given device descriptor for an information based on a specific command.
PEAK_C_API PEAK_DataStream_GetNumBuffersDelivered(PEAK_DATA_STREAM_HANDLE dataStreamHandle, uint64_t *numBuffersDelivered)
Asks the given data stream for its number of delivered buffers.
int32_t PEAK_PORT_URL_SCHEME
Definition peak_backend.h:327
PEAK_C_API PEAK_EnvironmentInspector_UpdateCTIPaths()
Collects the paths to the CTIs installed on the system.
struct PEAK_ENUMERATION_ENTRY_NODE * PEAK_ENUMERATION_ENTRY_NODE_HANDLE
Definition peak_backend.h:463
PEAK_C_API PEAK_Device_GetUserDefinedName(PEAK_DEVICE_HANDLE deviceHandle, char *userDefinedName, size_t *userDefinedNameSize)
Asks the given device for its user-defined name.
PEAK_C_API PEAK_DeviceDescriptor_OpenDevice(PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle, PEAK_DEVICE_ACCESS_TYPE accessType, PEAK_DEVICE_HANDLE *deviceHandle)
Opens the device being associated with the given interface descriptor for the given access type.
void(PEAK_CALL_CONV * PEAK_DEVICE_LIST_CHANGED_CALLBACK)(void *context)
Definition peak_backend.h:562
PEAK_C_API PEAK_DataStreamDescriptor_GetKey(PEAK_DATA_STREAM_DESCRIPTOR_HANDLE dataStreamDescriptorHandle, char *key, size_t *keySize)
Asks the given data stream descriptor for its key.
PEAK_C_API PEAK_FloatNode_GetDisplayPrecision(PEAK_FLOAT_NODE_HANDLE floatNodeHandle, int64_t *displayPrecision)
Asks the given float node for its display precision.
PEAK_C_API PEAK_IntegerNode_GetValidValues(PEAK_INTEGER_NODE_HANDLE integerNodeHandle, int64_t *validValues, size_t *validValuesSize)
Asks the given integer node for its valid values.
PEAK_C_API PEAK_IntegerNode_SetValue(PEAK_INTEGER_NODE_HANDLE integerNodeHandle, int64_t value)
Tells the given integer node to set the given value.
static const uint64_t PEAK_INFINITE_NUMBER
The constant defining an infinite number of buffers.
Definition peak_backend.h:356
PEAK_C_API PEAK_BufferPart_GetYOffset(PEAK_BUFFER_PART_HANDLE bufferPartHandle, size_t *yOffset)
Asks the given buffer part for its Y offset.
PEAK_C_API PEAK_EnumerationNode_FindEntryBySymbolicValue(PEAK_ENUMERATION_NODE_HANDLE enumerationNodeHandle, const char *symbolicValue, size_t symbolicValueSize, PEAK_ENUMERATION_ENTRY_NODE_HANDLE *enumerationEntryNodeHandle)
Tells the given enumeration node to find an entry with the given symbolic value.
PEAK_C_API PEAK_Interface_RegisterDeviceDisconnectedCallback(PEAK_INTERFACE_HANDLE interfaceHandle, PEAK_DEVICE_DISCONNETED_CALLBACK callback, void *callbackContext, PEAK_DEVICE_DISCONNECTED_CALLBACK_HANDLE *callbackHandle)
Registers a callback signaling a disconnected device that is now waiting to be reconnected at the giv...
PEAK_C_API PEAK_Port_Write(PEAK_PORT_HANDLE portHandle, uint64_t address, const uint8_t *bytesToWrite, size_t bytesToWriteSize)
Tells the given port to write the given amount of bytes at the given address.
PEAK_C_API PEAK_FirmwareUpdateInformation_GetUserSetPersistence(PEAK_FIRMWARE_UPDATE_INFORMATION_HANDLE firmwareUpdateInformationHandle, PEAK_FIRMWARE_UPDATE_PERSISTENCE *userSetPersistence)
Asks the given firmware update information for its user set persistence.
PEAK_C_API PEAK_Node_GetNumInvalidatedNodes(PEAK_NODE_HANDLE nodeHandle, size_t *numInvalidatedNodes)
Asks the given node for its number of invalidated nodes.
int32_t PEAK_ACQUISITION_STOP_MODE
Definition peak_backend.h:60
void(PEAK_CALL_CONV * PEAK_DEVICE_RECONNECTED_CALLBACK)(PEAK_DEVICE_DESCRIPTOR_HANDLE reconnectedDevice, PEAK_DEVICE_RECONNECT_INFORMATION reconnectInformation, void *context)
Definition peak_backend.h:553
PEAK_C_API PEAK_Buffer_GetHeight(PEAK_BUFFER_HANDLE bufferHandle, size_t *height)
Asks the given buffer for its height.
PEAK_C_API PEAK_System_GetTLType(PEAK_SYSTEM_HANDLE systemHandle, char *tlType, size_t *tlTypeSize)
Asks the given system for its TL type.
PEAK_C_API PEAK_Device_GetAccessStatus(PEAK_DEVICE_HANDLE deviceHandle, PEAK_DEVICE_ACCESS_STATUS *accessStatus)
Asks the given device for its access status.
void(PEAK_CALL_CONV * PEAK_DEVICE_FOUND_CALLBACK)(PEAK_DEVICE_DESCRIPTOR_HANDLE foundDevice, void *context)
Definition peak_backend.h:550
PEAK_C_API PEAK_Port_GetIsWritable(PEAK_PORT_HANDLE portHandle, PEAK_BOOL8 *isWritable)
Asks the given port whether it is writable.
PEAK_C_API PEAK_EnumerationNode_GetNumEntries(PEAK_ENUMERATION_NODE_HANDLE enumerationNodeHandle, size_t *numEntries)
Asks the given enumeration node for its number of entries.
PEAK_C_API PEAK_BufferPart_GetBasePtr(PEAK_BUFFER_PART_HANDLE bufferPartHandle, void **basePtr)
Asks the given buffer part for its base pointer.
PEAK_C_API PEAK_Node_GetIsDeprecated(PEAK_NODE_HANDLE nodeHandle, PEAK_BOOL8 *isDeprecated)
Asks the given node whether it is deprecated.
struct PEAK_CATEGORY_NODE * PEAK_CATEGORY_NODE_HANDLE
Definition peak_backend.h:455
PEAK_ENDIANNESS_t
Definition peak_backend.h:165
@ PEAK_ENDIANNESS_UNKNOWN
Definition peak_backend.h:166
@ PEAK_ENDIANNESS_LITTLE
Definition peak_backend.h:167
@ PEAK_ENDIANNESS_BIG
Definition peak_backend.h:168
PEAK_C_API PEAK_InterfaceDescriptor_GetDisplayName(PEAK_INTERFACE_DESCRIPTOR_HANDLE interfaceDescriptorHandle, char *displayName, size_t *displayNameSize)
Asks the given interface descriptor for its display name.
PEAK_C_API PEAK_Library_GetVersionMinor(uint32_t *libraryVersionMinor)
Asks for the minor component of the library version.
PEAK_C_API PEAK_System_GetInterface(PEAK_SYSTEM_HANDLE systemHandle, size_t index, PEAK_INTERFACE_DESCRIPTOR_HANDLE *interfaceDescriptorHandle)
Asks the given system for the interface descriptor with the given index.
struct PEAK_REGISTER_NODE * PEAK_REGISTER_NODE_HANDLE
Definition peak_backend.h:451
PEAK_C_API PEAK_Interface_RegisterDeviceReconnectedCallback(PEAK_INTERFACE_HANDLE interfaceHandle, PEAK_DEVICE_RECONNECTED_CALLBACK callback, void *callbackContext, PEAK_DEVICE_RECONNECTED_CALLBACK_HANDLE *callbackHandle)
Registers a callback signaling a reconnected device at the given interface.
PEAK_C_API PEAK_Node_GetIsStreamable(PEAK_NODE_HANDLE nodeHandle, PEAK_BOOL8 *isStreamable)
Asks the given node whether it is streamable.
PEAK_C_API PEAK_DeviceDescriptor_GetIsOpenableExclusive(PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle, PEAK_BOOL8 *isOpenable)
Asks the given device descriptor whether the device can be opened with exclusive access.
PEAK_C_API PEAK_Interface_GetDevice(PEAK_INTERFACE_HANDLE interfaceHandle, size_t index, PEAK_DEVICE_DESCRIPTOR_HANDLE *deviceDescriptorHandle)
Asks the given interface for the device descriptor with the given index.
int32_t PEAK_PIXEL_FORMAT_NAMESPACE
Definition peak_backend.h:316
PEAK_C_API PEAK_BufferPart_GetXPadding(PEAK_BUFFER_PART_HANDLE bufferPartHandle, size_t *xPadding)
Asks the given buffer part for its X padding.
PEAK_C_API PEAK_PortURL_GetFileSize(PEAK_PORT_URL_HANDLE portUrlHandle, uint64_t *fileSize)
Asks the given port URL for its file size.
PEAK_C_API PEAK_Interface_UnregisterDeviceLostCallback(PEAK_INTERFACE_HANDLE interfaceHandle, PEAK_DEVICE_LOST_CALLBACK_HANDLE callbackHandle)
Unregisters the device-lost callback with the given handle from the given interface.
int32_t PEAK_DATA_STREAM_FLUSH_MODE
Definition peak_backend.h:118
PEAK_C_API PEAK_CommandNode_WaitUntilDone(PEAK_COMMAND_NODE_HANDLE commandNodeHandle, uint64_t waitTimeout_ms)
Waits (blocking) until the previously executed command is finished, i.e. PEAK_CommandNode_GetIsDone()...
PEAK_C_API PEAK_NodeMap_UpdateChunkNodes(PEAK_NODE_MAP_HANDLE nodeMapHandle, PEAK_BUFFER_HANDLE bufferHandle)
Updates chunk information in the node map.
PEAK_C_API PEAK_CategoryNode_ToNode(PEAK_CATEGORY_NODE_HANDLE categoryNodeHandle, PEAK_NODE_HANDLE *nodeHandle)
Casts the given category node to a node.
PEAK_FIRMWARE_UPDATE_VERSION_STYLE_t
Definition peak_backend.h:208
@ PEAK_FIRMWARE_UPDATE_VERSION_STYLE_SEMANTIC
Definition peak_backend.h:210
@ PEAK_FIRMWARE_UPDATE_VERSION_STYLE_DOTTED
Definition peak_backend.h:209
PEAK_NODE_INCREMENT_TYPE_t
Definition peak_backend.h:253
@ PEAK_NODE_INCREMENT_TYPE_NO_INCREMENT
Definition peak_backend.h:254
@ PEAK_NODE_INCREMENT_TYPE_LIST_INCREMENT
Definition peak_backend.h:256
@ PEAK_NODE_INCREMENT_TYPE_FIXED_INCREMENT
Definition peak_backend.h:255
PEAK_C_API PEAK_Buffer_ToModule(PEAK_BUFFER_HANDLE bufferHandle, PEAK_MODULE_HANDLE *moduleHandle)
Casts the given buffer to a module.
void(PEAK_CALL_CONV * PEAK_INTERFACE_LOST_CALLBACK)(const char *lostInterfaceId, size_t lostInterfaceIdSize, void *context)
Definition peak_backend.h:506
PEAK_C_API PEAK_PortURL_GetFileVersionSubminor(PEAK_PORT_URL_HANDLE portUrlHandle, int32_t *fileVersionSubminor)
Asks the given port URL for the subminor component of its file version.
PEAK_C_API PEAK_Device_GetInfo(PEAK_DEVICE_HANDLE deviceHandle, int32_t infoCommand, int32_t *infoDataType, uint8_t *info, size_t *infoSize)
Asks the given device for an information based on a specific command.
PEAK_C_API PEAK_DeviceDescriptor_IsInformationRoleMonitored(PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle, PEAK_DEVICE_INFORMATION_ROLE informationRole, PEAK_BOOL8 *isInformationRoleMonitored)
Asks the given device descriptor whether the given information role is monitored.
PEAK_C_API PEAK_Buffer_GetFileName(PEAK_BUFFER_HANDLE bufferHandle, char *fileName, size_t *fileNameSize)
Asks the given buffer for its file name.
PEAK_C_API PEAK_DeviceDescriptor_GetVendorName(PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle, char *vendorName, size_t *vendorNameSize)
Asks the given device descriptor for its vendor name.
PEAK_C_API PEAK_System_GetVersion(PEAK_SYSTEM_HANDLE systemHandle, char *version, size_t *versionSize)
Asks the given system for its version.
PEAK_C_API PEAK_CommandNode_GetIsDone(PEAK_COMMAND_NODE_HANDLE commandNodeHandle, PEAK_BOOL8 *isDone)
Asks the given command node whether its associated command is done.
PEAK_C_API PEAK_SystemDescriptor_GetInfo(PEAK_SYSTEM_DESCRIPTOR_HANDLE systemDescriptorHandle, int32_t infoCommand, int32_t *infoDataType, uint8_t *info, size_t *infoSize)
Asks the given system descriptor for an information based on a specific command.
PEAK_C_API PEAK_ProducerLibrary_GetKey(PEAK_PRODUCER_LIBRARY_HANDLE producerLibraryHandle, char *key, size_t *keySize)
Asks the given producer library for its key.
PEAK_C_API PEAK_DataStream_GetID(PEAK_DATA_STREAM_HANDLE dataStreamHandle, char *id, size_t *idSize)
Asks the given data stream for its ID.
PEAK_C_API PEAK_IntegerNode_GetIncrement(PEAK_INTEGER_NODE_HANDLE integerNodeHandle, int64_t *increment)
Asks the given integer node for its increment.
PEAK_C_API PEAK_IntegerNode_GetIncrementType(PEAK_INTEGER_NODE_HANDLE integerNodeHandle, PEAK_NODE_INCREMENT_TYPE *incrementType)
Asks the given integer node for its increment type.
PEAK_C_API PEAK_DataStreamDescriptor_GetParentDevice(PEAK_DATA_STREAM_DESCRIPTOR_HANDLE dataStreamDescriptorHandle, PEAK_DEVICE_HANDLE *deviceHandle)
Asks the given data stream descriptor for its parent device.
PEAK_C_API PEAK_Node_GetAccessStatus(PEAK_NODE_HANDLE nodeHandle, PEAK_NODE_ACCESS_STATUS *accessStatus)
Asks the given node for its access status.
PEAK_FIRMWARE_UPDATE_STEP_STARTED_CALLBACK * PEAK_FIRMWARE_UPDATE_STEP_STARTED_CALLBACK_HANDLE
Definition peak_backend.h:599
PEAK_C_API PEAK_FirmwareUpdater_UpdateDevice(PEAK_FIRMWARE_UPDATER_HANDLE firmwareUpdaterHandle, PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle, PEAK_FIRMWARE_UPDATE_INFORMATION_HANDLE firmwareUpdateInformationHandle, PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER_HANDLE firmwareUpdateProgressObserverHandle)
Tells the given firmware updater to update the given device with the given update information.
PEAK_C_API PEAK_EventController_WaitForEvent(PEAK_EVENT_CONTROLLER_HANDLE eventControllerHandle, uint64_t timeout_ms, PEAK_EVENT_HANDLE *eventHandle)
Tells the given event controller to wait for an event with the given timeout.
PEAK_C_API PEAK_Device_ToEventSupportingModule(PEAK_DEVICE_HANDLE deviceHandle, PEAK_EVENT_SUPPORTING_MODULE_HANDLE *eventSupportingModuleHandle)
Casts the given device to an event-supporting module.
PEAK_C_API PEAK_StringNode_SetValue(PEAK_STRING_NODE_HANDLE stringNodeHandle, const char *value, size_t valueSize)
Tells the given string node to set the given value.
PEAK_C_API PEAK_RemoteDevice_GetLocalDevice(PEAK_REMOTE_DEVICE_HANDLE remoteDeviceHandle, PEAK_DEVICE_HANDLE *deviceHandle)
Asks the given remote device for its local device.
int32_t PEAK_DEVICE_INFORMATION_ROLE
Definition peak_backend.h:161
PEAK_C_API PEAK_SystemDescriptor_GetVendorName(PEAK_SYSTEM_DESCRIPTOR_HANDLE systemDescriptorHandle, char *vendorName, size_t *vendorNameSize)
Asks the given system descriptor for its vendor name.
PEAK_C_API PEAK_RegisterNode_GetLength(PEAK_REGISTER_NODE_HANDLE registerNodeHandle, size_t *length)
Asks the given register node for its length.
PEAK_C_API PEAK_Node_GetIsCacheable(PEAK_NODE_HANDLE nodeHandle, PEAK_BOOL8 *isCacheable)
Asks the given node whether it is cacheable.
PEAK_C_API PEAK_DataStream_StopAcquisition(PEAK_DATA_STREAM_HANDLE dataStreamHandle, PEAK_ACQUISITION_STOP_MODE stopMode)
Tells the given data stream to stop the acquisition using the given mode.
PEAK_C_API PEAK_Buffer_GetDeliveredImageHeight(PEAK_BUFFER_HANDLE bufferHandle, size_t *deliveredImageHeight)
Asks the given buffer for its delivered image height.
PEAK_C_API PEAK_BufferChunk_GetSize(PEAK_BUFFER_CHUNK_HANDLE bufferChunkHandle, size_t *size)
Asks the given buffer chunk for its size.
void(PEAK_CALL_CONV * PEAK_FIRMWARE_UPDATE_STEP_FINISHED_CALLBACK)(PEAK_FIRMWARE_UPDATE_STEP updateStep, void *context)
Definition peak_backend.h:607
PEAK_C_API PEAK_Node_ToStringNode(PEAK_NODE_HANDLE nodeHandle, PEAK_STRING_NODE_HANDLE *stringNodeHandle)
Casts the given node to a string node.
PEAK_C_API PEAK_ProducerLibrary_Construct(const char *ctiPath, size_t ctiPathSize, PEAK_PRODUCER_LIBRARY_HANDLE *producerLibraryHandle)
Creates a producer library.
PEAK_C_API PEAK_SystemDescriptor_GetGenTLVersionMinor(PEAK_SYSTEM_DESCRIPTOR_HANDLE systemDescriptorHandle, uint32_t *gentlVersionMinor)
Asks the given system descriptor for the minor component of its GenTL version.
PEAK_C_API PEAK_Buffer_GetExpectedDataSize(PEAK_BUFFER_HANDLE bufferHandle, size_t *expectedDataSize)
Asks the given buffer for its expected data size.
PEAK_C_API PEAK_SystemDescriptor_GetDisplayName(PEAK_SYSTEM_DESCRIPTOR_HANDLE systemDescriptorHandle, char *displayName, size_t *displayNameSize)
Asks the given system descriptor for its display name.
PEAK_C_API PEAK_DeviceDescriptor_AddInformationRoleToMonitoring(PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle, PEAK_DEVICE_INFORMATION_ROLE informationRole)
Tells the given device descriptor to add the given information role to the monitoring.
PEAK_C_API PEAK_Module_GetPort(PEAK_MODULE_HANDLE moduleHandle, PEAK_PORT_HANDLE *portHandle)
Asks the given module for its port.
PEAK_C_API PEAK_Interface_RegisterDeviceListChangedCallback(PEAK_INTERFACE_HANDLE interfaceHandle, PEAK_DEVICE_LIST_CHANGED_CALLBACK callback, void *callbackContext, PEAK_DEVICE_LIST_CHANGED_CALLBACK_HANDLE *callbackHandle)
Registers a callback signaling a change in the device list at the given interface.
PEAK_C_API PEAK_EnumerationNode_TryFindEntryBySymbolicValue(PEAK_ENUMERATION_NODE_HANDLE enumerationNodeHandle, const char *symbolicValue, size_t symbolicValueSize, PEAK_ENUMERATION_ENTRY_NODE_HANDLE *enumerationEntryNodeHandle)
Tells the given enumeration node to try to find an entry with the given symbolic value.
PEAK_BUFFER_PAYLOAD_TYPE_t
Definition peak_backend.h:82
@ PEAK_BUFFER_PAYLOAD_TYPE_FILE
Definition peak_backend.h:86
@ PEAK_BUFFER_PAYLOAD_TYPE_CHUNK_ONLY
Definition peak_backend.h:91
@ PEAK_BUFFER_PAYLOAD_TYPE_DEVICE_SPECIFIC
Definition peak_backend.h:92
@ PEAK_BUFFER_PAYLOAD_TYPE_JPEG
Definition peak_backend.h:88
@ PEAK_BUFFER_PAYLOAD_TYPE_H264
Definition peak_backend.h:90
@ PEAK_BUFFER_PAYLOAD_TYPE_JPEG_2000
Definition peak_backend.h:89
@ PEAK_BUFFER_PAYLOAD_TYPE_UNKNOWN
Definition peak_backend.h:83
@ PEAK_BUFFER_PAYLOAD_TYPE_CUSTOM
Definition peak_backend.h:95
@ PEAK_BUFFER_PAYLOAD_TYPE_IMAGE
Definition peak_backend.h:84
@ PEAK_BUFFER_PAYLOAD_TYPE_RAW_DATA
Definition peak_backend.h:85
@ PEAK_BUFFER_PAYLOAD_TYPE_MULTI_PART
Definition peak_backend.h:93
@ PEAK_BUFFER_PAYLOAD_TYPE_CHUNK
Definition peak_backend.h:87
PEAK_C_API PEAK_InterfaceDescriptor_GetParentSystem(PEAK_INTERFACE_DESCRIPTOR_HANDLE interfaceDescriptorHandle, PEAK_SYSTEM_HANDLE *systemHandle)
Asks the given interface descriptor for its parent system.
PEAK_C_API PEAK_FirmwareUpdateInformation_GetReleaseNotesURL(PEAK_FIRMWARE_UPDATE_INFORMATION_HANDLE firmwareUpdateInformationHandle, char *releaseNotesUrl, size_t *releaseNotesUrlSize)
Asks the given firmware update information for its release notes URL.
PEAK_C_API PEAK_SystemDescriptor_GetParentLibrary(PEAK_SYSTEM_DESCRIPTOR_HANDLE systemDescriptorHandle, PEAK_PRODUCER_LIBRARY_HANDLE *producerLibraryHandle)
Asks the given system descriptor for its parent library.
PEAK_C_API PEAK_Buffer_GetIsQueued(PEAK_BUFFER_HANDLE bufferHandle, PEAK_BOOL8 *isQueued)
Asks the given buffer whether it is queued.
PEAK_C_API PEAK_Node_ToCommandNode(PEAK_NODE_HANDLE nodeHandle, PEAK_COMMAND_NODE_HANDLE *commandNodeHandle)
Casts the given node to a command node.
PEAK_C_API PEAK_System_RegisterInterfaceLostCallback(PEAK_SYSTEM_HANDLE systemHandle, PEAK_INTERFACE_LOST_CALLBACK callback, void *callbackContext, PEAK_INTERFACE_LOST_CALLBACK_HANDLE *callbackHandle)
Registers a callback signaling a lost interface at the given system.
int32_t PEAK_DEVICE_ACCESS_TYPE
Definition peak_backend.h:143
int32_t PEAK_NODE_NAMESPACE
Definition peak_backend.h:266
PEAK_C_API PEAK_Device_GetDataStream(PEAK_DEVICE_HANDLE deviceHandle, size_t index, PEAK_DATA_STREAM_DESCRIPTOR_HANDLE *dataStreamDescriptorHandle)
Asks the given device for the data stream descriptor with the given index.
PEAK_C_API PEAK_FloatNode_SetValue(PEAK_FLOAT_NODE_HANDLE floatNodeHandle, double value)
Tells the given float node to set the given value.
PEAK_C_API PEAK_DataStream_QueueBuffer(PEAK_DATA_STREAM_HANDLE dataStreamHandle, PEAK_BUFFER_HANDLE bufferHandle)
Tells the given data stream to queue the given buffer.
PEAK_C_API PEAK_DeviceDescriptor_GetSerialNumber(PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle, char *serialNumber, size_t *serialNumberSize)
Asks the given device descriptor for its serial number.
PEAK_C_API PEAK_Node_GetDisplayName(PEAK_NODE_HANDLE nodeHandle, char *displayName, size_t *displayNameSize)
Asks the given node for its display name.
PEAK_C_API PEAK_SystemDescriptor_GetGenTLVersionMajor(PEAK_SYSTEM_DESCRIPTOR_HANDLE systemDescriptorHandle, uint32_t *gentlVersionMajor)
Asks the given system descriptor for the major component of its GenTL version.
PEAK_C_API PEAK_DataStream_StartAcquisitionInfinite(PEAK_DATA_STREAM_HANDLE dataStreamHandle, PEAK_ACQUISITION_START_MODE startMode)
Tells the given data stream to start the acquisition using the given mode.
PEAK_C_API PEAK_CommandNode_WaitUntilDoneInfinite(PEAK_COMMAND_NODE_HANDLE commandNodeHandle)
Waits (blocking) without timeout until the previously executed command is finished,...
PEAK_C_API PEAK_Port_GetURL(PEAK_PORT_HANDLE portHandle, size_t index, PEAK_PORT_URL_HANDLE *portUrlHandle)
Asks the given port for the URL with the given index.
PEAK_C_API PEAK_Library_IsInitialized(PEAK_BOOL8 *isInitialized)
Checks if the IDS peak genericAPI library is initialized.
PEAK_C_API PEAK_Interface_Destruct(PEAK_INTERFACE_HANDLE interfaceHandle)
Destroys the given interface.
PEAK_C_API PEAK_BufferChunk_Destruct(PEAK_BUFFER_CHUNK_HANDLE bufferChunkHandle)
Destroys the given buffer chunk.
PEAK_C_API PEAK_FloatNode_GetMaximum(PEAK_FLOAT_NODE_HANDLE floatNodeHandle, double *maximum)
Asks the given float node for its maximum.
PEAK_C_API PEAK_Device_GetVersion(PEAK_DEVICE_HANDLE deviceHandle, char *version, size_t *versionSize)
Asks the given device for its version.
PEAK_RETURN_CODE_t
Definition peak_backend.h:331
@ PEAK_RETURN_CODE_ERROR
Definition peak_backend.h:333
@ PEAK_RETURN_CODE_INVALID_ARGUMENT
Definition peak_backend.h:340
@ PEAK_RETURN_CODE_SUCCESS
Definition peak_backend.h:332
@ PEAK_RETURN_CODE_BAD_ALLOC
Definition peak_backend.h:337
@ PEAK_RETURN_CODE_NOT_FOUND
Definition peak_backend.h:343
@ PEAK_RETURN_CODE_CTI_LOADING_ERROR
Definition peak_backend.h:348
@ PEAK_RETURN_CODE_BUFFER_TOO_SMALL
Definition peak_backend.h:338
@ PEAK_RETURN_CODE_NOT_INITIALIZED
Definition peak_backend.h:334
@ PEAK_RETURN_CODE_OUT_OF_RANGE
Definition peak_backend.h:344
@ PEAK_RETURN_CODE_ABORTED
Definition peak_backend.h:335
@ PEAK_RETURN_CODE_NOT_AVAILABLE
Definition peak_backend.h:346
@ PEAK_RETURN_CODE_INVALID_ADDRESS
Definition peak_backend.h:339
@ PEAK_RETURN_CODE_INVALID_CAST
Definition peak_backend.h:341
@ PEAK_RETURN_CODE_TIMEOUT
Definition peak_backend.h:345
@ PEAK_RETURN_CODE_IO
Definition peak_backend.h:349
@ PEAK_RETURN_CODE_NO_DATA
Definition peak_backend.h:350
@ PEAK_RETURN_CODE_INVALID_HANDLE
Definition peak_backend.h:342
@ PEAK_RETURN_CODE_NOT_IMPLEMENTED
Definition peak_backend.h:347
@ PEAK_RETURN_CODE_BAD_ACCESS
Definition peak_backend.h:336
PEAK_C_API PEAK_Buffer_GetYOffset(PEAK_BUFFER_HANDLE bufferHandle, size_t *yOffset)
Asks the given buffer for its Y offset.
PEAK_C_API PEAK_RegisterNode_Write(PEAK_REGISTER_NODE_HANDLE registerNodeHandle, const uint8_t *bytesToWrite, size_t bytesToWriteSize)
Tells the given register node to write the given bytes.
PEAK_C_API PEAK_Node_GetPollingTime(PEAK_NODE_HANDLE nodeHandle, int64_t *pollingTime_ms)
Asks the given node for its polling time.
PEAK_C_API PEAK_Event_GetRawData(PEAK_EVENT_HANDLE eventHandle, uint8_t *rawData, size_t *rawDataSize)
Asks the given event for its raw data.
PEAK_C_API PEAK_BufferPart_GetSourceID(PEAK_BUFFER_PART_HANDLE bufferPartHandle, uint64_t *sourceId)
Asks the given buffer part for its source ID.
PEAK_C_API PEAK_BufferPart_Destruct(PEAK_BUFFER_PART_HANDLE bufferPartHandle)
Destroys the given buffer part.
PEAK_C_API PEAK_Device_GetTLType(PEAK_DEVICE_HANDLE deviceHandle, char *tlType, size_t *tlTypeSize)
Asks the given device for its TL type.
PEAK_C_API PEAK_PortURL_GetInfo(PEAK_PORT_URL_HANDLE portUrlHandle, int32_t infoCommand, int32_t *infoDataType, uint8_t *info, size_t *infoSize)
Asks the given port URL for an information based on a specific command.
PEAK_C_API PEAK_Module_GetNumNodeMaps(PEAK_MODULE_HANDLE moduleHandle, size_t *numNodeMaps)
Asks the given module for its number of node maps.
PEAK_C_API PEAK_RemoteDevice_ToModule(PEAK_REMOTE_DEVICE_HANDLE remoteDeviceHandle, PEAK_MODULE_HANDLE *moduleHandle)
Casts the given remote device to a module.
PEAK_C_API PEAK_EnvironmentInspector_GetNumCTIPaths(size_t *numCtiPaths)
Asks for the number of CTI paths.
PEAK_C_API PEAK_Interface_UnregisterDeviceReconnectedCallback(PEAK_INTERFACE_HANDLE interfaceHandle, PEAK_DEVICE_RECONNECTED_CALLBACK_HANDLE callbackHandle)
Unregisters the device-reconnected callback with the given handle from the given interface.
PEAK_C_API PEAK_Node_GetInvalidatedNode(PEAK_NODE_HANDLE nodeHandle, size_t index, PEAK_NODE_HANDLE *invalidatedNodeHandle)
Asks the given node for the invalidated node with the given index.
PEAK_C_API PEAK_NodeMap_Unlock(PEAK_NODE_MAP_HANDLE nodeMapHandle)
Unlocks the recursive mutex on the NodeMap.
struct PEAK_FILE_ADAPTER * PEAK_FILE_ADAPTER_HANDLE
Definition peak_backend.h:487
PEAK_C_API PEAK_Interface_GetDisplayName(PEAK_INTERFACE_HANDLE interfaceHandle, char *displayName, size_t *displayNameSize)
Asks the given interface for its display name.
void(PEAK_CALL_CONV * PEAK_FIRMWARE_UPDATE_STARTED_CALLBACK)(PEAK_FIRMWARE_UPDATE_INFORMATION_HANDLE firmwareUpdateInformationHandle, uint32_t estimatedDuration_ms, void *context)
Definition peak_backend.h:590
PEAK_C_API PEAK_FileAdapter_Write(PEAK_FILE_ADAPTER_HANDLE fileAdapterHandle, const uint8_t *data, uint64_t size, uint64_t offset)
Writes to the given file.
PEAK_C_API PEAK_DataStream_GetNumBuffersAwaitDelivery(PEAK_DATA_STREAM_HANDLE dataStreamHandle, size_t *numBuffersAwaitDelivery)
Asks the given data stream for its number of buffers awaiting delivery.
PEAK_C_API PEAK_DataStream_AllocAndAnnounceBuffer(PEAK_DATA_STREAM_HANDLE dataStreamHandle, size_t bufferSize, void *userPtr, PEAK_BUFFER_HANDLE *bufferHandle)
Tells the given data stream to allocate and announce a buffer with the given size.
PEAK_C_API PEAK_EventController_GetNumEventsInQueue(PEAK_EVENT_CONTROLLER_HANDLE eventControllerHandle, size_t *numEventsInQueue)
Asks the event controller for its number of events in queue.
PEAK_C_API PEAK_IntegerNode_GetUnit(PEAK_INTEGER_NODE_HANDLE integerNodeHandle, char *unit, size_t *unitSize)
Asks the given integer node for its unit.
PEAK_C_API PEAK_DeviceDescriptor_GetModelName(PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle, char *modelName, size_t *modelNameSize)
Asks the given device descriptor for its model name.
struct PEAK_DEVICE_DESCRIPTOR * PEAK_DEVICE_DESCRIPTOR_HANDLE
Definition peak_backend.h:383
PEAK_C_API PEAK_Library_Initialize()
Initializes the IDS peak genericAPI library.
PEAK_C_API PEAK_DeviceDescriptor_RegisterInformationChangedCallback(PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle, PEAK_DEVICE_DESCRIPTOR_INFORMATION_CHANGED_CALLBACK callback, void *callbackContext, PEAK_DEVICE_DESCRIPTOR_INFORMATION_CHANGED_CALLBACK_HANDLE *callbackHandle)
Registers a callback signaling changed information at the given device descriptor.
PEAK_C_API PEAK_DeviceDescriptor_GetIsOpenable(PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle, PEAK_DEVICE_ACCESS_TYPE accessType, PEAK_BOOL8 *isOpenable)
Asks the given device descriptor whether the device can be opened with this specific access type.
PEAK_C_API PEAK_Buffer_GetTLType(PEAK_BUFFER_HANDLE bufferHandle, char *tlType, size_t *tlTypeSize)
Asks the given buffer for its TL type.
PEAK_C_API PEAK_FileAdapter_Construct(PEAK_NODE_MAP_HANDLE nodeMapHandle, const char *fileName, PEAK_FILE_ADAPTER_HANDLE *fileAdapterHandle)
Creates a file adapter.
PEAK_C_API PEAK_RegisterNode_Read(PEAK_REGISTER_NODE_HANDLE registerNodeHandle, PEAK_NODE_CACHE_USE_POLICY cacheUsePolicy, uint8_t *bytesToRead, size_t bytesToReadSize)
Tells the given register node to read the given amount of bytes.
int32_t PEAK_CHARACTER_ENCODING
Definition peak_backend.h:105
PEAK_C_API PEAK_Library_GetVersionMajor(uint32_t *libraryVersionMajor)
Asks for the major component of the library version.
PEAK_C_API PEAK_FirmwareUpdateProgressObserver_RegisterUpdateStepProgressChangedCallback(PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER_HANDLE firmwareUpdateProgressObserverHandle, PEAK_FIRMWARE_UPDATE_STEP_PROGRESS_CHANGED_CALLBACK callback, void *callbackContext, PEAK_FIRMWARE_UPDATE_STEP_PROGRESS_CHANGED_CALLBACK_HANDLE *callbackHandle)
Registers a callback signaling a progress change within an update step at the given firmware update p...
PEAK_C_API PEAK_ProducerLibrary_Destruct(PEAK_PRODUCER_LIBRARY_HANDLE producerLibraryHandle)
Destroys the given producer library.
PEAK_C_API PEAK_FirmwareUpdateProgressObserver_UnregisterUpdateStepStartedCallback(PEAK_FIRMWARE_UPDATE_PROGRESS_OBSERVER_HANDLE firmwareUpdateProgressObserverHandle, PEAK_FIRMWARE_UPDATE_STEP_STARTED_CALLBACK_HANDLE callbackHandle)
Unregisters the update step started callback with the given handle from the given firmware update pro...
PEAK_C_API PEAK_EnumerationNode_SetCurrentEntryBySymbolicValue(PEAK_ENUMERATION_NODE_HANDLE enumerationNodeHandle, const char *symbolicValue, size_t symbolicValueSize)
Tells the given enumeration node to set its current entry by the given symbolic value.
PEAK_C_API PEAK_EventController_GetNumEventsFired(PEAK_EVENT_CONTROLLER_HANDLE eventControllerHandle, uint64_t *numEventsFired)
Asks the event controller for its number of fired events.
PEAK_C_API PEAK_NodeMap_InvalidateNodes(PEAK_NODE_MAP_HANDLE nodeMapHandle)
Tells the given node map to invalidate its nodes.
PEAK_C_API PEAK_SystemDescriptor_GetCTIFileName(PEAK_SYSTEM_DESCRIPTOR_HANDLE systemDescriptorHandle, char *ctiFileName, size_t *ctiFileNameSize)
Asks the given system descriptor for its parent CTI's file name.
PEAK_C_API PEAK_FirmwareUpdater_CollectAllFirmwareUpdateInformation(PEAK_FIRMWARE_UPDATER_HANDLE firmwareUpdaterHandle, const char *gufPath, size_t gufPathSize)
Tells the given firmware updater to collect all update information from the .guf file.
int32_t PEAK_BUFFER_PAYLOAD_TYPE
Definition peak_backend.h:97
PEAK_C_API PEAK_FloatNode_GetValue(PEAK_FLOAT_NODE_HANDLE floatNodeHandle, PEAK_NODE_CACHE_USE_POLICY cacheUsePolicy, double *value)
Asks the given float node for its value.
PEAK_C_API PEAK_System_RegisterInterfaceFoundCallback(PEAK_SYSTEM_HANDLE systemHandle, PEAK_INTERFACE_FOUND_CALLBACK callback, void *callbackContext, PEAK_INTERFACE_FOUND_CALLBACK_HANDLE *callbackHandle)
Registers a callback signaling a found interface at the given system.
PEAK_C_API PEAK_FileAdapter_Destruct(PEAK_FILE_ADAPTER_HANDLE fileAdapterHandle)
Destroys the given file adapter.
PEAK_C_API PEAK_Interface_GetNumDevices(PEAK_INTERFACE_HANDLE interfaceHandle, size_t *numDevices)
Asks the given interface for its number of devices.
void(PEAK_CALL_CONV * PEAK_INTERFACE_FOUND_CALLBACK)(PEAK_INTERFACE_DESCRIPTOR_HANDLE foundInterface, void *context)
Definition peak_backend.h:503
PEAK_BUFFER_PART_TYPE_t
Definition peak_backend.h:64
@ PEAK_BUFFER_PART_TYPE_CUSTOM
Definition peak_backend.h:76
@ PEAK_BUFFER_PART_TYPE_CONFIDENCE_MAP
Definition peak_backend.h:74
@ PEAK_BUFFER_PART_TYPE_UNKNOWN
Definition peak_backend.h:65
@ PEAK_BUFFER_PART_TYPE_PLANE_QUAD_PLANAR_3D
Definition peak_backend.h:73
@ PEAK_BUFFER_PART_TYPE_IMAGE_3D
Definition peak_backend.h:70
@ PEAK_BUFFER_PART_TYPE_PLANE_TRI_PLANAR_2D
Definition peak_backend.h:68
@ PEAK_BUFFER_PART_TYPE_PLANE_QUAD_PLANAR_2D
Definition peak_backend.h:69
@ PEAK_BUFFER_PART_TYPE_PLANE_BI_PLANAR_2D
Definition peak_backend.h:67
@ PEAK_BUFFER_PART_TYPE_PLANE_BI_PLANAR_3D
Definition peak_backend.h:71
@ PEAK_BUFFER_PART_TYPE_PLANE_TRI_PLANAR_3D
Definition peak_backend.h:72
@ PEAK_BUFFER_PART_TYPE_IMAGE_2D
Definition peak_backend.h:66
PEAK_C_API PEAK_Library_GetVersionSubminor(uint32_t *libraryVersionSubminor)
PEAK_C_API PEAK_BufferPart_GetType(PEAK_BUFFER_PART_HANDLE bufferPartHandle, PEAK_BUFFER_PART_TYPE *type)
Asks the given buffer part for its type.
PEAK_C_API PEAK_Node_GetIsAccessStatusCacheable(PEAK_NODE_HANDLE nodeHandle, PEAK_BOOL8 *isAccessStatusCacheable)
Asks the given node whether its access status is cacheable.
void(PEAK_CALL_CONV * PEAK_FIRMWARE_UPDATE_FAILED_CALLBACK)(const char *errorDescription, size_t errorDescriptionSize, void *context)
Definition peak_backend.h:616
int32_t PEAK_NODE_VISIBILITY
Definition peak_backend.h:304
PEAK_C_API PEAK_DataStream_GetTLType(PEAK_DATA_STREAM_HANDLE dataStreamHandle, char *tlType, size_t *tlTypeSize)
Asks the given data stream for its TL type.
PEAK_C_API PEAK_Node_UnregisterChangedCallback(PEAK_NODE_HANDLE nodeHandle, PEAK_NODE_CHANGED_CALLBACK_HANDLE callbackHandle)
Unregisters the changed callback with the given handle from the given node.
PEAK_C_API PEAK_DataStreamDescriptor_OpenDataStream(PEAK_DATA_STREAM_DESCRIPTOR_HANDLE dataStreamDescriptorHandle, PEAK_DATA_STREAM_HANDLE *dataStreamHandle)
Opens the data stream being associated with the given data stream descriptor.
void(PEAK_CALL_CONV * PEAK_DEVICE_LOST_CALLBACK)(const char *lostDeviceId, size_t lostDeviceIdSize, void *context)
Definition peak_backend.h:556
PEAK_C_API PEAK_Interface_GetKey(PEAK_INTERFACE_HANDLE interfaceHandle, char *key, size_t *keySize)
Asks the given interface for its key.
PEAK_C_API PEAK_Port_GetModuleName(PEAK_PORT_HANDLE portHandle, char *moduleName, size_t *moduleNameSize)
Asks the given port for its module name.
void(PEAK_CALL_CONV * PEAK_INTERFACE_LIST_CHANGED_CALLBACK)(void *context)
Definition peak_backend.h:509
PEAK_C_API PEAK_Buffer_GetIsAcquiring(PEAK_BUFFER_HANDLE bufferHandle, PEAK_BOOL8 *isAcquiring)
Asks the given buffer whether it is acquiring.
struct PEAK_BOOLEAN_NODE * PEAK_BOOLEAN_NODE_HANDLE
Definition peak_backend.h:435
struct PEAK_INTEGER_NODE * PEAK_INTEGER_NODE_HANDLE
Definition peak_backend.h:431
PEAK_C_API PEAK_NodeMap_LoadFromFile(PEAK_NODE_MAP_HANDLE nodeMapHandle, const char *filePath, size_t filePathSize)
Tells the given node map to load the values of its streamable nodes from a file at the given file pat...
int32_t PEAK_NODE_DISPLAY_NOTATION
Definition peak_backend.h:249
PEAK_C_API PEAK_Buffer_GetPixelFormat(PEAK_BUFFER_HANDLE bufferHandle, uint64_t *pixelFormat)
Asks the given buffer for its pixel format.
PEAK_C_API PEAK_SystemDescriptor_GetVersion(PEAK_SYSTEM_DESCRIPTOR_HANDLE systemDescriptorHandle, char *version, size_t *versionSize)
Asks the given system descriptor for its version.
PEAK_C_API PEAK_InterfaceDescriptor_GetTLType(PEAK_INTERFACE_DESCRIPTOR_HANDLE interfaceDescriptorHandle, char *tlType, size_t *tlTypeSize)
Asks the given interface descriptor for its TL type.
PEAK_C_API PEAK_Buffer_GetHasImage(PEAK_BUFFER_HANDLE bufferHandle, PEAK_BOOL8 *hasImage)
Asks the given buffer whether it is has an image.
PEAK_C_API PEAK_DeviceDescriptor_ToModuleDescriptor(PEAK_DEVICE_DESCRIPTOR_HANDLE deviceDescriptorHandle, PEAK_MODULE_DESCRIPTOR_HANDLE *moduleDescriptorHandle)
Casts the given device descriptor to a module descriptor.
PEAK_C_API PEAK_DataStream_GetInfo(PEAK_DATA_STREAM_HANDLE dataStreamHandle, int32_t infoCommand, int32_t *infoDataType, uint8_t *info, size_t *infoSize)
Asks the given data stream for an information based on a specific command.
PEAK_FIRMWARE_UPDATE_STEP_FINISHED_CALLBACK * PEAK_FIRMWARE_UPDATE_STEP_FINISHED_CALLBACK_HANDLE
Definition peak_backend.h:610
PEAK_C_API PEAK_System_GetNumInterfaces(PEAK_SYSTEM_HANDLE systemHandle, size_t *numInterfaces)
Asks the given system for its number of interfaces.
PEAK_C_API PEAK_Buffer_GetXPadding(PEAK_BUFFER_HANDLE bufferHandle, size_t *xPadding)
Asks the given buffer for its X padding.
PEAK_C_API PEAK_EnumerationEntryNode_GetIsSelfClearing(PEAK_ENUMERATION_ENTRY_NODE_HANDLE enumerationEntryNodeHandle, PEAK_BOOL8 *isSelfClearing)
Asks the given enumeration entry node whether it is self clearing.
PEAK_C_API PEAK_EventController_GetControlledEventType(PEAK_EVENT_CONTROLLER_HANDLE eventControllerHandle, PEAK_EVENT_TYPE *controlledEventType)
Asks the event controller for its controlled event type.
PEAK_C_API PEAK_Buffer_GetNumParts(PEAK_BUFFER_HANDLE bufferHandle, size_t *numParts)
Asks the given buffer for its number of parts.
PEAK_C_API PEAK_StringNode_GetMaximumLength(PEAK_STRING_NODE_HANDLE stringNodeHandle, int64_t *maximumLength)
Asks the given string node for its maximum length.
PEAK_C_API PEAK_Library_GetLastError(PEAK_RETURN_CODE *lastErrorCode, char *lastErrorDescription, size_t *lastErrorDescriptionSize)
Queries the last error.
void(PEAK_CALL_CONV * PEAK_FIRMWARE_UPDATE_STEP_STARTED_CALLBACK)(PEAK_FIRMWARE_UPDATE_STEP updateStep, uint32_t estimatedDuration_ms, const char *description, size_t descriptionSize, void *context)
Definition peak_backend.h:596
struct PEAK_DEVICE * PEAK_DEVICE_HANDLE
Definition peak_backend.h:387
PEAK_C_API PEAK_PortURL_GetFileSHA1Hash(PEAK_PORT_URL_HANDLE portUrlHandle, uint8_t *fileSha1Hash, size_t *fileSha1HashSize)
Asks the given port URL for its file SHA1 hash.
PEAK_FIRMWARE_UPDATE_PERSISTENCE_t
Definition peak_backend.h:187
@ PEAK_FIRMWARE_UPDATE_PERSISTENCE_FULL
Definition peak_backend.h:189
@ PEAK_FIRMWARE_UPDATE_PERSISTENCE_NONE
Definition peak_backend.h:188
PEAK_C_API PEAK_Interface_GetID(PEAK_INTERFACE_HANDLE interfaceHandle, char *id, size_t *idSize)
Asks the given interface for its ID.
PEAK_FIRMWARE_UPDATE_STEP_t
Definition peak_backend.h:195
@ PEAK_FIRMWARE_UPDATE_STEP_ACQUIRE_UPDATE_DATA
Definition peak_backend.h:197
@ PEAK_FIRMWARE_UPDATE_STEP_ASSERT_FEATURE
Definition peak_backend.h:200
@ PEAK_FIRMWARE_UPDATE_STEP_WRITE_FEATURE
Definition peak_backend.h:198
@ PEAK_FIRMWARE_UPDATE_STEP_CHECK_PRECONDITIONS
Definition peak_backend.h:196
@ PEAK_FIRMWARE_UPDATE_STEP_RESET_DEVICE
Definition peak_backend.h:202
@ PEAK_FIRMWARE_UPDATE_STEP_UPLOAD_FILE
Definition peak_backend.h:201
@ PEAK_FIRMWARE_UPDATE_STEP_EXECUTE_FEATURE
Definition peak_backend.h:199
PEAK_C_API PEAK_NodeMap_TryFindNode(PEAK_NODE_MAP_HANDLE nodeMapHandle, const char *nodeName, size_t nodeNameSize, PEAK_NODE_HANDLE *nodeHandle)
Tells the given node map to try to find a node with the given name.
PEAK_C_API PEAK_Interface_UpdateDevices(PEAK_INTERFACE_HANDLE interfaceHandle, uint64_t timeout_ms)
Tells the given interface to update its devices with the given timeout.
PEAK_C_API PEAK_DataStream_ToEventSupportingModule(PEAK_DATA_STREAM_HANDLE dataStreamHandle, PEAK_EVENT_SUPPORTING_MODULE_HANDLE *eventSupportingModuleHandle)
Casts the given data stream to an event-supporting module.
PEAK_INTERFACE_FOUND_CALLBACK * PEAK_INTERFACE_FOUND_CALLBACK_HANDLE
Definition peak_backend.h:511
PEAK_C_API PEAK_System_UnregisterInterfaceFoundCallback(PEAK_SYSTEM_HANDLE systemHandle, PEAK_INTERFACE_FOUND_CALLBACK_HANDLE callbackHandle)
Unregisters the interface-found callback with the given handle from the given system.
int32_t PEAK_DEVICE_ACCESS_STATUS
Definition peak_backend.h:132
PEAK_C_API PEAK_DataStream_StartAcquisition(PEAK_DATA_STREAM_HANDLE dataStreamHandle, PEAK_ACQUISITION_START_MODE startMode, uint64_t numToAcquire)
Tells the given data stream to start the acquisition using the given mode and to acquire the given nu...
PEAK_C_API PEAK_FloatNode_GetRepresentation(PEAK_FLOAT_NODE_HANDLE floatNodeHandle, PEAK_NODE_REPRESENTATION *representation)
Asks the given float node for its representation.
PEAK_C_API PEAK_FirmwareUpdateInformation_GetReleaseNotes(PEAK_FIRMWARE_UPDATE_INFORMATION_HANDLE firmwareUpdateInformationHandle, char *releaseNotes, size_t *releaseNotesSize)
Asks the given firmware update information for its release notes.
PEAK_C_API PEAK_SystemDescriptor_ToModuleDescriptor(PEAK_SYSTEM_DESCRIPTOR_HANDLE systemDescriptorHandle, PEAK_MODULE_DESCRIPTOR_HANDLE *moduleDescriptorHandle)
Casts the given system descriptor to a module descriptor.
PEAK_C_API PEAK_System_ToModule(PEAK_SYSTEM_HANDLE systemHandle, PEAK_MODULE_HANDLE *moduleHandle)
Casts the given system to a module.
PEAK_C_API PEAK_Buffer_GetChunkLayoutID(PEAK_BUFFER_HANDLE bufferHandle, uint64_t *chunkLayoutId)
Asks the given buffer for its chunk layout ID.
PEAK_C_API PEAK_Device_GetID(PEAK_DEVICE_HANDLE deviceHandle, char *id, size_t *idSize)
Asks the given device for its ID.
PEAK_C_API PEAK_EventController_KillWait(PEAK_EVENT_CONTROLLER_HANDLE eventControllerHandle)
Cancels a pending PEAK_EventController_WaitForEvent call.
PEAK_C_API PEAK_EventController_Destruct(PEAK_EVENT_CONTROLLER_HANDLE eventControllerHandle)
Destroys the given event controller.
#define PEAK_COMMON_DEPRECATED_MSG(MESSAGE)
Definition peak_common_defines.h:52
Definition peak_backend.h:534
PEAK_BOOL8 IsRemoteDeviceAcquisitionRunning
Definition peak_backend.h:536
PEAK_BOOL8 Reserved[6]
Definition peak_backend.h:540
uint8_t Reserved2[20]
Definition peak_backend.h:546
PEAK_BOOL8 IsRemoteDeviceConfigurationRestored
Definition peak_backend.h:538
PEAK_DEVICE_RECONNECT_ERROR_FLAGS ErrorFlags
Definition peak_backend.h:543