API samples
Last modified by Lev Andronov on 2025/05/27 13:56
Vision Point II
Vision Point II API samples locations
Windows
C:\Users\Public\Documents\KAYA Instruments\Vision Point II\API Samples
Linux
/opt/KAYA_Instruments/VisionPointII/Examples
If you would like to use Vision Point legacy API samples with the Vision Point II API, link 'KYFGLibA' instead of 'KYFGLib'. More information is available in the knowledge base article Migration to VP II.
The new Vision Point II API is not monolithic — it has a modular structure consisting of:
- KYVPLibTL, our new GenTL-inspired transport layer (API sample "KYVP_LibTL_Example"). Refer to the "KYVPTL library" section of the Vision Point II API Data Book.
- KYVP ParametersHandler, which is a high-level library for handling GeniCam commands (API sample "KYVP_ParametersHandle_Example"). ParametersHandler is described in the same document under the section "KYVP ParametersHandler library".
The comprehensive API sample 'KYVP_QueuedBuffers_Example' demonstrates the usage of both transport layer and and device parameters.
| Directory name | Description |
|---|---|
| KYFGLib_Adapter_Example | Plain C sample demonstrating usage of Vision Point legacy code to use under Vision Point II API |
| KYVP_FirmwareUpdate_Example | Plain C sample for KAYA Instruments PCIe devices firmware update procedure |
| KYVP_ParametersHandle_Example | Plain C sample shows how to handle cameras parameters using KYVP ParametersHandler library |
| KYVP_QueuedBuffers_Example | Plain C sample for Queued Buffers image acquisition using KYVPLibTL and KYVP ParametersHandler library |
| KYVPLibTL_Example | Plain C basic sample demonstrating Vision Point transport layer |
Vision Point
Vision Point II API samples locations
Windows
C:\Users\Public\Documents\KAYA Instruments\Vision Point\API Samples
Linux
/opt/KAYA_Instruments/Examples
| Directory name | Sample name | Description |
|---|---|---|
| Vision Point .NET API | KYFGLib.NET | .NET wrapper for the KAYA API library |
| Vision Point .NET API | KYFGLib.NET_Example | .NET image acquisition: open grabber, scan camera, camera parameters management, start stream; cyclic buffer type |
| Vision Point .NET API | KYFGLib.NET_Example_QueuedBuffers | .NET image acquisition: open grabber, scan camera, camera parameters management, start stream; queued buffer type |
| Vision Point API | GenICam_fw_update | Plain C sample of GenICam firmware update for the Iron CoaXPress cameras |
| Vision Point API | GenTL_Example | Plain C sample of GenTL producer usage: open grabber, scan camera, camera parameters management, start stream; queued buffer type |
| Vision Point API | Image_Stitching | C++ image stitching: composing an image from chunks assigned to multiple cameras (configured to run in freerun mode with the same frame rate) |
| Vision Point API | KAYA_SystemStartup | Plain C sample for the system startup and perform various initializations of KAYA Instrument devices |
| Vision Point API | KY_Chameleon_Example | Plain C sample forChameleon operation flow: open grabber, scan camera, camera parameters management, start stream; queued buffer type |
| Vision Point API | KYFGLib_Example | Plain C sample for image acquisition: open grabber, scan camera, camera parameters management, start stream; cyclic buffer type |
| Vision Point API | KYFGLib_Example_QueuedBuffers | Plain C sample for image acquisition: open grabber, scan camera, camera parameters management, start stream; queued buffer type |
| Vision Point Python API | KYFGLib_API_Sample | Python image acquisition: open grabber, scan camera, camera parameters management, start stream; cyclic buffer type |
| Vision Point Python API | KYFGLib_API_Sample_mutiple_cameras | Python image acquisition: open grabber, scan camera, camera parameters management, start stream; cyclic buffer type for 2 cameras and more |
| Vision Point Python API | KYFGLib_Chameleon_Example | Python Chameleon operation flow: open grabber, scan camera, camera parameters management, start stream; queued buffer type |
| Vision Point Python API | KYFGLib_Example_QueuedBuffers | Python image acquisition: open grabber, scan camera, camera parameters management, start stream; queued buffer type for 1 camera |
| Vision Point Python API | KYFGLib_Example_QueuedBuffers_mutiple_cameras | Python image acquisition: open grabber, scan camera, camera parameters management, start stream; queued buffer type for 2 cameras and more |
More API samples and test cases can be found in our GitHub repository.